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

Add separators for large numbers #35100

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

ajgajg1134
Copy link
Contributor

@ajgajg1134 ajgajg1134 commented Mar 13, 2025

What does this PR do?

Add separators to a variety of large int literals that we own.

While making the change I happened to run into some dead code in testutils and so removed TestSpan()

Motivation

Separators improve human readability. We have previously missed changes to literals like these that resulted in breaking changes, with improved readability human reviewers are more likely to see when a value changes, especially for large numbers like 1000000 (e.g. can you at a glance tell what that number is? I know I certainly can't. Is it the same as 100000?)

Describe how you validated your changes

I added a custom Datadog Code Security rule that looks for these and suggests fixes. On making these changes I ensured that the values stayed the same. Unit tests and visual verification should be sufficient here.

Possible Drawbacks / Trade-offs

Maybe someone out there doesn't like these separators?

Additional Notes

@ajgajg1134 ajgajg1134 added changelog/no-changelog team/agent-apm trace-agent qa/done QA done before merge and regressions are covered by tests labels Mar 13, 2025
@ajgajg1134 ajgajg1134 requested review from a team as code owners March 13, 2025 17:58
@ajgajg1134 ajgajg1134 requested a review from truthbk March 13, 2025 17:58
@github-actions github-actions bot added the medium review PR review might take time label Mar 13, 2025
Copy link
Member

@truthbk truthbk left a comment

Choose a reason for hiding this comment

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

Looks good, just calling out the TestSpan() removal to make sure it was intentional, and understand why.

@@ -393,26 +393,3 @@ func GetTestSpan() *pb.Span {
traceutil.ComputeTopLevel(trace)
return trace[0]
}

// TestSpan returns a fix span with hardcoded info, useful for reproducible tests
func TestSpan() *pb.Span {
Copy link
Member

Choose a reason for hiding this comment

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

Any reason to remove this? Unused?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah I'll update the description - yeah in modifying this code I noticed that this function was unused so removed it.

@agent-platform-auto-pr
Copy link
Contributor

Test changes on VM

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

dda inv aws.create-vm --pipeline-id=58751173 --os-family=ubuntu

Note: This applies to commit 7fc73a0

@agent-platform-auto-pr
Copy link
Contributor

Uncompressed package size comparison

Comparison with ancestor 0bf3ea97fdfcfa5ba85952687d0c66803fd3caa8

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 810.25MB 810.25MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 820.04MB 820.04MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 820.04MB 820.04MB 0.50MB
datadog-agent-arm64-deb 0.00MB 801.20MB 801.20MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 810.97MB 810.97MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 39.33MB 39.33MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 39.41MB 39.41MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 39.41MB 39.41MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 37.86MB 37.86MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 441.25MB 441.25MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.18MB 62.18MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.25MB 62.25MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.25MB 62.25MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.40MB 59.40MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.47MB 59.47MB 0.50MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

Static quality checks ✅

Please find below the results from static quality gates

Successful checks

Info

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_deb_amd64 784.29 MiB 801.8 MiB 191.09 MiB 202.62 MiB
static_quality_gate_agent_deb_arm64 775.58 MiB 793.14 MiB 172.9 MiB 184.51 MiB
static_quality_gate_agent_rpm_amd64 784.29 MiB 801.79 MiB 193.13 MiB 205.03 MiB
static_quality_gate_agent_rpm_arm64 775.58 MiB 793.09 MiB 175.46 MiB 186.44 MiB
static_quality_gate_agent_suse_amd64 784.23 MiB 801.81 MiB 193.13 MiB 205.03 MiB
static_quality_gate_agent_suse_arm64 775.59 MiB 793.14 MiB 175.46 MiB 186.44 MiB
static_quality_gate_dogstatsd_deb_amd64 37.59 MiB 47.67 MiB 9.74 MiB 19.78 MiB
static_quality_gate_dogstatsd_deb_arm64 36.18 MiB 46.27 MiB 8.45 MiB 18.49 MiB
static_quality_gate_dogstatsd_rpm_amd64 37.59 MiB 47.67 MiB 9.75 MiB 19.79 MiB
static_quality_gate_dogstatsd_suse_amd64 37.59 MiB 47.67 MiB 9.75 MiB 19.79 MiB
static_quality_gate_iot_agent_deb_amd64 59.38 MiB 69.0 MiB 14.92 MiB 24.8 MiB
static_quality_gate_iot_agent_deb_arm64 56.73 MiB 66.4 MiB 12.88 MiB 22.8 MiB
static_quality_gate_iot_agent_rpm_amd64 59.38 MiB 69.0 MiB 14.94 MiB 24.8 MiB
static_quality_gate_iot_agent_rpm_arm64 56.73 MiB 66.4 MiB 12.87 MiB 22.8 MiB
static_quality_gate_iot_agent_suse_amd64 59.38 MiB 69.0 MiB 14.94 MiB 24.8 MiB
static_quality_gate_docker_agent_amd64 868.86 MiB 886.12 MiB 292.18 MiB 304.21 MiB
static_quality_gate_docker_agent_arm64 883.5 MiB 900.79 MiB 278.54 MiB 290.47 MiB
static_quality_gate_docker_agent_jmx_amd64 1.04 GiB 1.06 GiB 367.28 MiB 379.33 MiB
static_quality_gate_docker_agent_jmx_arm64 1.05 GiB 1.06 GiB 349.62 MiB 361.55 MiB
static_quality_gate_docker_dogstatsd_amd64 45.73 MiB 55.78 MiB 17.25 MiB 27.28 MiB
static_quality_gate_docker_dogstatsd_arm64 44.36 MiB 54.45 MiB 16.12 MiB 26.16 MiB
static_quality_gate_docker_cluster_agent_amd64 264.87 MiB 274.78 MiB 106.28 MiB 116.28 MiB
static_quality_gate_docker_cluster_agent_arm64 280.81 MiB 290.82 MiB 101.13 MiB 111.12 MiB

Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 1f95c6ec-c637-4d84-9278-a6721a56896e

Baseline: 0bf3ea9
Comparison: 7fc73a0
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +1.41 [+0.57, +2.25] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.03 [-0.60, +0.67] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.02 [-0.75, +0.80] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.02 [-0.63, +0.67] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.01, +0.01] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.29, +0.29] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.04 [-0.83, +0.74] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.05 [-0.90, +0.80] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.05 [-0.96, +0.86] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.12 [-0.59, +0.35] 1 Logs
quality_gate_idle memory utilization -0.28 [-0.35, -0.21] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency egress throughput -0.30 [-1.08, +0.48] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.38 [-0.44, -0.32] 1 Logs
quality_gate_idle_all_features memory utilization -0.58 [-0.64, -0.52] 1 Logs bounds checks dashboard
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -0.70 [-0.75, -0.66] 1 Logs
quality_gate_logs % cpu utilization -1.04 [-3.86, +1.77] 1 Logs
file_tree memory utilization -3.05 [-3.24, -2.87] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
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 intake_connections 10/10 bounds checks dashboard
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
quality_gate_logs intake_connections 10/10
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

Passed. All Quality Gates passed.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog medium review PR review might take time qa/done QA 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.

3 participants