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

[usm] reliability, preparation for pool of objects, add Protocol.ReleaseStats() #32317

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

yuri-lipnesh
Copy link
Contributor

@yuri-lipnesh yuri-lipnesh commented Dec 17, 2024

What does this PR do?

It adds usm Protocol.ReleaseStats() to release reported stats objects.
It introduces a chain of functions to invoke ReleaseStats(), starting from the network tracer.
The HTTP handler retains and implicitly releases references to the reported statistics.

Motivation

This is part of the ongoing reliability effort, serving as a preparation step for adding a pool of DDSketch objects.
It breaks the task of implementing the object pool into several distinct phases.

Describe how you validated your changes

Unit tests.
Running usm http load tests.

Possible Drawbacks / Trade-offs

Additional Notes

@yuri-lipnesh yuri-lipnesh added changelog/no-changelog team/usm The USM team qa/done QA done before merge and regressions are covered by tests and removed component/system-probe labels Dec 17, 2024
@github-actions github-actions bot added the short review PR is simple enough to be reviewed quickly label Dec 17, 2024
Copy link

cit-pr-commenter bot commented Dec 17, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: a5252c0b-35e9-4f22-b7ab-ba41ae95bec8

Baseline: 6fb76d5
Comparison: 196aaf9
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_logs % cpu utilization +2.65 [-0.34, +5.65] 1 Logs
quality_gate_idle_all_features memory utilization +0.99 [+0.84, +1.15] 1 Logs bounds checks dashboard
uds_dogstatsd_to_api_cpu % cpu utilization +0.77 [+0.05, +1.50] 1 Logs
file_tree memory utilization +0.55 [+0.39, +0.71] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.51 [-0.27, +1.28] 1 Logs
otel_to_otel_logs ingress throughput +0.18 [-0.48, +0.84] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.13 [-0.64, +0.90] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.03 [-0.08, +0.14] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.00 [-0.63, +0.64] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.02 [-0.64, +0.61] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.02 [-0.88, +0.84] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.02 [-0.91, +0.86] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.08 [-0.93, +0.78] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.21 [-0.66, +0.24] 1 Logs
quality_gate_idle memory utilization -0.42 [-0.48, -0.35] 1 Logs bounds checks dashboard
tcp_syslog_to_blackhole ingress throughput -1.30 [-1.37, -1.24] 1 Logs

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
quality_gate_idle memory_usage 8/10 bounds checks dashboard
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_all_features memory_usage 10/10 bounds checks dashboard
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:

  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

Failed. Some Quality Gates were violated.

  • quality_gate_idle, bounds check memory_usage: 8/10 replicas passed. Failed 2 which is > 0. Gate FAILED.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@yuri-lipnesh yuri-lipnesh force-pushed the yuri.lipnesh/USMON-1324_release_protocol_stats branch from ad6f1d4 to 45fe447 Compare December 18, 2024 02:26
@github-actions github-actions bot added medium review PR review might take time and removed short review PR is simple enough to be reviewed quickly labels Dec 18, 2024
@agent-platform-auto-pr
Copy link
Contributor

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

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

Note: This applies to commit 196aaf9

@agent-platform-auto-pr
Copy link
Contributor

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

Uncompressed package size comparison

Comparison with ancestor 6fb76d59dcac4a66e7ed9bb68845dfe1ed653a7d

Diff per package
package diff status size ancestor threshold
datadog-agent-aarch64-rpm 0.09MB ⚠️ 943.07MB 942.98MB 140.00MB
datadog-agent-arm64-deb 0.07MB ⚠️ 933.83MB 933.76MB 140.00MB
datadog-agent-x86_64-rpm 0.05MB ⚠️ 1197.06MB 1197.01MB 140.00MB
datadog-agent-x86_64-suse 0.05MB ⚠️ 1197.06MB 1197.01MB 140.00MB
datadog-heroku-agent-amd64-deb 0.05MB ⚠️ 505.09MB 505.05MB 70.00MB
datadog-agent-amd64-deb 0.02MB ⚠️ 1187.80MB 1187.77MB 140.00MB
datadog-dogstatsd-amd64-deb 0.00MB 78.58MB 78.58MB 10.00MB
datadog-dogstatsd-x86_64-rpm 0.00MB 78.65MB 78.65MB 10.00MB
datadog-dogstatsd-x86_64-suse 0.00MB 78.65MB 78.65MB 10.00MB
datadog-dogstatsd-arm64-deb 0.00MB 55.78MB 55.78MB 10.00MB
datadog-iot-agent-amd64-deb 0.00MB 113.31MB 113.31MB 10.00MB
datadog-iot-agent-x86_64-rpm 0.00MB 113.38MB 113.38MB 10.00MB
datadog-iot-agent-x86_64-suse 0.00MB 113.38MB 113.38MB 10.00MB
datadog-iot-agent-arm64-deb 0.00MB 108.78MB 108.78MB 10.00MB
datadog-iot-agent-aarch64-rpm 0.00MB 108.84MB 108.84MB 10.00MB

Decision

⚠️ Warning

@github-actions github-actions bot added long review PR is complex, plan time to review it and removed medium review PR review might take time labels Dec 18, 2024
@yuri-lipnesh yuri-lipnesh changed the title [usm] reliability, preparation for pool of objects, add Tracer.ReleaseStats() [usm] reliability, preparation for pool of objects, add Protocol.ReleaseStats() Dec 18, 2024
@yuri-lipnesh yuri-lipnesh marked this pull request as ready for review December 18, 2024 22:54
@yuri-lipnesh yuri-lipnesh requested review from a team as code owners December 18, 2024 22:54
Comment on lines +113 to +114

nt.tracer.ReleaseProtocolStats(cs)
Copy link
Contributor

Choose a reason for hiding this comment

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

why is it here? why do we need to expose a method in the NPM tracer to release USM stats?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Tracer.Connections keeps reference to stats objects. The eventual purpose is to release objects to pool, it could be done only after Tracer no longer references stats objects.

Comment on lines +130 to +131
// CanRelease is true when the struct is no longer referenced
CanRelease bool
Copy link
Contributor

Choose a reason for hiding this comment

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

the current design frees the memory only if we called CombineWith, but there are other flows in which we don't call combineWith but still must release the resources

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The goal is to introduce changes gradually, in stages, with the remaining cases being considered later, in the following stages.

Comment on lines +547 to +557
// releaseProtocolStats release stats objects for enabled protocols.
func (e *ebpfProgram) releaseProtocolStats(conns *network.Connections) {
for _, protocol := range e.enabledProtocols {
switch protocol.Instance.Type() {
case protocols.HTTP:
for _, rs := range conns.HTTP {
rs.ReleaseStats()
}
}
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Having USM main entrypoint getting NPM representation of connections, just to free internal state is not the right way to do it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I intend to change this in the next phase, this approach allowed me to keep the changes at this stage minimal.

Comment on lines 465 to 466
t.bufferLock.Lock()
defer t.bufferLock.Unlock()
Copy link
Contributor

Choose a reason for hiding this comment

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

why do you use this mutex?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

for precautionary reasons because it is used in Tracer.GetActiveConnections, however this lock here seems to be redundant. I'll remove it and check the impact.

@yuri-lipnesh yuri-lipnesh requested a review from guyarb December 19, 2024 13:05
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/usm The USM team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants