Skip to content

[OTAGENT-428] Converter: granular management of auto-enrich features #37951

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.

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

tim-liakh-datadog
Copy link

What does this PR do?

This PR gives the user the ability to select which auto-enrichments they want from the converter.

Motivation

Previously, the user would be forced to enable or disable all of them.

Describe how you validated your changes

To validate my changes I ran the unit tests and manually checked that it performed as expected with environment variables and in datadog.yaml. In addition, I created new unit tests to make sure it continues to work correctly in the future.

Possible Drawbacks / Trade-offs

Creates additional documentation which might confuse user.

Additional Notes

@tim-liakh-datadog tim-liakh-datadog requested review from a team as code owners June 13, 2025 18:52
@bits-bot
Copy link
Collaborator

bits-bot commented Jun 13, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added the long review PR is complex, plan time to review it label Jun 13, 2025
Copy link

cit-pr-commenter bot commented Jun 13, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 7dda6dda-2ea5-4db1-80f0-185a9595194c

Baseline: 641d806
Comparison: f6eacdd
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
ddot_logs memory utilization +0.97 [+0.86, +1.09] 1 Logs
file_tree memory utilization +0.85 [+0.71, +0.99] 1 Logs
quality_gate_idle_all_features memory utilization +0.53 [+0.45, +0.60] 1 Logs bounds checks dashboard
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization +0.39 [+0.34, +0.43] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.28 [+0.22, +0.34] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.08 [-0.56, +0.72] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.01 [-0.26, +0.28] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.01 [-0.58, +0.59] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.00 [-0.24, +0.24] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.01 [-0.03, +0.02] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.01 [-0.60, +0.57] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.01 [-0.61, +0.58] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.02 [-0.62, +0.58] 1 Logs
ddot_metrics memory utilization -0.06 [-0.18, +0.05] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.07 [-0.68, +0.53] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.08 [-0.65, +0.49] 1 Logs
quality_gate_idle memory utilization -0.08 [-0.15, -0.02] 1 Logs bounds checks dashboard
otlp_ingest_metrics memory utilization -0.27 [-0.44, -0.10] 1 Logs
otlp_ingest_logs memory utilization -0.28 [-0.41, -0.15] 1 Logs
docker_containers_memory memory utilization -0.34 [-0.44, -0.23] 1 Logs
quality_gate_logs % cpu utilization -0.44 [-3.17, +2.30] 1 Logs bounds checks dashboard
uds_dogstatsd_to_api_cpu % cpu utilization -0.46 [-1.35, +0.43] 1 Logs
docker_containers_cpu % cpu utilization -0.85 [-3.86, +2.16] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
docker_containers_cpu simple_check_run 10/10
docker_containers_memory memory_usage 10/10
docker_containers_memory simple_check_run 10/10
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_0ms_latency_http1 lost_bytes 10/10
file_to_blackhole_0ms_latency_http1 memory_usage 10/10
file_to_blackhole_0ms_latency_http2 lost_bytes 10/10
file_to_blackhole_0ms_latency_http2 memory_usage 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency_linear_load memory_usage 10/10
file_to_blackhole_100ms_latency lost_bytes 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency lost_bytes 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency lost_bytes 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
quality_gate_idle intake_connections 10/10 bounds checks dashboard
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
quality_gate_logs intake_connections 10/10 bounds checks dashboard
quality_gate_logs lost_bytes 10/10 bounds checks dashboard
quality_gate_logs memory_usage 10/10 bounds checks dashboard

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@tim-liakh-datadog tim-liakh-datadog added team/opentelemetry-agent qa/done QA done before merge and regressions are covered by tests changelog/no-changelog labels Jun 13, 2025
config.ParseEnvAsStringSlice("otelcollector.converter.features", func(s string) []string {
// Either commas or spaces can be used as separators.
// Comma takes precedence as it was the only supported separator in the past for other implementations.
// Mixing separators is not supported.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it a hard requirement to not allow mixing separators, or a consequence of the implementation? If you're okay with allowing either, you could simplify this code by using FieldsFunc. We do something similar here:

proxyNoProxy = strings.FieldsFunc(os.Getenv("DD_PROXY_NO_PROXY"), func(r rune) bool {

Copy link
Contributor

@liustanley liustanley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice job on the implementation and tests! Mostly leaving comments on smaller things but the rest of the PR looks good. Would also recommend adding documentation in the converter README for this feature.

@@ -927,6 +927,22 @@ func InitConfig(config pkgconfigmodel.Setup) {
config.BindEnvAndSetDefault("otelcollector.submit_dummy_metadata", false) // dev flag - to be removed
config.BindEnvAndSetDefault("otelcollector.converter.enabled", true)
config.BindEnvAndSetDefault("otelcollector.flare.timeout", 60)
config.BindEnvAndSetDefault("otelcollector.converter.features", []string{"infraattributes", "prometheus", "core", "pprof", "zpages", "health_check", "ddflare"}, "DD_OTELCOLLECTOR_FEATURES")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
config.BindEnvAndSetDefault("otelcollector.converter.features", []string{"infraattributes", "prometheus", "core", "pprof", "zpages", "health_check", "ddflare"}, "DD_OTELCOLLECTOR_FEATURES")
config.BindEnvAndSetDefault("otelcollector.converter.features", []string{"infraattributes", "prometheus", "core", "pprof", "zpages", "health_check", "ddflare"})

The environment variable name can be removed here, the config package will automatically set the environment variable name according to its convention (DD_OTELCOLLECTOR_CONVERTER_FEATURES)

Comment on lines +31 to +36
// If not specified, assume all features are enabled
if c.coreConfig != nil {
enabledFeatures = c.coreConfig.GetStringSlice("otelcollector.converter.features")
} else {
enabledFeatures = []string{"infraattributes", "prometheus", "core", "pprof", "zpages", "health_check", "ddflare"}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to check if c.coreConfig is nil here, it will always be present when this function is called. There's also no need to set enabledFeatures to all features here since you already set this by default in pkg/config/setup/config.go.

@@ -927,6 +927,22 @@ func InitConfig(config pkgconfigmodel.Setup) {
config.BindEnvAndSetDefault("otelcollector.submit_dummy_metadata", false) // dev flag - to be removed
config.BindEnvAndSetDefault("otelcollector.converter.enabled", true)
config.BindEnvAndSetDefault("otelcollector.flare.timeout", 60)
config.BindEnvAndSetDefault("otelcollector.converter.features", []string{"infraattributes", "prometheus", "core", "pprof", "zpages", "health_check", "ddflare"}, "DD_OTELCOLLECTOR_FEATURES")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would also recommend declaring the full list of default features as a constant in autoconfigure.go and importing it here. That way all of the converter features are in one place and can be modified more easily in the future.

{
name: "features/no-features",
provided: "features/no-features/config.yaml",
expectedResult: "features/no-features/config-result.yaml",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: you could use config.yaml for both here and delete features/no-features/config-result.yaml

Comment on lines +4 to +5
key: ggggg77777
site: datadoghq.eu
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should remove these two lines in this test

@@ -305,6 +305,48 @@ func TestConvert(t *testing.T) {
expectedResult: "dd-core-cfg/env/empty-profiler-options/config-result.yaml",
agentConfig: "dd-core-cfg/env/empty-profiler-options/acfg.yaml",
},
{
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also add a test case where features is not defined in acfg.yaml to verify that all features still get used?

@agent-platform-auto-pr
Copy link
Contributor

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 641d806

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
agent_deb_amd64 $${+0}$$ $${696.37}$$ < $${697.37}$$ $${-0}$$ $${176.07}$$ < $${177.03}$$
agent_deb_amd64_fips $${+0}$$ $${694.67}$$ < $${695.59}$$ $${+0.03}$$ $${175.53}$$ < $${176.51}$$
agent_heroku_amd64 $${+0}$$ $${358.67}$$ < $${359.67}$$ $${+0}$$ $${96.52}$$ < $${97.47}$$
agent_msi $${+0.01}$$ $${958.87}$$ < $${959.86}$$ $${+0.02}$$ $${146.31}$$ < $${147.27}$$
agent_rpm_amd64 $${+0}$$ $${696.36}$$ < $${697.36}$$ $${-0.02}$$ $${177.61}$$ < $${178.56}$$
agent_rpm_amd64_fips $${+0}$$ $${694.66}$$ < $${695.58}$$ $${+0.03}$$ $${177.49}$$ < $${178.43}$$
agent_rpm_arm64 $${+0.01}$$ $${686.38}$$ < $${687.37}$$ $${+0.04}$$ $${161.06}$$ < $${161.99}$$
agent_rpm_arm64_fips $${-0}$$ $${684.78}$$ < $${685.72}$$ $${-0.03}$$ $${160.18}$$ < $${161.11}$$
agent_suse_amd64 $${+0}$$ $${696.36}$$ < $${697.36}$$ $${-0.02}$$ $${177.61}$$ < $${178.56}$$
agent_suse_amd64_fips $${+0}$$ $${694.66}$$ < $${695.58}$$ $${+0.03}$$ $${177.49}$$ < $${178.43}$$
agent_suse_arm64 $${+0.01}$$ $${686.38}$$ < $${687.37}$$ $${+0.04}$$ $${161.06}$$ < $${161.99}$$
agent_suse_arm64_fips $${-0}$$ $${684.78}$$ < $${685.72}$$ $${-0.03}$$ $${160.18}$$ < $${161.11}$$
docker_agent_amd64 $${+0}$$ $${780.16}$$ < $${781.16}$$ $${+0.01}$$ $${268.69}$$ < $${269.63}$$
docker_agent_arm64 $${+0.01}$$ $${793.63}$$ < $${794.62}$$ $${-0}$$ $${256.04}$$ < $${257.0}$$
docker_agent_jmx_amd64 $${+0}$$ $${971.35}$$ < $${972.35}$$ $${-0.02}$$ $${337.63}$$ < $${338.6}$$
docker_agent_jmx_arm64 $${+0.01}$$ $${973.42}$$ < $${974.41}$$ $${-0}$$ $${320.99}$$ < $${321.97}$$
docker_agent_windows1809 $${+0.02}$$ $${1487.02}$$ < $${1488.0}$$ $${+0.04}$$ $${488.14}$$ < $${488.95}$$
docker_agent_windows1809_core $${+0.01}$$ $${6216.97}$$ < $${6218.0}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows1809_core_jmx $${+0.08}$$ $${6338.75}$$ < $${6339.0}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows1809_jmx $${+0.06}$$ $${1608.69}$$ < $${1609.5}$$ $${+0.05}$$ $${530.41}$$ < $${531.32}$$
docker_agent_windows2022 $${-0.05}$$ $${1506.25}$$ < $${1507.0}$$ $${-0}$$ $${500.75}$$ < $${501.7}$$
docker_agent_windows2022_core $${+0.28}$$ $${6190.29}$$ < $${6311.0}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows2022_core_jmx $${-0.07}$$ $${6311.9}$$ < $${6313.0}$$ $${0}$$ $${2048.0}$$ < $${2049.0}$$
docker_agent_windows2022_jmx $${+0.01}$$ $${1628.08}$$ < $${1628.16}$$ $${+0.02}$$ $${543.07}$$ < $${543.98}$$
docker_cluster_agent_amd64 $${-0}$$ $${212.84}$$ < $${213.79}$$ $${+0}$$ $${72.38}$$ < $${73.33}$$
docker_cluster_agent_arm64 $${-0}$$ $${228.68}$$ < $${229.64}$$ $${+0}$$ $${68.64}$$ < $${69.6}$$
docker_cws_instrumentation_amd64 $${0}$$ $${7.08}$$ < $${7.12}$$ $${+0}$$ $${2.95}$$ < $${3.29}$$
docker_cws_instrumentation_arm64 $${+0}$$ $${6.69}$$ < $${6.92}$$ $${+0}$$ $${2.7}$$ < $${3.07}$$
docker_dogstatsd_amd64 $${+0}$$ $${39.22}$$ < $${39.57}$$ $${-0}$$ $${15.12}$$ < $${15.76}$$
docker_dogstatsd_arm64 $${0}$$ $${37.88}$$ < $${38.2}$$ $${+0}$$ $${14.53}$$ < $${14.83}$$
dogstatsd_deb_amd64 $${0}$$ $${30.45}$$ < $${31.4}$$ $${+0}$$ $${8.0}$$ < $${8.95}$$
dogstatsd_deb_arm64 $${0}$$ $${29.02}$$ < $${29.97}$$ $${+0}$$ $${6.94}$$ < $${7.89}$$
dogstatsd_rpm_amd64 $${0}$$ $${30.45}$$ < $${31.4}$$ $${+0}$$ $${8.01}$$ < $${8.96}$$
dogstatsd_suse_amd64 $${0}$$ $${30.45}$$ < $${31.4}$$ $${+0}$$ $${8.01}$$ < $${8.96}$$
iot_agent_deb_amd64 $${0}$$ $${50.42}$$ < $${51.38}$$ $${-0}$$ $${12.84}$$ < $${13.79}$$
iot_agent_deb_arm64 $${0}$$ $${47.9}$$ < $${48.85}$$ $${-0}$$ $${11.14}$$ < $${12.09}$$
iot_agent_deb_armhf $${0}$$ $${47.47}$$ < $${48.42}$$ $${+0.01}$$ $${11.2}$$ < $${12.16}$$
iot_agent_rpm_amd64 $${0}$$ $${50.42}$$ < $${51.38}$$ $${+0}$$ $${12.86}$$ < $${13.81}$$
iot_agent_rpm_arm64 $${0}$$ $${47.9}$$ < $${48.85}$$ $${+0}$$ $${11.16}$$ < $${12.11}$$
iot_agent_suse_amd64 $${0}$$ $${50.42}$$ < $${51.38}$$ $${+0}$$ $${12.86}$$ < $${13.81}$$

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/opentelemetry-agent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants