Skip to content

Fix enabling / disabling of APM agent "recording" in APMAgentSettings #104324

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

Merged
mosche merged 5 commits into from
Jan 30, 2024
Merged

Fix enabling / disabling of APM agent "recording" in APMAgentSettings #104324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ecbde41
More robust key extraction in APMAgentSettings for allow-list validation
mosche Jan 12, 2024
ab27b81
Fix APM agent 'recording' in APMAgentSettings
mosche Jan 12, 2024
2cb305b
Merge branch 'main' into apm_settings_key_extraction
mosche Jan 30, 2024
33094d4
test setting update consumers
mosche Jan 30, 2024
d6b9541
Merge branch 'main' into apm_settings_key_extraction / remove randomness
mosche Jan 30, 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
3 changes: 1 addition & 2 deletions modules/apm/src/main/java/org/elasticsearch/telemetry/apm/APM.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,7 @@ public Collection<?> createComponents(PluginServices services) {
apmTracer.setNodeName(services.clusterService().getNodeName());

final APMAgentSettings apmAgentSettings = new APMAgentSettings();
apmAgentSettings.syncAgentSystemProperties(settings);

apmAgentSettings.initAgentSystemProperties(settings);
apmAgentSettings.addClusterSettingsListeners(services.clusterService(), telemetryProvider.get());
logger.info("Sending apm metrics is {}", APMAgentSettings.TELEMETRY_METRICS_ENABLED_SETTING.get(settings) ? "enabled" : "disabled");
logger.info("Sending apm tracing is {}", APMAgentSettings.TELEMETRY_TRACING_ENABLED_SETTING.get(settings) ? "enabled" : "disabled");
Expand Down
18 changes: 14 additions & 4 deletions modules/apm/src/main/java/org/elasticsearch/telemetry/apm/internal/APMAgentSettings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,12 +45,17 @@ public void addClusterSettingsListeners(ClusterService clusterService, APMTeleme
clusterSettings.addSettingsUpdateConsumer(TELEMETRY_TRACING_ENABLED_SETTING, enabled -> {
apmTracer.setEnabled(enabled);
this.setAgentSetting("instrument", Boolean.toString(enabled));
// The agent records data other than spans, e.g. JVM metrics, so we toggle this setting in order to
// minimise its impact to a running Elasticsearch.
boolean recording = enabled || clusterSettings.get(TELEMETRY_METRICS_ENABLED_SETTING);
this.setAgentSetting("recording", Boolean.toString(recording));
});
clusterSettings.addSettingsUpdateConsumer(TELEMETRY_METRICS_ENABLED_SETTING, enabled -> {
apmMeterService.setEnabled(enabled);
// The agent records data other than spans, e.g. JVM metrics, so we toggle this setting in order to
// minimise its impact to a running Elasticsearch.
this.setAgentSetting("recording", Boolean.toString(enabled));
boolean recording = enabled || clusterSettings.get(TELEMETRY_TRACING_ENABLED_SETTING);
this.setAgentSetting("recording", Boolean.toString(recording));
});
clusterSettings.addSettingsUpdateConsumer(TELEMETRY_TRACING_NAMES_INCLUDE_SETTING, apmTracer::setIncludeNames);
clusterSettings.addSettingsUpdateConsumer(TELEMETRY_TRACING_NAMES_EXCLUDE_SETTING, apmTracer::setExcludeNames);
Expand All @@ -59,11 +64,16 @@ public void addClusterSettingsListeners(ClusterService clusterService, APMTeleme
}

/**
* Copies APM settings from the provided settings object into the corresponding system properties.
* Initialize APM settings from the provided settings object into the corresponding system properties.
* Later updates to these settings are synchronized using update consumers.
* @param settings the settings to apply
*/
public void syncAgentSystemProperties(Settings settings) {
this.setAgentSetting("recording", Boolean.toString(TELEMETRY_TRACING_ENABLED_SETTING.get(settings)));
public void initAgentSystemProperties(Settings settings) {
boolean tracing = TELEMETRY_TRACING_ENABLED_SETTING.get(settings);
boolean metrics = TELEMETRY_METRICS_ENABLED_SETTING.get(settings);

this.setAgentSetting("recording", Boolean.toString(tracing || metrics));
this.setAgentSetting("instrument", Boolean.toString(tracing));
// Apply values from the settings in the cluster state
APM_AGENT_SETTINGS.getAsMap(settings).forEach(this::setAgentSetting);
}
Expand Down
Loading