fix(ssi): properly parse lib versions from env var #34645
Merged
+118
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit ensures we can properly parse the lib versions config from an environment variable. Additionally, I've ensured that enabled/disabled namespaces will also parse as expected.
Test changes on VMUse this command from test-infra-definitions to manually test this PR changes on a VM: inv aws.create-vm --pipeline-id=57548132 --os-family=ubuntuNote: This applies to commit 7e3e28e |
knusbaum
approved these changes
Mar 3, 2025
Uncompressed package size comparisonComparison with ancestor Diff per package
Decision |
stanistan
reviewed
Mar 3, 2025
| @@ -85,8 +85,29 @@ func setupAPM(config pkgconfigmodel.Setup) { | |||
| config.BindEnvAndSetDefault("apm_config.compute_stats_by_span_kind", true, "DD_APM_COMPUTE_STATS_BY_SPAN_KIND") //nolint:errcheck | |||
| config.BindEnvAndSetDefault("apm_config.instrumentation.enabled", false, "DD_APM_INSTRUMENTATION_ENABLED") | |||
| config.BindEnvAndSetDefault("apm_config.instrumentation.enabled_namespaces", []string{}, "DD_APM_INSTRUMENTATION_ENABLED_NAMESPACES") | |||
| config.ParseEnvAsStringSlice("apm_config.instrumentation.enabled_namespaces", func(in string) []string { | |||
There was a problem hiding this comment.
https://github.com/DataDog/helm-charts/blob/fa73f62265f91c9d55685925f769a43afd870ba3/charts/datadog/templates/cluster-agent-deployment.yaml#L272-L279 This is all fine since we quote the json and pass the string through right?
There was a problem hiding this comment.
Looks correct to me. From the config's perspective, env vars always have string values, and since the value in the helm chart is converted to json, this handler will properly parse it to a slice of strings.
Static quality checks ✅Please find below the results from static quality gates Successful checksInfo
|
stanistan
approved these changes
Mar 3, 2025
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: c99883d Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | uds_dogstatsd_to_api_cpu | % cpu utilization | +1.80 | [+0.89, +2.71] | 1 | Logs |
| ➖ | file_tree | memory utilization | +0.65 | [+0.59, +0.71] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | +0.32 | [-0.46, +1.10] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | +0.12 | [+0.08, +0.16] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_1000ms_latency_linear_load | egress throughput | +0.04 | [-0.42, +0.51] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency_http2 | egress throughput | +0.04 | [-0.77, +0.85] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | +0.03 | [-0.64, +0.70] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | +0.01 | [-0.28, +0.29] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | +0.00 | [-0.78, +0.78] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | +0.00 | [-0.02, +0.03] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.00 | [-0.05, +0.04] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_300ms_latency | egress throughput | -0.00 | [-0.63, +0.62] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency_http1 | egress throughput | -0.03 | [-0.81, +0.76] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | -0.04 | [-0.81, +0.74] | 1 | Logs |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | -0.66 | [-0.72, -0.60] | 1 | Logs |
| ➖ | quality_gate_logs | % cpu utilization | -2.65 | [-5.54, +0.25] | 1 | Logs |
Bounds Checks: ✅ Passed
| perf | experiment | bounds_check_name | replicates_passed | links |
|---|---|---|---|---|
| ✅ | 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 | |
| ✅ | quality_gate_logs | lost_bytes | 10/10 | |
| ✅ | quality_gate_logs | memory_usage | 10/10 |
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_logs, 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_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
dustmop
approved these changes
Mar 3, 2025
| @@ -85,8 +85,29 @@ func setupAPM(config pkgconfigmodel.Setup) { | |||
| config.BindEnvAndSetDefault("apm_config.compute_stats_by_span_kind", true, "DD_APM_COMPUTE_STATS_BY_SPAN_KIND") //nolint:errcheck | |||
| config.BindEnvAndSetDefault("apm_config.instrumentation.enabled", false, "DD_APM_INSTRUMENTATION_ENABLED") | |||
| config.BindEnvAndSetDefault("apm_config.instrumentation.enabled_namespaces", []string{}, "DD_APM_INSTRUMENTATION_ENABLED_NAMESPACES") | |||
| config.ParseEnvAsStringSlice("apm_config.instrumentation.enabled_namespaces", func(in string) []string { | |||
There was a problem hiding this comment.
Looks correct to me. From the config's perspective, env vars always have string values, and since the value in the helm chart is converted to json, this handler will properly parse it to a slice of strings.
|
/merge |
|
View all feedbacks in Devflow UI.
The median merge time in
|
agent-platform-auto-pr bot
pushed a commit
that referenced
this pull request
Mar 3, 2025
(cherry picked from commit 7197664)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This commit ensures we can properly parse the lib versions config from an environment variable (
DD_APM_INSTRUMENTATION_LIB_VERSIONS). Additionally, I've ensured that enabled/disabled namespaces will also parse as expected.Motivation
We switched to reading
apm_config.instrumentationas a unit given we have added a lot more configuration options in Kubernetes SSI | Workload Selection 🎯 and it would be impossible to parse targets through the standard viper interface. As part of that work, we ensured that extraneous or bad keys would throw an error instead of being accepted. See this PR for more details: #34001It seems like this config option was missed, and this PR has a lot more details: #34610. It does not work as it stands given we would not be able to ensure extraneous keys threw an exception.
Describe how you validated your changes
The additional unit tests.
Possible Drawbacks / Trade-offs
Our config is "standard" but it's admittedly a bit more complex then simpler configs in this repo. The plus side is that we're explicit about how these environment variables will parse.
Additional Notes