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

apm: add version checking for stats obfuscation to avoid double obfus… #33765

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

Conversation

ajgajg1134
Copy link
Contributor

@ajgajg1134 ajgajg1134 commented Feb 5, 2025

…cating

What does this PR do?

Checks that incoming stats payloads have not already been obfuscated as double obfuscation leads to altered resource names that aren't as useful (and could result in unexpected changes breaking monitors/dashboards)

We will expose an "obfuscation" version via the /info endpoint that tracers can use to determine if it safe for them to obfuscate e.g. DataDog/dd-trace-go#3155

Motivation

A few points here:

  • Obfuscating for stats payloads is valuable from a performance perspective as it reduces the cardinality of stats thereby using stats buckets more efficiently
  • Double obfuscating stats payloads (as occurs today) results in overly modified redis resources (and sql, but it's less susceptible). e.g. a redis resource like "GET k1 \n SET k2", should become GET SET but instead after double obfuscation becomes GET

Describe how you validated your changes

I updated relevant tests here and also performed a manual test using the PR here DataDog/dd-trace-go#3155 on the go tracer. I verified that an incoming redis stats payload will not be double obfuscated and appears correctly in the Datadog UI.

Possible Drawbacks / Trade-offs

This adds a bit of complexity around the choice to obfuscate, but should be non-breaking as it is only enabled by a new incoming header for these payloads.

Additional Notes

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 5, 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=55255658 --os-family=ubuntu

Note: This applies to commit 71f6b23

@github-actions github-actions bot added medium review PR review might take time team/agent-apm trace-agent labels Feb 5, 2025
Copy link

cit-pr-commenter bot commented Feb 5, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: a63a4eeb-988e-4f9f-8728-9c379e41fd58

Baseline: e305652
Comparison: 71f6b23
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.32 [+1.24, +1.40] 1 Logs
file_tree memory utilization +0.84 [+0.78, +0.91] 1 Logs
quality_gate_logs % cpu utilization +0.74 [-2.33, +3.81] 1 Logs
quality_gate_idle_all_features memory utilization +0.44 [+0.36, +0.51] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency egress throughput +0.25 [-0.53, +1.03] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.22 [-0.25, +0.68] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.16 [-0.63, +0.96] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.06 [-0.80, +0.92] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.01 [-0.28, +0.30] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.01 [-0.63, +0.65] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.02, +0.02] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.03 [-0.88, +0.82] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.03 [-0.70, +0.64] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.07 [-0.96, +0.83] 1 Logs
quality_gate_idle memory utilization -0.46 [-0.53, -0.39] 1 Logs bounds checks dashboard
uds_dogstatsd_to_api_cpu % cpu utilization -0.82 [-1.68, +0.04] 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_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_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_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.

@ajgajg1134 ajgajg1134 added the qa/done QA done before merge and regressions are covered by tests label Feb 6, 2025
@ajgajg1134 ajgajg1134 marked this pull request as ready for review February 6, 2025 16:06
@ajgajg1134 ajgajg1134 requested review from a team as code owners February 6, 2025 16:06
@ajgajg1134 ajgajg1134 requested a review from a team as a code owner February 6, 2025 16:10
@agent-platform-auto-pr
Copy link
Contributor

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

Uncompressed package size comparison

Comparison with ancestor e305652b1fe275fb27009d4e6153cacecb503ae4

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.01MB ⚠️ 873.66MB 873.66MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 883.40MB 883.40MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 883.40MB 883.40MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 86.54MB 86.54MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 86.54MB 86.54MB 0.50MB
datadog-agent-arm64-deb 0.00MB 861.54MB 861.54MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 59.10MB 59.10MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 59.18MB 59.18MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 59.18MB 59.18MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 56.57MB 56.57MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 446.05MB 446.05MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 86.47MB 86.47MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 82.74MB 82.74MB 0.50MB
datadog-agent-aarch64-rpm -0.00MB 871.26MB 871.26MB 0.50MB
datadog-iot-agent-aarch64-rpm -0.00MB 82.81MB 82.81MB 0.50MB

Decision

⚠️ Warning

@agent-platform-auto-pr
Copy link
Contributor

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

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 845.12MiB 858.45MiB 203.56MiB 214.3MiB
static_quality_gate_docker_agent_amd64 929.32MiB 942.69MiB 310.72MiB 321.56MiB

Copy link
Contributor

@ichinaski ichinaski left a comment

Choose a reason for hiding this comment

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

LGTM, left small nit

pkg/trace/agent/agent.go Outdated Show resolved Hide resolved
Copy link
Contributor

@jade-guiton-dd jade-guiton-dd left a comment

Choose a reason for hiding this comment

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

LGTM on the OTel side

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/agent-apm trace-agent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants