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

Send event to DD on merged PR #30627

Merged
merged 11 commits into from
Nov 4, 2024

Conversation

pducolin
Copy link
Contributor

@pducolin pducolin commented Oct 30, 2024

What does this PR do?

Send event to DD on merged PR, including context from the QA description and qa labels

Motivation

Allow monitoring QA practices adoption

Describe how to test/QA your changes

You can try it locally with:

  • a merged PR with no qa labels nor description
inv -e github.pr-merge-dd-event-sender -d -p 30194 
  • a not yet merged PR (this one)
inv -e github.pr-merge-dd-event-sender -d -p 30627 
  • a merged PR with qa label and qa description
inv -e github.pr-merge-dd-event-sender -d -p 30208 

Possible Drawbacks / Trade-offs

Additional Notes

@pducolin pducolin added changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation labels Oct 30, 2024
@pducolin pducolin requested review from a team as code owners October 30, 2024 17:27
@pducolin pducolin force-pushed the pducolin/add-action-dd-event-on-merged-pr branch from c7c13f8 to 9f6d839 Compare October 30, 2024 17:35
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Oct 30, 2024

[Fast Unit Tests Report]

On pipeline 47975035 (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

Copy link
Contributor

@CelianR CelianR left a comment

Choose a reason for hiding this comment

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

Nice !

.github/workflows/report-merged-pr.yml Show resolved Hide resolved
"""
# capture test/QA description section content from PR body
# see example for this regex https://regexr.com/87mm2
result = re.search(r'^###\ Describe\ how\ to\ test.*\n([^#]*)\n###', pr_body, flags=re.MULTILINE)
Copy link
Contributor

Choose a reason for hiding this comment

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

❓ question: Should this take into account such case:

### Describe how to test
Some description

#### Step 1
...

#### Step 2
...

### ...

In this case, only Some description is matched and not Step 1...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good catch. Fixing this

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 switched to plain string parsing, it makes reading the code more comfortable and easier to implement

Copy link

cit-pr-commenter bot commented Oct 31, 2024

Regression Detector

Regression Detector Results

Run ID: f8d71cd1-4d76-4600-9f1b-6c8c9fe524be Metrics dashboard Target profiles

Baseline: c3bd3b6
Comparison: 0d4dac5

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
uds_dogstatsd_to_api_cpu % cpu utilization +3.64 [+2.90, +4.39] 1 Logs
idle_all_features memory utilization +3.23 [+3.11, +3.36] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization +1.82 [+1.77, +1.87] 1 Logs bounds checks dashboard
pycheck_lots_of_tags % cpu utilization +0.90 [-1.67, +3.48] 1 Logs
quality_gate_idle_all_features memory utilization +0.52 [+0.40, +0.65] 1 Logs bounds checks dashboard
idle memory utilization +0.19 [+0.13, +0.25] 1 Logs bounds checks dashboard
file_to_blackhole_500ms_latency egress throughput +0.05 [-0.19, +0.30] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.03 [-0.46, +0.52] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.03 [-0.07, +0.13] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.00 [-0.33, +0.33] 1 Logs
tcp_syslog_to_blackhole ingress throughput -0.00 [-0.06, +0.05] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.02 [-0.25, +0.20] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.06 [-0.24, +0.12] 1 Logs
file_tree memory utilization -0.74 [-0.88, -0.60] 1 Logs
otel_to_otel_logs ingress throughput -0.84 [-1.64, -0.03] 1 Logs
basic_py_check % cpu utilization -0.90 [-3.63, +1.83] 1 Logs

Bounds Checks

perf experiment bounds_check_name replicates_passed
idle memory_usage 9/10
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
idle_all_features memory_usage 10/10
quality_gate_idle memory_usage 10/10
quality_gate_idle_all_features 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".

@github-actions github-actions bot added the medium review PR review might take time label Oct 31, 2024
Comment on lines 484 to 497
pr_body_lines = pr_body.splitlines()
index_of_test_qa_section = -1
for i, line in enumerate(pr_body_lines):
if line.startswith('### Describe how to test'):
index_of_test_qa_section = i
break
index_of_next_section = -1
for i in range(index_of_test_qa_section + 1, len(pr_body_lines)):
if pr_body_lines[i].startswith('### Possible Drawbacks'):
index_of_next_section = i
break
if index_of_next_section == -1:
return ''
return '\n'.join(pr_body_lines[index_of_test_qa_section + 1 : index_of_next_section]).strip()
Copy link
Contributor

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Might handle the case where the first line is not found, so that we avoid returning the full content of the body

@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 Oct 31, 2024
@pducolin
Copy link
Contributor Author

Will merge on Monday to avoid bad surprises during the long weekend

@pducolin
Copy link
Contributor Author

pducolin commented Nov 4, 2024

/merge

@dd-devflow
Copy link

dd-devflow bot commented Nov 4, 2024

🚂 MergeQueue: pull request added to the queue

The median merge time in main is 23m.

Use /merge -c to cancel this operation!

@dd-mergequeue dd-mergequeue bot merged commit 6621796 into main Nov 4, 2024
205 checks passed
@dd-mergequeue dd-mergequeue bot deleted the pducolin/add-action-dd-event-on-merged-pr branch November 4, 2024 10:06
@github-actions github-actions bot added this to the 7.61.0 milestone Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog long review PR is complex, plan time to review it qa/no-code-change No code change in Agent code requiring validation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants