Skip to content

Commit

Permalink
[DOCS] Clarify the frequency of config polling (#3799) (#3881)
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Luca Belluccini <[email protected]>
  • Loading branch information
JonasKunz and lucabelluccini authored Nov 21, 2024
1 parent 5a3e1a4 commit 79ac226
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,13 @@
import co.elastic.apm.agent.matcher.MethodMatcherValueConverter;
import co.elastic.apm.agent.sdk.logging.Logger;
import co.elastic.apm.agent.sdk.logging.LoggerFactory;
import co.elastic.apm.agent.tracer.configuration.*;
import co.elastic.apm.agent.tracer.configuration.CoreConfiguration;
import co.elastic.apm.agent.tracer.configuration.ListValueConverter;
import co.elastic.apm.agent.tracer.configuration.RegexValidator;
import co.elastic.apm.agent.tracer.configuration.RoundedDoubleConverter;
import co.elastic.apm.agent.tracer.configuration.TimeDuration;
import co.elastic.apm.agent.tracer.configuration.TimeDurationValueConverter;
import co.elastic.apm.agent.tracer.configuration.WildcardMatcherValueConverter;
import org.stagemonitor.configuration.ConfigurationOption;
import org.stagemonitor.configuration.ConfigurationOptionProvider;
import org.stagemonitor.configuration.converter.AbstractValueConverter;
Expand Down Expand Up @@ -696,7 +702,8 @@ public String toSafeString(List<WildcardMatcher> value) {
.key("central_config")
.tags("added[1.8.0]")
.configurationCategory(CORE_CATEGORY)
.description("When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration.")
.description("When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration.\n"
+ "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.")
.dynamic(true)
.buildWithDefault(true);

Expand Down
2 changes: 2 additions & 0 deletions docs/configuration.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -1271,6 +1271,7 @@ Example: `0ms`.
==== `central_config` (added[1.8.0])

When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration.
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.

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

Expand Down Expand Up @@ -4087,6 +4088,7 @@ Example: `5ms`.
# trace_methods_duration_threshold=0ms
# When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration.
# 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.
#
# This setting can be changed at runtime
# Type: Boolean
Expand Down

0 comments on commit 79ac226

Please sign in to comment.