Create modules in pkg/logs

[liustanley]

trafficstars

What does this PR do?

This PR creates the following modules in pkg/logs:

• pkg/logs/auditor
• pkg/logs/client
• pkg/logs/diagnostic
• pkg/logs/internal/processor
• pkg/logs/internal/status
• pkg/logs/internal/util/testutils
• pkg/logs/message
• pkg/logs/metrics
• pkg/logs/pipeline
• pkg/logs/sender
• pkg/logs/sources
• pkg/util/startstop (dependency of pkg/logs/client and pkg/logs/pipeline)

pkg/util/hostname and pkg/logs/status are dependencies of pkg/logs but have very coupled dependencies and are difficult to convert into modules. We decided to instead create the following interfaces so that we could decouple the interface from the implementation and import the interfaces as modules:

• pkg/logs/status/statusinterface
• comp/core/hostnameinterface

In doing so, we made hostnameimpl.NewHostnameService public in order to use outside of fx components, and created pkg/logs/status/statusimpl in order to create instances of a StatusInterface implementation. pkg/logs/internal/util/testutils contains mocks for StatusInterface and HostnameInterface for use in tests.

Motivation

We need to convert these packages in pkg/logs into modules in order to use the logs agent in the OTel Collector Datadog Exporter as described in the following RFC.

Additional Notes

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

Reviewer's Checklist

• [x] If known, an appropriate milestone has been selected; otherwise the Triage milestone is set.
• [ ] Use the major_change label if your change either has a major impact on the code base, is impacting multiple teams or is changing important well-established internals of the Agent. This label will be use during QA to make sure each team pay extra attention to the changed behavior. For any customer facing change use a releasenote.
• [x] A release note has been added or the changelog/no-changelog label has been applied.
• [ ] Changed code has automated tests for its functionality.
• [x] Adequate QA/testing plan information is provided. Except if the qa/skip-qa label, with required either qa/done or qa/no-code-change labels, are applied.
• [x] At least one team/.. label has been applied, indicating the team(s) that should QA this change.
• [ ] If applicable, docs team has been notified or an issue has been opened on the documentation repo.
• [ ] If applicable, the need-change/operator and need-change/helm labels have been applied.
• [ ] If applicable, the k8s/<min-version> label, indicating the lowest Kubernetes version compatible with this feature.
• [ ] If applicable, the config template has been updated.

[cit-pr-commenter[bot]]

Go Package Import Differences

Baseline: 253752538d260369d2ae3f7ddb93a825ffc230d8 Comparison: aab9679552c40eefe9da1d3855e1954060360a7f

binary	os	arch	change
agent	linux	amd64	+4, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/internal/util/testutils +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
agent	linux	arm64	+4, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/internal/util/testutils +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
agent	windows	amd64	+4, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/internal/util/testutils +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
agent	windows	386	+4, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/internal/util/testutils +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
agent	darwin	amd64	+4, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/internal/util/testutils +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
agent	darwin	arm64	+4, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/internal/util/testutils +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
iot-agent	linux	amd64	+4, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/internal/util/testutils +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
iot-agent	linux	arm64	+4, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/internal/util/testutils +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
heroku-agent	linux	amd64	+4, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/internal/util/testutils +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
cluster-agent	linux	amd64	+4, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/internal/util/testutils +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
cluster-agent	linux	arm64	+4, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/internal/util/testutils +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
cluster-agent-cloudfoundry	linux	amd64	+1, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
cluster-agent-cloudfoundry	linux	arm64	+1, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
dogstatsd	linux	amd64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
dogstatsd	linux	arm64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
process-agent	linux	amd64	+1, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
process-agent	linux	arm64	+1, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
process-agent	windows	amd64	+1, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
process-agent	darwin	amd64	+1, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
process-agent	darwin	arm64	+1, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
heroku-process-agent	linux	amd64	+1, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
security-agent	linux	amd64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
security-agent	linux	arm64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
serverless	linux	amd64	+5, -0 +github.com/DataDog/datadog-agent/comp/core/hostname +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
serverless	linux	arm64	+5, -0 +github.com/DataDog/datadog-agent/comp/core/hostname +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
system-probe	linux	amd64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
system-probe	linux	arm64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
system-probe	windows	amd64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface +github.com/DataDog/datadog-agent/pkg/logs/status/statusimpl +github.com/DataDog/datadog-agent/pkg/logs/status/statusinterface
trace-agent	linux	amd64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
trace-agent	linux	arm64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
trace-agent	windows	amd64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
trace-agent	windows	386	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
trace-agent	darwin	amd64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
trace-agent	darwin	arm64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface
heroku-trace-agent	linux	amd64	+3, -0 +github.com/DataDog/datadog-agent/comp/core/hostname +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameimpl +github.com/DataDog/datadog-agent/comp/core/hostname/hostnameinterface

[pr-commenter[bot]]

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: 83d9887d-6478-48ad-9943-53b1e7cae9c2 Baseline: 253752538d260369d2ae3f7ddb93a825ffc230d8 Comparison: daab169a4a90f090559f921622914baa4385aadd Total CPUs: 7

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

No significant changes in experiment optimization goals

Confidence level: 90.00% Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Experiments ignored for regressions

Regressions in experiments with settings containing erratic: true are ignored.

perf	experiment	goal	Δ mean %	Δ mean % CI
➖	file_tree	memory utilization	-0.32	[-0.45, -0.18]
➖	file_to_blackhole	% cpu utilization	-0.51	[-7.04, +6.01]
➖	idle	memory utilization	-0.58	[-0.63, -0.53]

Fine details of change detection per experiment

perf	experiment	goal	Δ mean %	Δ mean % CI
➖	otel_to_otel_logs	ingress throughput	+0.41	[-0.35, +1.16]
➖	process_agent_standard_check_with_stats	memory utilization	+0.38	[+0.33, +0.44]
➖	process_agent_real_time_mode	memory utilization	+0.33	[+0.28, +0.39]
➖	uds_dogstatsd_to_api	ingress throughput	+0.00	[-0.03, +0.03]
➖	tcp_dd_logs_filter_exclude	ingress throughput	+0.00	[-0.06, +0.06]
➖	trace_agent_json	ingress throughput	-0.00	[-0.03, +0.03]
➖	trace_agent_msgpack	ingress throughput	-0.01	[-0.03, +0.00]
➖	process_agent_standard_check	memory utilization	-0.25	[-0.33, -0.18]
➖	tcp_syslog_to_blackhole	ingress throughput	-0.26	[-0.32, -0.20]
➖	file_tree	memory utilization	-0.32	[-0.45, -0.18]
➖	file_to_blackhole	% cpu utilization	-0.51	[-7.04, +6.01]
➖	idle	memory utilization	-0.58	[-0.63, -0.53]

Explanation

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".