[OTEL-2099] Add obfuscator option to OTel Stats Utils #32750

jackgopack4 · 2025-01-07T20:28:17Z

What does this PR do?

Refactors slightly the obfuscateSpan logic to break out SQL and Redis functions
Adds option to pass an obfuscator object to OTel Stats utils
If obfuscator is passed to OTel Stats utils, obfuscate SQL and redis spans prior to sending to concentrator for stats payload calculation

Motivation

https://datadoghq.atlassian.net/browse/OTEL-2099

Describe how you validated your changes

Ran benchmark tests and added comparison tests for "with obfuscation", results here (increase overhead by only about 2%): https://docs.google.com/spreadsheets/d/1ywVfwlHLeghxhfnDwGaXuGmYNs7CaLiuBa2I9vNjA30

Otherwise, existing tests.

Possible Drawbacks / Trade-offs

I'm not entirely sold on having obfuscate functions in pkg/trace/transform, but I couldn't import pkg/trace/agent in pkg/trace/transform or pkg/trace/stats without causing a circular dependency.

Additional Notes

cit-pr-commenter · 2025-01-07T21:18:08Z

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 88c5f6df-3376-47ab-87ef-e586c77f5316

Baseline: ab830a6
Comparison: d2c3cc7
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	quality_gate_logs	% cpu utilization	+3.90	[+0.60, +7.20]	1	Logs
➖	quality_gate_idle_all_features	memory utilization	+0.40	[+0.31, +0.49]	1	Logs bounds checks dashboard
➖	quality_gate_idle	memory utilization	+0.27	[+0.24, +0.31]	1	Logs bounds checks dashboard
➖	file_tree	memory utilization	+0.23	[+0.09, +0.36]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	+0.21	[-0.58, +0.99]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	+0.05	[-0.82, +0.92]	1	Logs
➖	file_to_blackhole_1000ms_latency_linear_load	egress throughput	+0.04	[-0.42, +0.51]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	+0.01	[-0.63, +0.66]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	+0.01	[-0.01, +0.02]	1	Logs
➖	uds_dogstatsd_to_api	ingress throughput	+0.00	[-0.12, +0.12]	1	Logs
➖	file_to_blackhole_0ms_latency_http2	egress throughput	-0.00	[-0.75, +0.75]	1	Logs
➖	file_to_blackhole_300ms_latency	egress throughput	-0.02	[-0.65, +0.62]	1	Logs
➖	file_to_blackhole_0ms_latency_http1	egress throughput	-0.05	[-0.87, +0.77]	1	Logs
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	-0.19	[-0.86, +0.49]	1	Logs
➖	file_to_blackhole_500ms_latency	egress throughput	-0.21	[-0.99, +0.58]	1	Logs
➖	tcp_syslog_to_blackhole	ingress throughput	-0.23	[-0.30, -0.17]	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	memory_usage	10/10	bounds checks dashboard
✅	quality_gate_idle_all_features	memory_usage	10/10	bounds checks dashboard
✅	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_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_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.

agent-platform-auto-pr · 2025-01-07T22:48:39Z

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

Note: This applies to commit d2c3cc7

agent-platform-auto-pr · 2025-01-07T22:50:31Z

Uncompressed package size comparison

Comparison with ancestor b97c90616b68239053e33f46f4db6900f2c59f4a

Diff per package

package	diff	status	size	ancestor	threshold
datadog-dogstatsd-arm64-deb	2.29MB	❌	56.14MB	53.85MB	0.50MB
datadog-iot-agent-x86_64-rpm	0.92MB	❌	113.89MB	112.97MB	0.50MB
datadog-iot-agent-x86_64-suse	0.92MB	❌	113.89MB	112.97MB	0.50MB
datadog-iot-agent-amd64-deb	0.92MB	❌	113.82MB	112.90MB	0.50MB
datadog-iot-agent-aarch64-rpm	0.72MB	❌	109.33MB	108.61MB	0.50MB
datadog-iot-agent-arm64-deb	0.72MB	❌	109.26MB	108.54MB	0.50MB
datadog-heroku-agent-amd64-deb	-0.38MB	✅	506.18MB	506.56MB	0.50MB
datadog-dogstatsd-x86_64-rpm	-17.52MB	✅	58.71MB	76.22MB	0.50MB
datadog-dogstatsd-x86_64-suse	-17.52MB	✅	58.71MB	76.22MB	0.50MB
datadog-dogstatsd-amd64-deb	-17.52MB	✅	58.63MB	76.15MB	0.50MB
datadog-agent-aarch64-rpm	-56.58MB	✅	950.25MB	1006.83MB	0.50MB
datadog-agent-arm64-deb	-56.71MB	✅	940.95MB	997.66MB	0.50MB
datadog-agent-x86_64-rpm	-261.68MB	✅	1020.91MB	1282.59MB	0.50MB
datadog-agent-x86_64-suse	-261.68MB	✅	1020.91MB	1282.59MB	0.50MB
datadog-agent-amd64-deb	-261.81MB	✅	1011.59MB	1273.40MB	0.50MB

Decision

❌ Failed

songy23 · 2025-01-08T15:55:15Z

pkg/trace/stats/oteltest/otel_apm_stats_comparison_test.go

+	oconf := tcfg.Obfuscation.Export(tcfg)
+	oconf.Statsd = metricsClient
+	var obfuscator *obfuscate.Obfuscator
+	if enableObfuscation {


In this file if you want to test obfuscation, you need to modify getTestTraces to have SQL queries.

still running into the resource and operation name issues that we are not creating datadog spans in the format that pkg/obfuscate expects

Use resource.name span.type operation.name for now. You may want to work with @IbraheemA to include the proper mapping in resource name V2

see https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/35401/files#diff-4dafdeae831cd5b12c8ee6bff8f7395408192bdc568549fba904e1142f6e58daR274-R276

pkg/trace/stats/otel_util.go

songy23 · 2025-01-08T15:59:22Z

pkg/trace/stats/otel_util_test.go

+	testProcessOTLPTraces(t, false)
+}
+
+func TestProcessOTLPTraces_WithObfuscation(t *testing.T) {
+	testProcessOTLPTraces(t, true)
+}
+
+func testProcessOTLPTraces(t *testing.T, enableObfuscation bool) {


IMO you don't need all these, and right now there is no real test on obfuscation. Just add more cases to TestProcessOTLPTraces like

... { name: "obfuscate sql", ... enableObfuscation: true, }, { name: "obfuscate redis", ... enableObfuscation: true, }

thanks, will make that change

songy23 · 2025-01-08T16:03:20Z

pkg/trace/stats/otel_benckmark_test.go

 func BenchmarkOTelContainerTags(b *testing.B) {
+	benchmarkOTelContainerTags(b, false)
+}
+
+func BenchmarkOTelContainerTags_WithObfuscation(b *testing.B) {
+	benchmarkOTelContainerTags(b, true)
+}
+
+func benchmarkOTelContainerTags(b *testing.B, enableObfuscation bool) {


These tests do not have any sql queries so obfuscation is just no-op. You will want to write a new benchmark on DB spans with sql queries.

songy23 · 2025-01-08T16:03:29Z

pkg/trace/stats/otel_benckmark_test.go

 func BenchmarkOTelPeerTags(b *testing.B) {
-	benchmarkOTelPeerTags(b, true)
+	benchmarkOTelPeerTags(b, true, false)
+}
+
+func BenchmarkOTelPeerTags_WithObfuscation(b *testing.B) {
+	benchmarkOTelPeerTags(b, true, true)


…obfuscation connector otel utils

jackgopack4 force-pushed the jackgopack4/OTEL-2099-add-obfuscation-stats-payloads branch from 37509a2 to fe84fd7 Compare January 7, 2025 20:28

github-actions bot added medium review PR review might take time team/agent-apm trace-agent labels Jan 7, 2025

jackgopack4 added changelog/no-changelog qa/done QA done before merge and regressions are covered by tests and removed team/agent-apm trace-agent medium review PR review might take time labels Jan 7, 2025

github-actions bot added the medium review PR review might take time label Jan 7, 2025

jackgopack4 marked this pull request as ready for review January 8, 2025 15:10

jackgopack4 requested review from a team as code owners January 8, 2025 15:10

jackgopack4 requested a review from songy23 January 8, 2025 15:10

songy23 reviewed Jan 8, 2025

View reviewed changes

songy23 added the team/opentelemetry OpenTelemetry team label Jan 8, 2025

songy23 added this to the 7.63.0 milestone Jan 8, 2025

jackgopack4 added 5 commits January 8, 2025 16:22

move obfuscate code to transform for OTEL and add framework for span …

0e1ee6e

…obfuscation connector otel utils

add obfuscateSpanForConcentrator function to otel_utils

ac3146e

add obfuscation to benchmark tests

3564827

add obfuscation method to OTLPTracesToConcentratorInputs

560db52

refactor OTLPTracesToConcentratorInputs

d2c3cc7

jackgopack4 force-pushed the jackgopack4/OTEL-2099-add-obfuscation-stats-payloads branch from cfaeb82 to d2c3cc7 Compare January 8, 2025 16:26

songy23 mentioned this pull request Jan 8, 2025

[connector/datadog] Support obfuscating sql queries in APM stats open-telemetry/opentelemetry-collector-contrib#35401

Closed

github-actions bot added long review PR is complex, plan time to review it and removed medium review PR review might take time labels Jan 8, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[OTEL-2099] Add obfuscator option to OTel Stats Utils #32750

[OTEL-2099] Add obfuscator option to OTel Stats Utils #32750

jackgopack4 commented Jan 7, 2025

cit-pr-commenter bot commented Jan 7, 2025 •

edited

Loading

Fine details of change detection per experiment

Bounds Checks: ✅ Passed

Explanation

agent-platform-auto-pr bot commented Jan 7, 2025 •

edited

Loading

agent-platform-auto-pr bot commented Jan 7, 2025 •

edited

Loading

songy23 Jan 8, 2025

jackgopack4 Jan 8, 2025

songy23 Jan 8, 2025

songy23 Jan 8, 2025

songy23 Jan 8, 2025

jackgopack4 Jan 8, 2025

songy23 Jan 8, 2025

songy23 Jan 8, 2025

[OTEL-2099] Add obfuscator option to OTel Stats Utils #32750

Are you sure you want to change the base?

[OTEL-2099] Add obfuscator option to OTel Stats Utils #32750

Conversation

jackgopack4 commented Jan 7, 2025

What does this PR do?

Motivation

Describe how you validated your changes

Possible Drawbacks / Trade-offs

Additional Notes

cit-pr-commenter bot commented Jan 7, 2025 • edited Loading

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 Jan 7, 2025 • edited Loading

Test changes on VM

agent-platform-auto-pr bot commented Jan 7, 2025 • edited Loading

Uncompressed package size comparison

Decision

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cit-pr-commenter bot commented Jan 7, 2025 •

edited

Loading

agent-platform-auto-pr bot commented Jan 7, 2025 •

edited

Loading

agent-platform-auto-pr bot commented Jan 7, 2025 •

edited

Loading