Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Clarify the frequency of config polling #3799

Merged
merged 3 commits into from
Sep 17, 2024
Merged

[DOCS] Clarify the frequency of config polling #3799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8862941
Clarify the frequency of config changes
lucabelluccini Sep 13, 2024
430072a
Update docs/configuration.asciidoc
lucabelluccini Sep 16, 2024
e077fcc
Add docu paragraph to java sources
JonasKunz Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions apm-agent-core/src/main/java/co/elastic/apm/agent/configuration/CoreConfigurationImpl.java
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1270,6 +1270,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 @@ -4061,6 +4062,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
Loading