Fix parsing of `DD_APM_INSTRUMENTATION_LIB_VERSIONS` #34610

keisku · 2025-03-03T05:57:08Z

What does this PR do?

Fix parsing of DD_APM_INSTRUMENTATION_LIB_VERSIONS.

Motivation

We cannot use admission.datadoghq.com/%s-lib.config.v1 when we have the following yaml files.

Pod

apiVersion: v1
kind: Pod
metadata:
  annotations:
    admission.datadoghq.com/js-lib.config.v1: |
      {
        "library_language": "js",
        "library_version": "5.39.0",
        "service_name": "test",
        "env": "test"
      }
  labels:
    admission.datadoghq.com/enabled: "true"

Operator

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  features:
    apm:
      enabled: true
      instrumentation:
        enabled: true
        libVersions:
          js: "5"
  override:
    clusterAgent:
      replicas: 2
      - name: DD_ADMISSION_CONTROLLER_AUTO_INSTRUMENTATION_PATCHER_ENABLED
        value: "true"

Agent fails to parse DD_APM_INSTRUMENTATION_LIB_VERSIONS='{"js":"5"}' since a config value is string, not a map.

2025-03-03 06:59:10 UTC | CLUSTER | ERROR | (pkg/clusteragent/admission/controllers/webhook/controller_base.go:146 in generateWebhooks) | failed to register APM Instrumentation webhook: failed to create auto instrumentation config: unable to parse apm_config.instrumentation: 1 error(s) decoding:

WORKAROUND

apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
  name: datadog
spec:
  features:
    apm:
      enabled: true
      instrumentation:
        enabled: true
        # WORKAROUND
        # libVersions:
        #   js: "5"
  override:
    clusterAgent:
      replicas: 2
      - name: DD_ADMISSION_CONTROLLER_AUTO_INSTRUMENTATION_PATCHER_ENABLED
        value: "true"

Describe how you validated your changes

Use Pod and Operator yaml files that I wrote above to confirm the error above happen and admission.datadoghq.com/js-lib.config.v1 works.

Possible Drawbacks / Trade-offs

Additional Notes

agent-platform-auto-pr · 2025-03-03T06:15:38Z

[Fast Unit Tests Report]

On pipeline 57458386 (CI Visibility). The following jobs did not run any unit tests:

Jobs:

tests_flavor_dogstatsd_deb-x64
tests_flavor_heroku_deb-x64
tests_flavor_iot_deb-x64

If you modified Go files and expected unit tests to run in these jobs, please double check the job logs. If you think tests should have been executed reach out to #agent-devx-help

agent-platform-auto-pr · 2025-03-03T06:19:17Z

Uncompressed package size comparison

Comparison with ancestor ac8aab14e3262853f60f0279c3c8fd452cd9c877

Diff per package

package	diff	status	size	ancestor	threshold
datadog-agent-amd64-deb	0.00MB	✅	815.25MB	815.25MB	0.50MB
datadog-agent-x86_64-rpm	0.00MB	✅	825.05MB	825.05MB	0.50MB
datadog-agent-x86_64-suse	0.00MB	✅	825.05MB	825.05MB	0.50MB
datadog-agent-arm64-deb	0.00MB	✅	806.21MB	806.21MB	0.50MB
datadog-agent-aarch64-rpm	0.00MB	✅	815.99MB	815.99MB	0.50MB
datadog-dogstatsd-amd64-deb	0.00MB	✅	39.42MB	39.42MB	0.50MB
datadog-dogstatsd-x86_64-rpm	0.00MB	✅	39.50MB	39.50MB	0.50MB
datadog-dogstatsd-x86_64-suse	0.00MB	✅	39.50MB	39.50MB	0.50MB
datadog-dogstatsd-arm64-deb	0.00MB	✅	37.96MB	37.96MB	0.50MB
datadog-heroku-agent-amd64-deb	0.00MB	✅	440.67MB	440.67MB	0.50MB
datadog-iot-agent-amd64-deb	0.00MB	✅	62.10MB	62.10MB	0.50MB
datadog-iot-agent-x86_64-rpm	0.00MB	✅	62.17MB	62.17MB	0.50MB
datadog-iot-agent-x86_64-suse	0.00MB	✅	62.17MB	62.17MB	0.50MB
datadog-iot-agent-arm64-deb	0.00MB	✅	59.34MB	59.34MB	0.50MB
datadog-iot-agent-aarch64-rpm	0.00MB	✅	59.41MB	59.41MB	0.50MB

Decision

✅ Passed

agent-platform-auto-pr · 2025-03-03T06:25:10Z

Static quality checks ✅

Please find below the results from static quality gates

Successful checks

Info

Result	Quality gate	On disk size	On disk size limit	On wire size	On wire size limit
✅	static_quality_gate_agent_deb_amd64	788.5MiB	801.8MiB	192.28MiB	202.62MiB
✅	static_quality_gate_agent_deb_arm64	779.85MiB	793.14MiB	174.29MiB	184.51MiB
✅	static_quality_gate_agent_rpm_amd64	788.49MiB	801.79MiB	194.32MiB	205.03MiB
✅	static_quality_gate_agent_rpm_arm64	779.84MiB	793.09MiB	175.88MiB	186.44MiB
✅	static_quality_gate_agent_suse_amd64	788.49MiB	801.81MiB	194.32MiB	205.03MiB
✅	static_quality_gate_agent_suse_arm64	779.84MiB	793.14MiB	175.88MiB	186.44MiB
✅	static_quality_gate_dogstatsd_deb_amd64	37.67MiB	47.67MiB	9.78MiB	19.78MiB
✅	static_quality_gate_dogstatsd_deb_arm64	36.28MiB	46.27MiB	8.48MiB	18.49MiB
✅	static_quality_gate_dogstatsd_rpm_amd64	37.67MiB	47.67MiB	9.79MiB	19.79MiB
✅	static_quality_gate_dogstatsd_suse_amd64	37.67MiB	47.67MiB	9.79MiB	19.79MiB
✅	static_quality_gate_iot_agent_deb_amd64	59.3MiB	69.0MiB	14.9MiB	24.8MiB
✅	static_quality_gate_iot_agent_deb_arm64	56.66MiB	66.4MiB	12.86MiB	22.8MiB
✅	static_quality_gate_iot_agent_rpm_amd64	59.3MiB	69.0MiB	14.92MiB	24.8MiB
✅	static_quality_gate_iot_agent_rpm_arm64	56.66MiB	66.4MiB	12.86MiB	22.8MiB
✅	static_quality_gate_iot_agent_suse_amd64	59.3MiB	69.0MiB	14.92MiB	24.8MiB
✅	static_quality_gate_docker_agent_amd64	873.63MiB	886.12MiB	293.87MiB	304.21MiB
✅	static_quality_gate_docker_agent_arm64	888.28MiB	900.79MiB	280.12MiB	290.47MiB
✅	static_quality_gate_docker_agent_jmx_amd64	1.05GiB	1.06GiB	368.99MiB	379.33MiB
✅	static_quality_gate_docker_agent_jmx_arm64	1.05GiB	1.06GiB	351.23MiB	361.55MiB
✅	static_quality_gate_docker_dogstatsd_amd64	45.82MiB	55.78MiB	17.28MiB	27.28MiB
✅	static_quality_gate_docker_dogstatsd_arm64	44.46MiB	54.45MiB	16.17MiB	26.16MiB
✅	static_quality_gate_docker_cluster_agent_amd64	264.99MiB	274.78MiB	106.36MiB	116.28MiB
✅	static_quality_gate_docker_cluster_agent_arm64	280.96MiB	290.82MiB	101.2MiB	111.12MiB

cit-pr-commenter · 2025-03-03T06:38:42Z

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 027138d7-d6b2-4adb-a7ea-cbcd694d9811

Baseline: ac8aab1
Comparison: 7023f99
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	tcp_syslog_to_blackhole	ingress throughput	+1.57	[+1.51, +1.63]	1	Logs
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	+0.79	[-0.08, +1.66]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	+0.14	[-0.63, +0.92]	1	Logs
➖	quality_gate_idle	memory utilization	+0.13	[+0.06, +0.20]	1	Logs bounds checks dashboard
➖	file_to_blackhole_500ms_latency	egress throughput	+0.03	[-0.76, +0.82]	1	Logs
➖	file_to_blackhole_0ms_latency_http1	egress throughput	+0.01	[-0.76, +0.79]	1	Logs
➖	file_to_blackhole_0ms_latency_http2	egress throughput	+0.01	[-0.74, +0.77]	1	Logs
➖	uds_dogstatsd_to_api	ingress throughput	+0.00	[-0.28, +0.29]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	-0.00	[-0.03, +0.02]	1	Logs
➖	file_to_blackhole_300ms_latency	egress throughput	-0.00	[-0.63, +0.62]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	-0.02	[-0.83, +0.78]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	-0.02	[-0.73, +0.69]	1	Logs
➖	file_tree	memory utilization	-0.04	[-0.11, +0.02]	1	Logs
➖	file_to_blackhole_1000ms_latency_linear_load	egress throughput	-0.06	[-0.53, +0.40]	1	Logs
➖	quality_gate_idle_all_features	memory utilization	-0.23	[-0.28, -0.18]	1	Logs bounds checks dashboard
➖	quality_gate_logs	% cpu utilization	-0.49	[-3.43, +2.46]	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_idle, 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_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_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_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.

agent-platform-auto-pr · 2025-03-03T07:25:40Z

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv aws.create-vm --pipeline-id=57458386 --os-family=ubuntu

Note: This applies to commit 7023f99

betterengineering · 2025-03-03T18:40:15Z

pkg/clusteragent/admission/mutate/autoinstrumentation/config_test.go

-			shouldErr:  true,
-			expected:   nil,
+			shouldErr:  false,
+			expected: &InstrumentationConfig{


Really appreciate this change @keisku!! This test unfortunately cannot change. I Copied your additional test to this change, and added tests for a few other fields I missed: #34645

keisku · 2025-03-03T23:46:54Z

This PR was copied into #34645

Fix parsing of apm_config.instrumentation.lib_versions

7023f99

github-actions bot added short review PR is simple enough to be reviewed quickly team/container-platform The Container Platform Team team/injection-platform labels Mar 3, 2025

keisku added changelog/no-changelog qa/done QA done before merge and regressions are covered by tests labels Mar 3, 2025

keisku marked this pull request as ready for review March 3, 2025 07:09

keisku requested review from a team as code owners March 3, 2025 07:09

keisku requested a review from stanistan March 3, 2025 07:09

betterengineering mentioned this pull request Mar 3, 2025

fix(ssi): properly parse lib versions from env var #34645

Merged

betterengineering requested changes Mar 3, 2025

View reviewed changes

agent-platform-auto-pr bot mentioned this pull request Mar 3, 2025

[Backport 7.64.x] fix(ssi): properly parse lib versions from env var #34668

Merged

keisku closed this Mar 3, 2025

keisku deleted the keisku/admission-controller-libversion branch March 3, 2025 23:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix parsing of `DD_APM_INSTRUMENTATION_LIB_VERSIONS` #34610

Fix parsing of `DD_APM_INSTRUMENTATION_LIB_VERSIONS` #34610

keisku commented Mar 3, 2025 •

edited

Loading

agent-platform-auto-pr bot commented Mar 3, 2025

agent-platform-auto-pr bot commented Mar 3, 2025

agent-platform-auto-pr bot commented Mar 3, 2025

Info

cit-pr-commenter bot commented Mar 3, 2025

Fine details of change detection per experiment

Bounds Checks: ✅ Passed

Explanation

agent-platform-auto-pr bot commented Mar 3, 2025

betterengineering Mar 3, 2025

keisku commented Mar 3, 2025

Fix parsing of DD_APM_INSTRUMENTATION_LIB_VERSIONS #34610

Fix parsing of DD_APM_INSTRUMENTATION_LIB_VERSIONS #34610

Conversation

keisku commented Mar 3, 2025 • edited Loading

What does this PR do?

Motivation

Describe how you validated your changes

Possible Drawbacks / Trade-offs

Additional Notes

agent-platform-auto-pr bot commented Mar 3, 2025

agent-platform-auto-pr bot commented Mar 3, 2025

Uncompressed package size comparison

Decision

agent-platform-auto-pr bot commented Mar 3, 2025

Static quality checks ✅

Info

cit-pr-commenter bot commented Mar 3, 2025

Regression Detector

Regression Detector Results

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

Bounds Checks: ✅ Passed

Explanation

CI Pass/Fail Decision

agent-platform-auto-pr bot commented Mar 3, 2025

Test changes on VM

betterengineering Mar 3, 2025

Choose a reason for hiding this comment

keisku commented Mar 3, 2025

Fix parsing of `DD_APM_INSTRUMENTATION_LIB_VERSIONS` #34610

Fix parsing of `DD_APM_INSTRUMENTATION_LIB_VERSIONS` #34610

keisku commented Mar 3, 2025 •

edited

Loading