Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make # of log pipelines configurable and default to GOMAXPROCS #31190

Merged
merged 7 commits into from
Dec 10, 2024

Conversation

gh123man
Copy link
Member

@gh123man gh123man commented Nov 18, 2024

What does this PR do?

Makes the # of logs pipelines configurable (previously hard coded to 4) and set the default to GOMAXPROCS with a soft maximum of 4.

Motivation

Logs pipelines are inherently limited by a single CPU core due to compression overhead. The previous hardcoded setting of 4 was overfit for small hosts, and possibly underfit for large hosts (with more than 4 cores available).

With this change we set the number of pipelines to GOMAXPROCS but also allow it to be customized manually by logs_config.pipelines. Limiting the setting to 4 ensures hosts with a lot of CPUs don't over provision too many logs pipelines but leaves room to adjust if needed.

Describe how to test/QA your changes

QA done by validating the logs agent still works (SMP results in PR).

  • This should have no out of the box behavior change. Agent will just better utilize available resources.

Possible Drawbacks / Trade-offs

Additional Notes

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Nov 18, 2024

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv create-vm --pipeline-id=49608501 --os-family=ubuntu

Note: This applies to commit d99f56a

Copy link

cit-pr-commenter bot commented Nov 18, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 376df6fd-4796-4293-90ad-9f540156dc3b

Baseline: 52173be
Comparison: d99f56a
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
basic_py_check % cpu utilization +3.97 [+0.07, +7.86] 1 Logs
quality_gate_idle_all_features memory utilization +0.69 [+0.57, +0.80] 1 Logs bounds checks dashboard
file_tree memory utilization +0.51 [+0.36, +0.65] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.49 [-0.25, +1.22] 1 Logs
otel_to_otel_logs ingress throughput +0.31 [-0.35, +0.96] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.21 [-0.55, +0.97] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.05 [-0.73, +0.83] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.04 [-0.74, +0.83] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.08, +0.09] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.02 [-0.70, +0.66] 1 Logs
quality_gate_idle memory utilization -0.15 [-0.20, -0.11] 1 Logs bounds checks dashboard
file_to_blackhole_300ms_latency egress throughput -0.25 [-0.88, +0.38] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.46 [-0.91, +0.00] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.54 [-0.61, -0.48] 1 Logs
pycheck_lots_of_tags % cpu utilization -1.12 [-4.56, +2.32] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_1000ms_latency lost_bytes 0/10
file_to_blackhole_500ms_latency lost_bytes 8/10
file_to_blackhole_100ms_latency 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_1000ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency_linear_load memory_usage 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 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

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:

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

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@gh123man gh123man marked this pull request as ready for review November 18, 2024 19:32
@gh123man gh123man requested review from a team as code owners November 18, 2024 19:32
@gh123man
Copy link
Member Author

Other teams that review this for the non-logs components:

  • Do you want to use the same # of pipelines as the logs agent all the time? or would you prefer a different default setting? (Currently using the same as the logs pipeline)

@gh123man gh123man requested a review from paulcacheux November 18, 2024 19:46
pkg/config/setup/config.go Outdated Show resolved Hide resolved
Copy link
Contributor

@sgnn7 sgnn7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@gh123man One small nit but not a blocker

pkg/config/setup/config.go Outdated Show resolved Hide resolved
@louis-cqrl louis-cqrl removed the request for review from Kaderinho November 21, 2024 08:52
@remeh
Copy link
Contributor

remeh commented Nov 21, 2024

This PR will double the amount of (possible idle) connections to the intake, let's make sure it's fine, but otherwise, LGTM!

@@ -210,7 +210,7 @@ func (a *Agent) SetupPipeline(
destinationsCtx := client.NewDestinationsContext()

// setup the pipeline provider that provides pairs of processor and sender
pipelineProvider := pipeline.NewProvider(config.NumberOfPipelines, auditor, &diagnostic.NoopMessageReceiver{}, processingRules, a.endpoints, destinationsCtx, NewStatusProvider(), a.hostname, a.config)
pipelineProvider := pipeline.NewProvider(a.config.GetInt("logs_config.pipelines"), auditor, &diagnostic.NoopMessageReceiver{}, processingRules, a.endpoints, destinationsCtx, NewStatusProvider(), a.hostname, a.config)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just to be clear, if this value is not set by the user, the default is still applied? I want to make sure because we use this dependency in the upstream collector and there wouldn't be a way for the user to specify it currently

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If the collector uses the same default configurations as the agent uses - yes it will use the default value here. The default was just moved to the config instead of being hard coded so a user could configure it if they wanted.

To be safe (if you want) - I could return this line back to the original default (4) as I did for the security and compliance agent.

@jackgopack4
Copy link
Contributor

is this still happening?

@gh123man
Copy link
Member Author

@jackgopack4 Yep! Was blocked by the merge freeze - thanks for the signoff!

@gh123man
Copy link
Member Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Dec 10, 2024

Devflow running: /merge

View all feedbacks in Devflow UI.


2024-12-10 10:09:48 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 24m.

mx-psi pushed a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Dec 10, 2024
…36557)

<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description
adds config value `logs_config.pipelines` to maintain compatibility with
upstream Datadog agent components

<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Relates to DataDog/datadog-agent#31190

<!--Describe what testing was performed and which tests were added.-->
#### Testing
existing pipeliens
<!--Describe the documentation added.-->
#### Documentation
none, no change to user or api
<!--Please delete paragraphs that you did not use before submitting.-->
@dd-mergequeue dd-mergequeue bot merged commit bcfd6ab into main Dec 10, 2024
230 checks passed
@dd-mergequeue dd-mergequeue bot deleted the brian/AMLII-2165-configurable-logs-pipelines branch December 10, 2024 10:35
@github-actions github-actions bot added this to the 7.62.0 milestone Dec 10, 2024
@gh123man gh123man added the qa/done QA done before merge and regressions are covered by tests label Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog component/system-probe long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/agent-metrics-logs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants