datadog-agent icon indicating copy to clipboard operation
datadog-agent copied to clipboard

Create modules in pkg/logs and move internal pkg/logs dependencies

Open liustanley opened this issue 1 year ago • 4 comments

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/logstatus
  • pkg/logs/message
  • pkg/logs/metrics
  • pkg/logs/pipeline
  • pkg/logs/processor
  • pkg/logs/sender
  • pkg/logs/sources
  • pkg/logs/util/testutils
  • pkg/util/startstop (dependency of pkg/logs/client and pkg/logs/pipeline)

In doing so, we had to move the following internal packages out of pkg/logs/internal in order to convert the other pkg/logs packages into modules:

  • pkg/logs/internal/processor -> pkg/logs/processor
  • pkg/logs/internal/status -> pkg/logs/status/utils
  • pkg/logs/internal/util/testutils -> pkg/logs/util/testutils

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

  • [ ] 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.
  • [ ] A release note has been added or the changelog/no-changelog label has been applied.
  • [ ] Changed code has automated tests for its functionality.
  • [ ] 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.
  • [ ] 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.

liustanley avatar Feb 07 '24 17:02 liustanley

Go Package Import Differences

Baseline: acd202029ca9173e256e69eb2ae2b8a2dd88a556 Comparison: fbfe23ef5369fa05b7a2c886c4b43cbedeff8008

binaryosarchchange
agentlinuxamd64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
agentlinuxarm64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
agentwindowsamd64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
agentwindows386
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
agentdarwinamd64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
agentdarwinarm64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
iot-agentlinuxamd64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
iot-agentlinuxarm64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
heroku-agentlinuxamd64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
cluster-agentlinuxamd64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
cluster-agentlinuxarm64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
cluster-agent-cloudfoundrylinuxamd64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
cluster-agent-cloudfoundrylinuxarm64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
dogstatsdlinuxamd64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
dogstatsdlinuxarm64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
process-agentlinuxamd64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
process-agentlinuxarm64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
process-agentwindowsamd64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
process-agentdarwinamd64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
process-agentdarwinarm64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
heroku-process-agentlinuxamd64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
security-agentlinuxamd64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
security-agentlinuxarm64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
serverlesslinuxamd64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
serverlesslinuxarm64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
system-probelinuxamd64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
system-probelinuxarm64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
system-probewindowsamd64
+2, -2
-github.com/DataDog/datadog-agent/pkg/logs/internal/processor
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/processor
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
trace-agentlinuxamd64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
trace-agentlinuxarm64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
trace-agentwindowsamd64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
trace-agentwindows386
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
trace-agentdarwinamd64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
trace-agentdarwinarm64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils
heroku-trace-agentlinuxamd64
+1, -1
-github.com/DataDog/datadog-agent/pkg/logs/internal/status
+github.com/DataDog/datadog-agent/pkg/logs/status/utils

cit-pr-commenter[bot] avatar Feb 07 '24 20:02 cit-pr-commenter[bot]

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: cd3b6168-2bbf-4e26-a322-1a8d6d365869 Baseline: acd202029ca9173e256e69eb2ae2b8a2dd88a556 Comparison: fbfe23ef5369fa05b7a2c886c4b43cbedeff8008

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

Experiments with missing or malformed data

  • basic_py_check

Usually, this warning means that there is no usable optimization goal data for that experiment, which could be a result of misconfiguration.

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_to_blackhole % cpu utilization -1.15 [-7.64, +5.35]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
idle memory utilization +0.30 [+0.26, +0.35]
uds_dogstatsd_to_api_cpu % cpu utilization +0.05 [-1.39, +1.49]
file_tree memory utilization +0.02 [-0.09, +0.14]
trace_agent_msgpack ingress throughput +0.00 [-0.00, +0.01]
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.00, +0.00]
uds_dogstatsd_to_api ingress throughput -0.00 [-0.00, +0.00]
trace_agent_json ingress throughput -0.00 [-0.04, +0.03]
process_agent_standard_check_with_stats memory utilization -0.05 [-0.10, -0.00]
tcp_syslog_to_blackhole ingress throughput -0.09 [-0.15, -0.03]
otel_to_otel_logs ingress throughput -0.35 [-0.97, +0.27]
process_agent_real_time_mode memory utilization -0.63 [-0.68, -0.59]
process_agent_standard_check memory utilization -0.69 [-0.73, -0.65]
file_to_blackhole % cpu utilization -1.15 [-7.64, +5.35]

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

pr-commenter[bot] avatar Feb 07 '24 22:02 pr-commenter[bot]

Would it be too complex to create a single pkg/logs module ?

pgimalac avatar Feb 12 '24 10:02 pgimalac

@GustavoCaso @pgimalac We can't create a single pkg/logs module because of other coupled dependencies throughout datadog-agent. For example, pkg/logs/tailers depends on pkg/util/docker and pkg/util/containers which both aren't modules and have many other dependencies which also aren't modules. Because of cases such as this, we chose to only convert the packages in pkg/logs that are needed to export the logs pipeline for our use in the Collector.

liustanley avatar Feb 13 '24 15:02 liustanley

/merge

liustanley avatar Mar 08 '24 18:03 liustanley

:steam_locomotive: MergeQueue

This merge request is not mergeable yet, because of pending checks/missing approvals. It will be added to the queue as soon as checks pass and/or get approvals. Note: if you pushed new commits since the last approval, you may need additional approval. You can remove it from the waiting list with /remove command.

Use /merge -c to cancel this operation!

dd-devflow[bot] avatar Mar 08 '24 18:03 dd-devflow[bot]

:steam_locomotive: MergeQueue

Added to the queue.

This build is going to start soon! (estimated merge in less than 27m)

Use /merge -c to cancel this operation!

dd-devflow[bot] avatar Mar 08 '24 19:03 dd-devflow[bot]