Skip to content
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

feat(ssi): add support for trace configs #33959

Merged
merged 2 commits into from
Feb 12, 2025

Conversation

betterengineering
Copy link
Member

What does this PR do?

This commit adds support for adding trace configs in addition to the trace versions in the target based workload selection.

Motivation

This is an extension of Kubernetes SSI | Workload Selection 🎯 to be able to support configuring tracers. We keep getting feedback from customers that Single Step is great at delivering a tracing library, but it doesn't allow for configuring the tracing library for any other product we support. This change will enable that for SSI in Kubernetes.

Describe how you validated your changes

The unit tests added are the main test for this feature. But I also conducted a manual test using the injector-dev tooling in the auto_inject repo. I used the following config in my helm chart:

  datadog_cluster_yaml:
    log_level: DEBUG
    apm_config:
      instrumentation:
        enabled: true
        targets:
          - name: "Python Apps"
            podSelector:
              matchLabels:
                language: "python"
            ddTraceVersions:
              python: "v2"
            ddTraceConfigs:
              - name: "DD_PROFILING_ENABLED"
                value: "true"
              - name: "DD_DATA_JOBS_ENABLED"
                value: "true"

I ran the following to deploy a custom cluster agent locally:

injector-dev start
injector-dev init-k8s-helm
injector-dev custom-cluster-agent

I then restarted the test app to trigger injection:

kubectl -n test-1 rollout restart deployment

I then confirmed the additional env variables exist:

kubectl -n test-1 get pods -o jsonpath="{range .items[*]}{.metadata.name} {'\n'}{range .spec.containers[*]} {.name} {'\n'}{range .env[*]}  {.name}={.value} {'\n'}{end}{'\n'}{end}{'\n'}{end}"

python-app-5869fc58db-lxgmq
 app
  DD_DATA_JOBS_ENABLED=true
  DD_PROFILING_ENABLED=true
  DD_RUNTIME_METRICS_ENABLED=true
  DD_TRACE_HEALTH_METRICS_ENABLED=true
  DD_LOGS_INJECTION=true
  DD_TRACE_ENABLED=true
  DD_INSTRUMENTATION_INSTALL_ID=5a9c4b83-7ee3-4109-800c-5bc7a143007f
  DD_INSTRUMENTATION_INSTALL_TIME=1739325947
  DD_INSTRUMENTATION_INSTALL_TYPE=k8s_single_step
  DD_SERVICE=test-python-app-ssi
  DD_ENV=local
  DD_INTERNAL_POD_UID=
  DD_EXTERNAL_ENV=it-false,cn-app,pu-$(DD_INTERNAL_POD_UID)
  DD_ENTITY_ID=
  DD_DOGSTATSD_URL=unix:///var/run/datadog/dsd.socket
  DD_TRACE_AGENT_URL=unix:///var/run/datadog/apm.socket
  DD_TRACE_DEBUG=true
  LD_PRELOAD=/opt/datadog-packages/datadog-apm-inject/stable/inject/launcher.preload.so
  DD_INJECT_SENDER_TYPE=k8s
  DD_INJECT_START_TIME=1739325987

Possible Drawbacks / Trade-offs

A list of env vars is not as ergonomic as dedicated configuration options. It would be especially confusing if the option also required additional setup. However, dedicated configuration options require an agent release, operator release, and a release of the helm chart. This provides a higher level of flexibility without requiring us to add options for new products.

Additional Notes

This commit adds support for adding trace configs in addition to the
trace versions in the target based workload selection.
@betterengineering betterengineering added qa/done QA done before merge and regressions are covered by tests team/injection-platform labels Feb 12, 2025
@betterengineering betterengineering requested review from a team as code owners February 12, 2025 02:09
@github-actions github-actions bot added the medium review PR review might take time label Feb 12, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 12, 2025

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=55692645 --os-family=ubuntu

Note: This applies to commit 9a4dc60

@agent-platform-auto-pr
Copy link
Contributor

Static quality checks ✅

Please find below the results from static quality gates

Info

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_deb_amd64 837.29MiB 858.45MiB 202.87MiB 214.3MiB
static_quality_gate_docker_agent_amd64 921.69MiB 942.69MiB 308.65MiB 321.56MiB
static_quality_gate_docker_agent_arm64 934.06MiB 952.69MiB 292.64MiB 351.22MiB
static_quality_gate_docker_agent_jmx_amd64 1.09GiB 1.11GiB 383.79MiB 395.8MiB
static_quality_gate_docker_agent_jmx_arm64 1.09GiB 1.11GiB 363.74MiB 375.5MiB
static_quality_gate_docker_dogstatsd_amd64 47.86MiB 57.88MiB 18.29MiB 28.29MiB
static_quality_gate_docker_dogstatsd_arm64 46.25MiB 56.27MiB 17.04MiB 27.06MiB
static_quality_gate_docker_cluster_agent_amd64 267.74MiB 277.7MiB 107.29MiB 117.28MiB
static_quality_gate_docker_cluster_agent_arm64 283.79MiB 293.73MiB 102.13MiB 112.12MiB

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 12, 2025

Uncompressed package size comparison

Comparison with ancestor e007f2d8e032ef430a3979e27af2811c28d3d685

Diff per package
package diff status size ancestor threshold
datadog-agent-aarch64-rpm 0.00MB 863.89MB 863.89MB 0.50MB
datadog-agent-amd64-deb 0.00MB 865.63MB 865.63MB 0.50MB
datadog-agent-arm64-deb 0.00MB 854.15MB 854.15MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 59.04MB 59.04MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 59.12MB 59.12MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 59.12MB 59.12MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 56.53MB 56.53MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 441.02MB 441.02MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 86.39MB 86.39MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 86.46MB 86.46MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 86.45MB 86.45MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 82.66MB 82.66MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 82.73MB 82.73MB 0.50MB
datadog-agent-x86_64-rpm -0.00MB 875.40MB 875.40MB 0.50MB
datadog-agent-x86_64-suse -0.00MB 875.40MB 875.40MB 0.50MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 12, 2025

[Fast Unit Tests Report]

On pipeline 55692645 (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

Copy link

cit-pr-commenter bot commented Feb 12, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: c3a28b25-a246-4217-a2bd-271bc860543c

Baseline: e007f2d
Comparison: 9a4dc60
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +2.06 [+1.15, +2.97] 1 Logs
quality_gate_idle_all_features memory utilization +0.46 [+0.39, +0.53] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.07 [-0.40, +0.54] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.06 [-0.85, +0.98] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.03 [-0.02, +0.08] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.03 [-0.91, +0.98] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.01 [-0.63, +0.64] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.01 [-0.02, +0.03] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.27, +0.27] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.04 [-0.92, +0.85] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.05 [-0.84, +0.74] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.06 [-0.75, +0.63] 1 Logs
quality_gate_idle memory utilization -0.16 [-0.21, -0.10] 1 Logs bounds checks dashboard
file_tree memory utilization -0.26 [-0.32, -0.19] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.31 [-1.08, +0.46] 1 Logs
quality_gate_logs % cpu utilization -1.58 [-4.60, +1.45] 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:

  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_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 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.
  • 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.

@betterengineering
Copy link
Member Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Feb 12, 2025

View all feedbacks in Devflow UI.
2025-02-12 16:03:08 UTC ℹ️ Start processing command /merge


2025-02-12 16:03:18 UTC ℹ️ MergeQueue: waiting for PR to be ready

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals.
Note: if you pushed new commits since the last approval, you may need additional approval.
You can remove it from the waiting list with /remove command.


2025-02-12 18:41:07 UTC ℹ️ MergeQueue: merge request added to the queue

The median merge time in main is 32m.


2025-02-12 19:09:24 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 99fb562 into main Feb 12, 2025
233 of 235 checks passed
@dd-mergequeue dd-mergequeue bot deleted the mark.spicer/INPLAT-477-add-tracer-config-support branch February 12, 2025 19:09
@github-actions github-actions bot added this to the 7.64.0 milestone Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
medium review PR review might take time qa/done QA done before merge and regressions are covered by tests team/injection-platform
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants