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

pkg/trace: make pkg/trace/agent control the lifecycle of pkg timing #22183

Merged
merged 3 commits into from
Jan 25, 2024

Conversation

ahmed-mez
Copy link
Contributor

@ahmed-mez ahmed-mez commented Jan 19, 2024

What does this PR do?

Revamp the timing package and make pkg/trace/agent control its lifecycle. Inject the dogstatsd client as a dependency of timing instead of importing the metrics package directly, this simplifies the refactor and eases testing.

Motivation

fixes #22030

Additional Notes

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

Checked the metrics submitted using the timing package haven't regressed.

image

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.

@ahmed-mez ahmed-mez added changelog/no-changelog team/agent-apm trace-agent [deprecated] qa/skip-qa - use other qa/ labels [DEPRECATED] Please use qa/done or qa/no-code-change to skip creating a QA card qa/done Skip QA week as QA was done before merge and regressions are covered by tests labels Jan 19, 2024
@ahmed-mez ahmed-mez added this to the 7.52.0 milestone Jan 19, 2024
@pr-commenter
Copy link

pr-commenter bot commented Jan 19, 2024

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: 0ee5ea35-cd77-4b2a-a369-fcfb8c52f266
Baseline: b7f2e19
Comparison: 470a1d6
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_to_blackhole % cpu utilization +1.19 [-5.44, +7.82]
file_tree memory utilization +0.32 [+0.26, +0.39]
idle memory utilization -0.23 [-0.26, -0.20]

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI
otel_to_otel_logs ingress throughput +1.81 [+1.07, +2.56]
file_to_blackhole % cpu utilization +1.19 [-5.44, +7.82]
process_agent_standard_check memory utilization +0.34 [+0.30, +0.39]
file_tree memory utilization +0.32 [+0.26, +0.39]
tcp_syslog_to_blackhole ingress throughput +0.05 [-0.01, +0.12]
process_agent_real_time_mode memory utilization +0.04 [+0.02, +0.07]
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.06, +0.06]
trace_agent_msgpack ingress throughput -0.00 [-0.04, +0.04]
trace_agent_json ingress throughput -0.00 [-0.03, +0.03]
uds_dogstatsd_to_api ingress throughput -0.00 [-0.04, +0.04]
process_agent_standard_check_with_stats memory utilization -0.12 [-0.17, -0.08]
idle memory utilization -0.23 [-0.26, -0.20]
uds_dogstatsd_to_api_cpu % cpu utilization -0.64 [-2.09, +0.80]

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

Copy link
Contributor

@knusbaum knusbaum left a comment

Choose a reason for hiding this comment

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

Some initial comments

pkg/trace/agent/agent.go Outdated Show resolved Hide resolved
pkg/trace/metrics/client.go Outdated Show resolved Hide resolved
pkg/trace/metrics/timing/timing.go Outdated Show resolved Hide resolved
@ahmed-mez
Copy link
Contributor Author

@knusbaum thanks! I ended up implementing a different and simpler approach.

@ahmed-mez ahmed-mez marked this pull request as ready for review January 22, 2024 09:09
@ahmed-mez ahmed-mez requested a review from a team as a code owner January 22, 2024 09:09
@ahmed-mez
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jan 25, 2024

🚂 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
Copy link

dd-devflow bot commented Jan 25, 2024

🚂 MergeQueue

Added to the queue.

There are 5 builds ahead of this PR! (estimated merge in less than 1h)

Use /merge -c to cancel this operation!

@dd-mergequeue dd-mergequeue bot merged commit fe35c89 into main Jan 25, 2024
169 checks passed
@dd-mergequeue dd-mergequeue bot deleted the ahmed/timing-revamp branch January 25, 2024 17:26
knusbaum pushed a commit that referenced this pull request Feb 28, 2024
…22183)

pkg/trace: make pkg/trace/agent control the lifecycle of pkg timing
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog [deprecated] qa/skip-qa - use other qa/ labels [DEPRECATED] Please use qa/done or qa/no-code-change to skip creating a QA card mergequeue-status: done qa/done Skip QA week as QA was done before merge and regressions are covered by tests team/agent-apm trace-agent
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] pkg/trace/metrics/timing is leaking a goroutine
3 participants