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

feat(github): Review the PR template

Open chouetz opened this issue 1 year ago • 5 comments

What does this PR do?

Change the PR template.

Motivation

There are a lot of comments in the current template and several of them seem unnecessary to me (they just describe with more words the current section name). It is a drawback when updating the PR description as we are polluted with this comments.

Additional Notes

I took the opportunity to reschuffle the sections, setting test and drawbacks/trade-offs sections before the additional notes which is an appendix section according to me (and I let a comment for this one only)

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

chouetz avatar Sep 16 '24 20:09 chouetz

[Fast Unit Tests Report]

On pipeline 44599717 (CI Visibility). The following jobs did not run any unit tests:

Jobs:
  • tests_deb-arm64-py3
  • tests_deb-x64-py3
  • tests_flavor_dogstatsd_deb-x64
  • tests_flavor_heroku_deb-x64
  • tests_flavor_iot_deb-x64
  • tests_rpm-arm64-py3
  • tests_rpm-x64-py3
  • tests_windows-x64

If you modified Go files and expected unit tests to run in these jobs, please double check the job logs. If you think tests should have been executed reach out to #agent-devx-help

Regression Detector

Regression Detector Results

Run ID: 580a5c03-db18-4f1c-9f30-ff8fd493761f Metrics dashboard Target profiles

Baseline: 4bd1ba6a9fd88335f294a8192618119f706433c3 Comparison: b936d78d6260cf3b3257f81285e99d04c83064b3

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.

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
file_tree memory utilization +3.58 [+3.47, +3.69] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.91 [+0.15, +1.67] 1 Logs
basic_py_check % cpu utilization +0.49 [-2.30, +3.28] 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.00, +0.00] 1 Logs
pycheck_lots_of_tags % cpu utilization -0.60 [-3.21, +2.00] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.69 [-0.74, -0.63] 1 Logs
otel_to_otel_logs ingress throughput -0.89 [-1.72, -0.07] 1 Logs
idle memory utilization -0.91 [-0.96, -0.87] 1 Logs

Bounds Checks

perf experiment bounds_check_name replicates_passed
idle memory_usage 10/10

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 Sep 16 '24 21:09 pr-commenter[bot]

/merge

chouetz avatar Sep 17 '24 21:09 chouetz

:steam_locomotive: MergeQueue: waiting for PR to be ready

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 Sep 17 '24 21:09 dd-devflow[bot]

:warning: MergeQueue: This merge request was unqueued

This merge request was unqueued

If you need support, contact us on Slack #devflow!

dd-devflow[bot] avatar Sep 18 '24 01:09 dd-devflow[bot]

/gitlab resync-job-status

chouetz avatar Sep 18 '24 11:09 chouetz

:steam_locomotive: Devflow: /gitlab resync-job-status

jobs status updated

dd-devflow[bot] avatar Sep 18 '24 11:09 dd-devflow[bot]

/gitlab resync-job-status

ericdog avatar Sep 18 '24 13:09 ericdog

:steam_locomotive: Devflow: /gitlab resync-job-status

jobs status updated

dd-devflow[bot] avatar Sep 18 '24 13:09 dd-devflow[bot]

/merge

chouetz avatar Sep 18 '24 18:09 chouetz

:steam_locomotive: MergeQueue: pull request added to the queue

The median merge time in main is 23m.

Use /merge -c to cancel this operation!

dd-devflow[bot] avatar Sep 18 '24 18:09 dd-devflow[bot]