-
Notifications
You must be signed in to change notification settings - Fork 1.3k
[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
base: main
Are you sure you want to change the base?
Conversation
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: 641d806 Optimization Goals: ✅ No significant changes detected
|
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:
-
Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.
-
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.
-
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.
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. |
There was a problem hiding this comment.
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 { |
There was a problem hiding this 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") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
)
// 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"} | ||
} |
There was a problem hiding this comment.
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") |
There was a problem hiding this comment.
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", |
There was a problem hiding this comment.
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
key: ggggg77777 | ||
site: datadoghq.eu |
There was a problem hiding this comment.
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", | |||
}, | |||
{ |
There was a problem hiding this comment.
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?
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
|
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