Skip to content

Commit 0ab2a3a

Browse files
[DOCS] Clarify the frequency of config polling (#3799)
--------- Co-authored-by: Jonas Kunz <jonas.kunz@elastic.co>
1 parent 370f5f0 commit 0ab2a3a

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

apm-agent-core/src/main/java/co/elastic/apm/agent/configuration/CoreConfigurationImpl.java

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,13 @@
2525
import co.elastic.apm.agent.matcher.MethodMatcherValueConverter;
2626
import co.elastic.apm.agent.sdk.logging.Logger;
2727
import co.elastic.apm.agent.sdk.logging.LoggerFactory;
28-
import co.elastic.apm.agent.tracer.configuration.*;
28+
import co.elastic.apm.agent.tracer.configuration.CoreConfiguration;
29+
import co.elastic.apm.agent.tracer.configuration.ListValueConverter;
30+
import co.elastic.apm.agent.tracer.configuration.RegexValidator;
31+
import co.elastic.apm.agent.tracer.configuration.RoundedDoubleConverter;
32+
import co.elastic.apm.agent.tracer.configuration.TimeDuration;
33+
import co.elastic.apm.agent.tracer.configuration.TimeDurationValueConverter;
34+
import co.elastic.apm.agent.tracer.configuration.WildcardMatcherValueConverter;
2935
import org.stagemonitor.configuration.ConfigurationOption;
3036
import org.stagemonitor.configuration.ConfigurationOptionProvider;
3137
import org.stagemonitor.configuration.converter.AbstractValueConverter;
@@ -696,7 +702,8 @@ public String toSafeString(List<WildcardMatcher> value) {
696702
.key("central_config")
697703
.tags("added[1.8.0]")
698704
.configurationCategory(CORE_CATEGORY)
699-
.description("When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration.")
705+
.description("When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration.\n"
706+
+ "The frequency of the periodic request is driven by the `Cache-Control` header returned from APM Server/Integration, falling back to 5 minutes if not defined.")
700707
.dynamic(true)
701708
.buildWithDefault(true);
702709

docs/configuration.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1270,6 +1270,7 @@ Example: `0ms`.
12701270
==== `central_config` (added[1.8.0])
12711271

12721272
When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration.
1273+
The frequency of the periodic request is driven by the `Cache-Control` header returned from APM Server/Integration, falling back to 5 minutes if not defined.
12731274

12741275
<<configuration-dynamic, image:./images/dynamic-config.svg[] >>
12751276

@@ -4061,6 +4062,7 @@ Example: `5ms`.
40614062
# trace_methods_duration_threshold=0ms
40624063
40634064
# When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration.
4065+
# The frequency of the periodic request is driven by the `Cache-Control` header returned from APM Server/Integration, falling back to 5 minutes if not defined.
40644066
#
40654067
# This setting can be changed at runtime
40664068
# Type: Boolean

0 commit comments

Comments
 (0)