Adding schema to OTLP config #32010

hush-hush · 2024-12-11T12:59:54Z

What does this PR do?

As we deprecate SetKnown and move toward building a schema for the config we need to explicitly list what settings the agent support and thei default.

This also fix an indentation error in the config template

Describe how you validated your changes

Running CI for unit tests and asking the OTLP team to QA this for any edge case (since their might be undocumented settings that are used).

agent-platform-auto-pr · 2024-12-11T13:50:02Z

Package size comparison

Comparison with ancestor 98d1e0ecd1e7440a19a3277949acb3e6a02089ee

Diff per package

package	diff	status	size	ancestor	threshold
datadog-agent-amd64-deb	0.00MB	⚠️	1268.86MB	1268.86MB	140.00MB
datadog-iot-agent-amd64-deb	0.00MB	✅	113.28MB	113.28MB	10.00MB
datadog-dogstatsd-amd64-deb	0.00MB	✅	78.52MB	78.52MB	10.00MB
datadog-heroku-agent-amd64-deb	0.00MB	✅	505.42MB	505.42MB	70.00MB
datadog-agent-x86_64-rpm	0.00MB	⚠️	1278.09MB	1278.09MB	140.00MB
datadog-agent-x86_64-suse	0.00MB	⚠️	1278.09MB	1278.09MB	140.00MB
datadog-iot-agent-x86_64-rpm	-0.00MB	✅	113.35MB	113.35MB	10.00MB
datadog-iot-agent-x86_64-suse	-0.00MB	✅	113.35MB	113.35MB	10.00MB
datadog-dogstatsd-x86_64-rpm	0.00MB	⚠️	78.59MB	78.59MB	10.00MB
datadog-dogstatsd-x86_64-suse	0.00MB	⚠️	78.59MB	78.59MB	10.00MB
datadog-agent-arm64-deb	0.00MB	✅	1003.94MB	1003.94MB	140.00MB
datadog-iot-agent-arm64-deb	0.00MB	✅	108.76MB	108.76MB	10.00MB
datadog-dogstatsd-arm64-deb	0.00MB	✅	55.74MB	55.74MB	10.00MB
datadog-agent-aarch64-rpm	0.00MB	⚠️	1013.15MB	1013.15MB	140.00MB
datadog-iot-agent-aarch64-rpm	0.00MB	⚠️	108.83MB	108.83MB	10.00MB

Decision

⚠️ Warning

agent-platform-auto-pr · 2024-12-11T13:50:32Z

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

Note: This applies to commit 4dedc51

cit-pr-commenter · 2024-12-11T14:20:39Z

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: b073ae5f-bad9-4142-8204-7606afe38123

Baseline: 98d1e0e
Comparison: 4dedc51
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	quality_gate_idle_all_features	memory utilization	+1.41	[+1.29, +1.54]	1	Logs bounds checks dashboard
➖	otel_to_otel_logs	ingress throughput	+1.29	[+0.63, +1.95]	1	Logs
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	+0.52	[-0.22, +1.25]	1	Logs
➖	file_tree	memory utilization	+0.38	[+0.26, +0.51]	1	Logs
➖	tcp_syslog_to_blackhole	ingress throughput	+0.37	[+0.31, +0.43]	1	Logs
➖	file_to_blackhole_500ms_latency	egress throughput	+0.21	[-0.55, +0.98]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	+0.13	[-0.59, +0.85]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	+0.08	[-0.70, +0.86]	1	Logs
➖	quality_gate_idle	memory utilization	+0.06	[+0.00, +0.11]	1	Logs bounds checks dashboard
➖	file_to_blackhole_300ms_latency	egress throughput	+0.05	[-0.58, +0.68]	1	Logs
➖	file_to_blackhole_0ms_latency_http1	egress throughput	+0.04	[-0.87, +0.95]	1	Logs
➖	uds_dogstatsd_to_api	ingress throughput	+0.02	[-0.07, +0.11]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	+0.00	[-0.01, +0.02]	1	Logs
➖	file_to_blackhole_0ms_latency_http2	egress throughput	-0.02	[-0.85, +0.80]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	-0.06	[-0.82, +0.70]	1	Logs
➖	file_to_blackhole_1000ms_latency_linear_load	egress throughput	-0.19	[-0.66, +0.27]	1	Logs
➖	quality_gate_logs	% cpu utilization	-0.44	[-3.38, +2.51]	1	Logs

Bounds Checks: ❌ Failed

perf	experiment	bounds_check_name	replicates_passed	links
❌	file_to_blackhole_0ms_latency_http1	lost_bytes	9/10
✅	file_to_blackhole_0ms_latency	lost_bytes	10/10
✅	file_to_blackhole_0ms_latency	memory_usage	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_all_features, 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, bounds check memory_usage: 10/10 replicas passed. Gate passed.

GustavoCaso · 2024-12-13T08:25:37Z

pkg/config/setup/apm.go

@@ -56,7 +56,7 @@ func setupAPM(config pkgconfigmodel.Setup) {
 	config.SetKnown("apm_config.service_writer.queue_size")
 	config.SetKnown("apm_config.stats_writer.connection_limit")
 	config.SetKnown("apm_config.stats_writer.queue_size")
-	config.SetKnown("apm_config.analyzed_rate_by_service.*")


As we deprecate SetKnown and move toward building a schema for the config we need to explicitly list what settings the agent support and thei default. This also fix an indentation error in the config template

liustanley · 2024-12-17T21:12:17Z

pkg/config/setup/otlp.go

+	config.BindEnv("otlp_config.grpc_port") // TODO OTLP team: add default value
+	config.BindEnv("otlp_config.http_port") // TODO OTLP team: add default value


I don't believe these are valid config values, but will check with my team

liustanley · 2024-12-17T21:13:37Z

pkg/config/setup/otlp.go


 	// NOTE: This only partially works.
 	// The environment variable is also manually checked in comp/otelcol/otlp/config.go
-	config.BindEnvAndSetDefault(OTLPTagCardinalityKey, "low", "DD_OTLP_TAG_CARDINALITY")
+	config.BindEnvAndSetDefault("otlp_config.metrics.tag_cardinality", "low", "DD_OTLP_TAG_CARDINALITY")


Is there a reason for removing the OTLPTagCardinalityKey constant (and the others in this file)?

It makes it very hard to grep and find definition for a setting. using the full key is also what every other teams in the agent uses.

liustanley · 2024-12-17T21:30:27Z

pkg/config/setup/otlp.go

-	OTLPLogsSubSectionKey     = "logs"
-	OTLPLogsEnabled           = OTLPSection + "." + OTLPLogsSubSectionKey + ".enabled"
+	OTLPTracePort             = OTLPSection + ".traces.internal_port"
+	OTLPTracesEnabled         = OTLPSection + ".traces.enabled"


Is there a reason why we're not using these constants below?

liustanley · 2024-12-17T21:33:32Z

pkg/config/setup/otlp.go

+	config.BindEnv("otlp_config.receiver.protocols.grpc.write_buffer_size")                     // TODO OTLP team: add default value
+	config.BindEnv("otlp_config.receiver.protocols.grpc.include_metadata")                      // TODO OTLP team: add default value
+	config.BindEnv("otlp_config.receiver.protocols.grpc.max_concurrent_streams")                // TODO OTLP team: add default value
+	config.BindEnv("otlp_config.receiver.protocols.grpc.keepalive.enforcement_policy.min_time") // TODO OTLP team: add default value


I don't think this config option is currently documented because it's an option on the OTLP receiver, but there are other config options on the OTLP receiver that aren't documented here. What's the reason for including this one in particular?

All the new setting where found by running the agent and dumping the configuration keys. Could it be possible that you merge the receiver configuration in the datadog config object at some point ?

dineshg13 · 2024-12-18T20:58:04Z

pkg/config/setup/otlp.go

+	config.BindEnv("otlp_config.receiver.protocols.grpc.endpoint")                              // TODO OTLP team: add default value
+	config.BindEnv("otlp_config.receiver.protocols.grpc.transport")                             // TODO OTLP team: add default value
+	config.BindEnv("otlp_config.receiver.protocols.grpc.max_recv_msg_size_mib")                 // TODO OTLP team: add default value
+	config.BindEnv("otlp_config.receiver.protocols.grpc.read_buffer_size")                      // TODO OTLP team: add default value
+	config.BindEnv("otlp_config.receiver.protocols.grpc.write_buffer_size")                     // TODO OTLP team: add default value


We found an issue with Viper, where if we set a default value , it enables OTLP ingest. Is there a need for setting default values ?

Viper doesn't offer a way to differentiate settings at their default and configured by the user. We're introducing IsConfigured to facilitate this (#31974).

This will make it possible to have a default for all setting at some point.

hush-hush requested review from a team as code owners December 11, 2024 12:59

hush-hush requested review from GustavoCaso, a team and liustanley and removed request for a team December 11, 2024 12:59

hush-hush added changelog/no-changelog team/agent-shared-components qa/rc-required Only for a PR that requires validation on the Release Candidate labels Dec 11, 2024

hush-hush force-pushed the maxime/remove-setknown-with-star branch from f231f99 to fbc7e8f Compare December 11, 2024 13:21

hush-hush force-pushed the maxime/add-schema-to-otlp-conf branch from f54a059 to e2dce22 Compare December 11, 2024 13:22

hush-hush force-pushed the maxime/add-schema-to-otlp-conf branch 2 times, most recently from d4bd24e to fc37887 Compare December 11, 2024 16:36

janine-c approved these changes Dec 11, 2024

View reviewed changes

hush-hush force-pushed the maxime/remove-setknown-with-star branch from fbc7e8f to b26b3ce Compare December 12, 2024 14:01

GustavoCaso reviewed Dec 13, 2024

View reviewed changes

GustavoCaso approved these changes Dec 13, 2024

View reviewed changes

Base automatically changed from maxime/remove-setknown-with-star to main December 13, 2024 11:37

Adding schema to OTLP config

4dedc51

As we deprecate SetKnown and move toward building a schema for the config we need to explicitly list what settings the agent support and thei default. This also fix an indentation error in the config template

hush-hush force-pushed the maxime/add-schema-to-otlp-conf branch from fc37887 to 4dedc51 Compare December 13, 2024 12:11

github-actions bot added the medium review PR review might take time label Dec 13, 2024

liustanley reviewed Dec 17, 2024

View reviewed changes

dineshg13 reviewed Dec 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding schema to OTLP config #32010

Adding schema to OTLP config #32010

hush-hush commented Dec 11, 2024 •

edited

Loading

agent-platform-auto-pr bot commented Dec 11, 2024 •

edited

Loading

agent-platform-auto-pr bot commented Dec 11, 2024 •

edited

Loading

cit-pr-commenter bot commented Dec 11, 2024 •

edited

Loading

Fine details of change detection per experiment

Explanation

GustavoCaso Dec 13, 2024

liustanley Dec 17, 2024

liustanley Dec 17, 2024

hush-hush Dec 19, 2024

liustanley Dec 17, 2024

liustanley Dec 17, 2024 •

edited

Loading

hush-hush Dec 19, 2024

dineshg13 Dec 18, 2024

hush-hush Dec 19, 2024

		config.BindEnv("otlp_config.grpc_port") // TODO OTLP team: add default value
		config.BindEnv("otlp_config.http_port") // TODO OTLP team: add default value

Adding schema to OTLP config #32010

Are you sure you want to change the base?

Adding schema to OTLP config #32010

Conversation

hush-hush commented Dec 11, 2024 • edited Loading

What does this PR do?

Describe how you validated your changes

agent-platform-auto-pr bot commented Dec 11, 2024 • edited Loading

Package size comparison

Decision

agent-platform-auto-pr bot commented Dec 11, 2024 • edited Loading

Test changes on VM

cit-pr-commenter bot commented Dec 11, 2024 • edited Loading

Regression Detector

Regression Detector Results

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

Bounds Checks: ❌ Failed

Explanation

CI Pass/Fail 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

liustanley Dec 17, 2024 • edited Loading

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

hush-hush commented Dec 11, 2024 •

edited

Loading

agent-platform-auto-pr bot commented Dec 11, 2024 •

edited

Loading

agent-platform-auto-pr bot commented Dec 11, 2024 •

edited

Loading

cit-pr-commenter bot commented Dec 11, 2024 •

edited

Loading

liustanley Dec 17, 2024 •

edited

Loading