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

Merged
merged 6 commits into from
Mar 3, 2025

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

Note: This applies to commit 0ee8482

@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: 4de6c4ea-407b-4815-892a-bfd7ef5e624b

Baseline: fbecaa3
Comparison: 0ee8482
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
file_to_blackhole_500ms_latency egress throughput +0.04 [-0.75, +0.82] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.02 [-0.27, +0.31] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.02 [-0.66, +0.70] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.01 [-0.61, +0.64] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.02, +0.03] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.00 [-0.85, +0.86] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.00 [-0.80, +0.80] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.01 [-0.80, +0.77] 1 Logs
quality_gate_idle_all_features memory utilization -0.02 [-0.07, +0.04] 1 Logs bounds checks dashboard
tcp_syslog_to_blackhole ingress throughput -0.10 [-0.17, -0.04] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.24 [-0.71, +0.22] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.31 [-1.09, +0.47] 1 Logs
quality_gate_idle memory utilization -0.41 [-0.45, -0.38] 1 Logs bounds checks dashboard
file_tree memory utilization -0.75 [-0.81, -0.68] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -0.75 [-1.64, +0.13] 1 Logs
quality_gate_logs % cpu utilization -2.61 [-5.47, +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:

  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 memory_usage: 10/10 replicas passed. Gate 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_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 intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 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 fbecaa3d2b3b9f3fd66ae2cea6a839c9a7a46e3c

Size reduction summary
package diff status size ancestor threshold
datadog-agent-aarch64-rpm -0.00MB 816.13MB 816.13MB 0.50MB
datadog-agent-x86_64-rpm -0.00MB 825.18MB 825.18MB 0.50MB
datadog-agent-x86_64-suse -0.00MB 825.18MB 825.18MB 0.50MB
datadog-agent-amd64-deb -0.00MB 815.38MB 815.38MB 0.50MB
Diff per package
package diff status size ancestor threshold
datadog-agent-arm64-deb 0.00MB 806.35MB 806.35MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 39.43MB 39.43MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 39.51MB 39.51MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 39.51MB 39.51MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 37.97MB 37.97MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 440.69MB 440.69MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.11MB 62.11MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.18MB 62.18MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.18MB 62.18MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.35MB 59.35MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.42MB 59.42MB 0.50MB

Decision

✅ Passed

@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

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.97MiB 801.8MiB 192.3MiB 202.62MiB
static_quality_gate_agent_deb_arm64 780.45MiB 793.14MiB 174.3MiB 184.51MiB
static_quality_gate_agent_rpm_amd64 789.02MiB 801.79MiB 194.34MiB 205.03MiB
static_quality_gate_agent_rpm_arm64 780.41MiB 793.09MiB 175.84MiB 186.44MiB
static_quality_gate_agent_suse_amd64 788.97MiB 801.81MiB 194.34MiB 205.03MiB
static_quality_gate_agent_suse_arm64 780.48MiB 793.14MiB 175.84MiB 186.44MiB
static_quality_gate_dogstatsd_deb_amd64 37.68MiB 47.67MiB 9.78MiB 19.78MiB
static_quality_gate_dogstatsd_deb_arm64 36.29MiB 46.27MiB 8.49MiB 18.49MiB
static_quality_gate_dogstatsd_rpm_amd64 37.68MiB 47.67MiB 9.79MiB 19.79MiB
static_quality_gate_dogstatsd_suse_amd64 37.68MiB 47.67MiB 9.79MiB 19.79MiB
static_quality_gate_iot_agent_deb_amd64 59.31MiB 69.0MiB 14.9MiB 24.8MiB
static_quality_gate_iot_agent_deb_arm64 56.67MiB 66.4MiB 12.86MiB 22.8MiB
static_quality_gate_iot_agent_rpm_amd64 59.31MiB 69.0MiB 14.92MiB 24.8MiB
static_quality_gate_iot_agent_rpm_arm64 56.67MiB 66.4MiB 12.86MiB 22.8MiB
static_quality_gate_iot_agent_suse_amd64 59.31MiB 69.0MiB 14.92MiB 24.8MiB
static_quality_gate_docker_agent_amd64 873.76MiB 886.12MiB 293.91MiB 304.21MiB
static_quality_gate_docker_agent_arm64 888.41MiB 900.79MiB 280.15MiB 290.47MiB
static_quality_gate_docker_agent_jmx_amd64 1.05GiB 1.06GiB 369.04MiB 379.33MiB
static_quality_gate_docker_agent_jmx_arm64 1.05GiB 1.06GiB 351.26MiB 361.55MiB
static_quality_gate_docker_dogstatsd_amd64 45.83MiB 55.78MiB 17.29MiB 27.28MiB
static_quality_gate_docker_dogstatsd_arm64 44.47MiB 54.45MiB 16.17MiB 26.16MiB
static_quality_gate_docker_cluster_agent_amd64 265.01MiB 274.78MiB 106.38MiB 116.28MiB
static_quality_gate_docker_cluster_agent_arm64 280.98MiB 290.82MiB 101.21MiB 111.12MiB

Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>
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

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

Copy link
Member

@truthbk truthbk left a comment

Choose a reason for hiding this comment

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

ship it! :shipit:

@ajgajg1134
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Feb 28, 2025

View all feedbacks in Devflow UI.
2025-02-28 14:12:36 UTC ℹ️ Start processing command /merge


2025-02-28 14:12:41 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-28 18:13:04 UTC ⚠️ MergeQueue: This merge request was unqueued

devflow unqueued this merge request: It did not become mergeable within the expected time

@ajgajg1134
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Mar 3, 2025

View all feedbacks in Devflow UI.
2025-03-03 19:38:52 UTC ℹ️ Start processing command /merge


2025-03-03 19:38:57 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-03-03 20:04:09 UTC ℹ️ MergeQueue: merge request added to the queue

The median merge time in main is 32m.


2025-03-03 20:28:13 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 78c8d30 into main Mar 3, 2025
230 of 240 checks passed
@dd-mergequeue dd-mergequeue bot deleted the andrew.glaude/statsObfuscation branch March 3, 2025 20:28
@github-actions github-actions bot added this to the 7.65.0 milestone Mar 3, 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/agent-apm trace-agent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants