[AGNTLOG-56 ] Create Auditor Component #33680

soberpeach · 2025-02-03T21:36:23Z

What does this PR do?

This is the first a series of PRs that will migrate the auditor to a component. This is the first PR and focuses only on creating the auditor component.

Subsequent PRs will handle:

Integrating the new auditor component into the codebase, this would involve replacing instances of the existing auditor in pkg/logs/auditor with the new component this PR creates
- This could be done incrementally, starting with the base agent and then expanding to serverless, etc.
Adding functionality for the auditor to mitigate memory leaks in Fargate.
Removing the old auditor from the codebase.

Motivation

This change is a part of addressing a memory leak in ECS Fargate, as well as a a part of a more general push to move more parts of the agent to components.

Describe how you validated your changes

This change purely adds the auditor component, and doesn't do anything with it, later changes will deal with replacing the old auditor in pkg/logs and ensuring functionality is consistent.

The unit tests from the old auditor have also been ported over and ensure identical functionality of the component.

Possible Drawbacks / Trade-offs

Additional Notes

agent-platform-auto-pr · 2025-02-03T22:28:35Z

Uncompressed package size comparison

Comparison with ancestor e305652b1fe275fb27009d4e6153cacecb503ae4

Diff per package

package	diff	status	size	ancestor	threshold
datadog-agent-amd64-deb	0.00MB	✅	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-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-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-iot-agent-arm64-deb	0.00MB	✅	82.74MB	82.74MB	0.50MB
datadog-iot-agent-aarch64-rpm	0.00MB	✅	82.81MB	82.81MB	0.50MB
datadog-agent-aarch64-rpm	-0.00MB	✅	871.26MB	871.26MB	0.50MB

Decision

✅ Passed

agent-platform-auto-pr · 2025-02-03T22:29:19Z

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

Note: This applies to commit dffe553

cit-pr-commenter · 2025-02-03T22:55:27Z

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: b5f834ee-3721-41b2-a30c-5d0462b04bee

Baseline: e305652
Comparison: dffe553
Diff

Optimization Goals: ✅ Improvement(s) detected

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
✅	quality_gate_logs	% cpu utilization	-6.42	[-9.42, -3.42]	1	Logs

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI	trials	links
➖	uds_dogstatsd_to_api_cpu	% cpu utilization	+1.30	[+0.42, +2.17]	1	Logs
➖	file_tree	memory utilization	+0.35	[+0.28, +0.42]	1	Logs
➖	file_to_blackhole_1000ms_latency_linear_load	egress throughput	+0.29	[-0.18, +0.76]	1	Logs
➖	file_to_blackhole_0ms_latency_http2	egress throughput	+0.06	[-0.87, +0.99]	1	Logs
➖	file_to_blackhole_500ms_latency	egress throughput	+0.05	[-0.73, +0.84]	1	Logs
➖	file_to_blackhole_0ms_latency	egress throughput	+0.05	[-0.88, +0.97]	1	Logs
➖	file_to_blackhole_300ms_latency	egress throughput	+0.03	[-0.61, +0.68]	1	Logs
➖	file_to_blackhole_100ms_latency	egress throughput	+0.01	[-0.65, +0.66]	1	Logs
➖	tcp_dd_logs_filter_exclude	ingress throughput	+0.00	[-0.02, +0.03]	1	Logs
➖	uds_dogstatsd_to_api	ingress throughput	+0.00	[-0.27, +0.27]	1	Logs
➖	quality_gate_idle	memory utilization	+0.00	[-0.05, +0.06]	1	Logs bounds checks dashboard
➖	file_to_blackhole_0ms_latency_http1	egress throughput	-0.01	[-0.86, +0.84]	1	Logs
➖	quality_gate_idle_all_features	memory utilization	-0.03	[-0.09, +0.04]	1	Logs bounds checks dashboard
➖	tcp_syslog_to_blackhole	ingress throughput	-0.49	[-0.61, -0.38]	1	Logs
➖	file_to_blackhole_1000ms_latency	egress throughput	-0.83	[-1.61, -0.05]	1	Logs
✅	quality_gate_logs	% cpu utilization	-6.42	[-9.42, -3.42]	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_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.
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_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.

gh123man · 2025-02-05T14:35:50Z

IMO if we are introducing new code, we should introduce new tests with it.
Is it possible to include the related UTs in this PR?

I assume you have a plan for this (tests, and replacing the existing code), could you add more details about your plan for future PRs to the description?

agent-platform-auto-pr · 2025-02-05T21:10:51Z

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	844.51MiB	858.45MiB	203.54MiB	214.3MiB
✅	static_quality_gate_docker_agent_amd64	929.32MiB	942.69MiB	310.72MiB	321.56MiB

gh123man

Just some minor comments

comp/logs/auditor/impl-none/auditor_noop.go

comp/logs/auditor/impl/auditor_test.go

comp/logs/auditor/impl/api_v0.go

1. Closed channel in the noop auditor 2. Refactored the auditor constructor to two public and private constructors so the private constructor can be used in tests. 3. Removed extraneous TODO from old api_v0

soberpeach · 2025-02-10T21:23:27Z

/merge

dd-devflow · 2025-02-10T21:23:33Z

Devflow running: `/merge`

View all feedbacks in Devflow UI.

2025-02-10 21:23:32 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 31m.

2025-02-10 21:49:41 UTC ℹ️ MergeQueue: This merge request was merged

soberpeach requested a review from a team as a code owner February 3, 2025 21:36

github-actions bot added team/agent-log-pipelines long review PR is complex, plan time to review it labels Feb 3, 2025

soberpeach marked this pull request as draft February 3, 2025 21:37

soberpeach added changelog/no-changelog qa/done QA done before merge and regressions are covered by tests labels Feb 3, 2025

soberpeach force-pushed the lucas.liseth/create-auditor-component branch from 4b90d31 to ccf00c8 Compare February 3, 2025 21:50

Create auditor component

c2c0cfc

soberpeach force-pushed the lucas.liseth/create-auditor-component branch from ccf00c8 to c2c0cfc Compare February 3, 2025 22:02

soberpeach added this to the 7.64.0 milestone Feb 3, 2025

soberpeach marked this pull request as ready for review February 3, 2025 22:29

soberpeach requested a review from a team as a code owner February 3, 2025 22:29

soberpeach requested a review from jose-manuel-almaza February 3, 2025 22:29

jose-manuel-almaza approved these changes Feb 5, 2025

View reviewed changes

soberpeach marked this pull request as draft February 5, 2025 19:43

soberpeach and others added 3 commits February 5, 2025 15:24

Fixed public function comment

f600ad2

Added testing for auditor component

3ff8f40

Merge branch 'main' into lucas.liseth/create-auditor-component

5efffab

soberpeach marked this pull request as ready for review February 5, 2025 20:25

Migrate api tests to component implementation

572f975

gh123man requested changes Feb 5, 2025

View reviewed changes

comp/logs/auditor/impl-none/auditor_noop.go Outdated Show resolved Hide resolved

comp/logs/auditor/impl/auditor_test.go Outdated Show resolved Hide resolved

comp/logs/auditor/impl/api_v0.go Outdated Show resolved Hide resolved

Address PR comments

dffe553

1. Closed channel in the noop auditor 2. Refactored the auditor constructor to two public and private constructors so the private constructor can be used in tests. 3. Removed extraneous TODO from old api_v0

soberpeach requested a review from gh123man February 10, 2025 21:15

gh123man approved these changes Feb 10, 2025

View reviewed changes

dd-mergequeue bot merged commit eb0eb80 into main Feb 10, 2025
226 checks passed

dd-mergequeue bot deleted the lucas.liseth/create-auditor-component branch February 10, 2025 21:49

soberpeach mentioned this pull request Feb 12, 2025

[AGNTLOG-56] Replace pkg/logs/auditor with comp/logs/auditor #33999

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[AGNTLOG-56 ] Create Auditor Component #33680

[AGNTLOG-56 ] Create Auditor Component #33680

soberpeach commented Feb 3, 2025 •

edited

Loading

agent-platform-auto-pr bot commented Feb 3, 2025 •

edited

Loading

agent-platform-auto-pr bot commented Feb 3, 2025 •

edited

Loading

cit-pr-commenter bot commented Feb 3, 2025 •

edited

Loading

Fine details of change detection per experiment

Bounds Checks: ✅ Passed

Explanation

gh123man commented Feb 5, 2025

agent-platform-auto-pr bot commented Feb 5, 2025 •

edited

Loading

gh123man left a comment

soberpeach commented Feb 10, 2025

dd-devflow bot commented Feb 10, 2025 •

edited

Loading

[AGNTLOG-56 ] Create Auditor Component #33680

[AGNTLOG-56 ] Create Auditor Component #33680

Conversation

soberpeach commented Feb 3, 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 Feb 3, 2025 • edited Loading

Uncompressed package size comparison

Decision

agent-platform-auto-pr bot commented Feb 3, 2025 • edited Loading

Test changes on VM

cit-pr-commenter bot commented Feb 3, 2025 • edited Loading

Regression Detector

Regression Detector Results

Optimization Goals: ✅ Improvement(s) detected

Fine details of change detection per experiment

Bounds Checks: ✅ Passed

Explanation

CI Pass/Fail Decision

gh123man commented Feb 5, 2025

agent-platform-auto-pr bot commented Feb 5, 2025 • edited Loading

Static quality checks ✅

Info

gh123man left a comment

Choose a reason for hiding this comment

soberpeach commented Feb 10, 2025

dd-devflow bot commented Feb 10, 2025 • edited Loading

Devflow running: /merge

soberpeach commented Feb 3, 2025 •

edited

Loading

agent-platform-auto-pr bot commented Feb 3, 2025 •

edited

Loading

agent-platform-auto-pr bot commented Feb 3, 2025 •

edited

Loading

cit-pr-commenter bot commented Feb 3, 2025 •

edited

Loading

agent-platform-auto-pr bot commented Feb 5, 2025 •

edited

Loading

dd-devflow bot commented Feb 10, 2025 •

edited

Loading

Devflow running: `/merge`