Add otel-agent status subcommand #33556

liustanley · 2025-01-29T20:36:11Z

What does this PR do?

Adds status subcommand for otel-agent. This PR reuses the functionality introduced in #32938 in order to print the otel-agent status with the following command:

❯ ./bin/otel-agent/otel-agent status --config test/new-e2e/tests/otel/otel-agent/config/minimal.yml --core-config datadog.yaml
setting log level to: debug
==========
OTel Agent
==========

  Status: Running
  Agent Version: 7.64.0-devel+git.110.37b6bce 
  Collector Version: v0.118.0 

  Receiver
  ==========================
    Spans Accepted: 0
    Metric Points Accepted: 404
    Log Records Accepted: 0

  Exporter
  ==========================
    Spans Sent: 0
    Metric Points Sent: 404
    Log Records Sent: 0

Motivation

OTAGENT-224

Describe how you validated your changes

Run otel-agent and core agent side by side, and run ./bin/otel-agent/otel-agent status --config test/new-e2e/tests/otel/otel-agent/config/minimal.yml --core-config datadog.yaml

Possible Drawbacks / Trade-offs

Additional Notes

agent-platform-auto-pr · 2025-01-29T21:09:34Z

Uncompressed package size comparison

Comparison with ancestor 6397f9406756a2382f1868f09c190ebc96da59e4

Diff per package

package	diff	status	size	ancestor	threshold
datadog-agent-arm64-deb	0.00MB	✅	864.96MB	864.95MB	0.50MB
datadog-agent-aarch64-rpm	0.00MB	✅	874.68MB	874.67MB	0.50MB
datadog-heroku-agent-amd64-deb	0.00MB	✅	456.72MB	456.71MB	0.50MB
datadog-iot-agent-amd64-deb	0.00MB	✅	94.01MB	94.01MB	0.50MB
datadog-iot-agent-arm64-deb	0.00MB	✅	90.06MB	90.06MB	0.50MB
datadog-iot-agent-x86_64-rpm	0.00MB	✅	94.08MB	94.08MB	0.50MB
datadog-iot-agent-x86_64-suse	0.00MB	✅	94.08MB	94.08MB	0.50MB
datadog-iot-agent-aarch64-rpm	0.00MB	✅	90.13MB	90.13MB	0.50MB
datadog-agent-amd64-deb	0.00MB	✅	877.16MB	877.16MB	0.50MB
datadog-agent-x86_64-rpm	0.00MB	✅	886.89MB	886.89MB	0.50MB
datadog-agent-x86_64-suse	0.00MB	✅	886.89MB	886.89MB	0.50MB
datadog-dogstatsd-amd64-deb	0.00MB	✅	59.03MB	59.03MB	0.50MB
datadog-dogstatsd-x86_64-rpm	0.00MB	✅	59.11MB	59.11MB	0.50MB
datadog-dogstatsd-x86_64-suse	0.00MB	✅	59.11MB	59.11MB	0.50MB
datadog-dogstatsd-arm64-deb	0.00MB	✅	56.52MB	56.52MB	0.50MB

Decision

✅ Passed

agent-platform-auto-pr · 2025-01-29T21:11:18Z

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

Note: This applies to commit ed7673d

cit-pr-commenter · 2025-01-29T21:34:06Z

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: af9963b9-5972-4d7b-b4b5-d22cce0ee584

Baseline: 6397f94
Comparison: ed7673d
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	file_tree	memory utilization	+0.09	[+0.01, +0.16]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	+0.07	[-0.68, +0.82]	1	Logs
➖	file_to_blackhole_0ms_latency_http2	egress throughput	+0.01	[-0.88, +0.90]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	-0.00	[-0.02, +0.01]	1	Logs
➖	uds_dogstatsd_to_api	ingress throughput	-0.01	[-0.29, +0.27]	1	Logs
➖	file_to_blackhole_500ms_latency	egress throughput	-0.01	[-0.79, +0.77]	1	Logs
➖	file_to_blackhole_300ms_latency	egress throughput	-0.02	[-0.66, +0.61]	1	Logs
➖	quality_gate_idle_all_features	memory utilization	-0.04	[-0.11, +0.04]	1	Logs bounds checks dashboard
➖	file_to_blackhole_0ms_latency_http1	egress throughput	-0.04	[-0.88, +0.80]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	-0.11	[-0.89, +0.66]	1	Logs
➖	file_to_blackhole_1000ms_latency_linear_load	egress throughput	-0.13	[-0.60, +0.34]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	-0.16	[-0.99, +0.67]	1	Logs
➖	quality_gate_idle	memory utilization	-0.22	[-0.26, -0.18]	1	Logs bounds checks dashboard
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	-1.36	[-2.22, -0.49]	1	Logs
➖	tcp_syslog_to_blackhole	ingress throughput	-1.44	[-1.51, -1.38]	1	Logs
➖	quality_gate_logs	% cpu utilization	-1.77	[-4.79, +1.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:

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_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, 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.

mackjmr · 2025-02-04T09:22:54Z

cmd/otel-agent/subcommands/status/command.go

+
+const headerText = "==========\nOTel Agent\n==========\n"
+
+// MakeCommand returns a `version` command to be used by agent binaries.


Suggested change

// MakeCommand returns a `version` command to be used by agent binaries.

// MakeCommand returns a `status` command to be used by agent binaries.

mackjmr · 2025-02-04T09:26:11Z

cmd/otel-agent/subcommands/status/command.go

+			if err != nil && err != agentConfig.ErrNoDDExporter {
+				return err
+			}
+			uris := append(globalParams.ConfPaths, globalParams.Sets...)


It appears like the uris are a merge of globalParams.ConfPaths and globalParams.Sets here, whereas in the call to NewConfigComponent we only use globalParams.ConfPaths as the URIs, is this intended ? Can both contain collector config ?

mackjmr · 2025-02-04T09:29:10Z

cmd/otel-agent/subcommands/status/command_test.go

+// This product includes software developed at Datadog (https://www.datadoghq.com/).
+// Copyright 2025-present Datadog, Inc.
+
+package status


Do you think it's possible to add a test that checks the output of the status command ? e.g. a string comparison. Would be a good check that this outputs what is expected.

liustanley added 20 commits January 13, 2025 16:01

Add otel-agent status

3e334dd

Add test

cb9e8bb

Remove previous changes

cb462e0

WIP

0d189a5

Add text status

1b08f72

Add html status

9c53985

Clean up

dc5a823

lint components

369e77f

Fix lint

cbda996

PR comments

dcd2f59

Merge branch 'main' into stanley.liu/status

d2a1a3e

Fix test

fe8295b

Fix lint

4d6b5d0

Fix lint

df8a950

PR comments

7048dee

Merge branch 'main' into stanley.liu/status

dafc06a

Add break

55fb36b

Add otel-agent status subcommand

9a8d8f1

Fix lint

c81680d

Fix lint

37b6bce

Clean up PR

a43ecee

Base automatically changed from stanley.liu/status to main February 3, 2025 20:56

Merge branch 'main' into stanley.liu/status-otelagent

ed7673d

liustanley marked this pull request as ready for review February 3, 2025 21:03

liustanley requested review from a team as code owners February 3, 2025 21:03

liustanley requested a review from mackjmr February 3, 2025 21:03

github-actions bot added the team/opentelemetry OpenTelemetry team label Feb 3, 2025

liustanley removed the team/opentelemetry OpenTelemetry team label Feb 3, 2025

github-actions bot added the medium review PR review might take time label Feb 3, 2025

liustanley added changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation labels Feb 3, 2025

liustanley added this to the 7.64.0 milestone Feb 3, 2025

mackjmr reviewed Feb 4, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add otel-agent status subcommand #33556

Add otel-agent status subcommand #33556

liustanley commented Jan 29, 2025 •

edited

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading

Fine details of change detection per experiment

Bounds Checks: ✅ Passed

Explanation

mackjmr Feb 4, 2025

mackjmr Feb 4, 2025

mackjmr Feb 4, 2025


		const headerText = "==========\nOTel Agent\n==========\n"

		// MakeCommand returns a `version` command to be used by agent binaries.

	// MakeCommand returns a `version` command to be used by agent binaries.
	// MakeCommand returns a `status` command to be used by agent binaries.

Add otel-agent status subcommand #33556

Are you sure you want to change the base?

Add otel-agent status subcommand #33556

Conversation

liustanley commented Jan 29, 2025 • edited Loading

What does this PR do?

Motivation

Describe how you validated your changes

Possible Drawbacks / Trade-offs

Additional Notes

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

Uncompressed package size comparison

Decision

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

Test changes on VM

cit-pr-commenter bot commented Jan 29, 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

mackjmr Feb 4, 2025

Choose a reason for hiding this comment

mackjmr Feb 4, 2025

Choose a reason for hiding this comment

mackjmr Feb 4, 2025

Choose a reason for hiding this comment

liustanley commented Jan 29, 2025 •

edited

Loading

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

edited

Loading

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

edited

Loading

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

edited

Loading