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 agent 6 schedule to create rc pr workflow #32073

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

Conversation

sabrina-datadog
Copy link
Contributor

@sabrina-datadog sabrina-datadog commented Dec 11, 2024

What does this PR do?

Add a weekly schedule to the create rc pr workflow for agent 6 release candidates. ACIX-454

  • change find_release_branches job to return [6.53.x] when it is for a6
  • use --patch-version for inv release.create-rc to bump to the right version after a final version (6.53.x-rc-1)
  • skip yes_no_question user interaction because it is a github workflow
  • reuse the set_git_config function from this OTel PR

Motivation

We want to ensure that agent 6 can be released at any point. So a weekly rc will be run to test that the agent 6 pipeline works.

Describe how you validated your changes

created a test branch to simulate when:

Possible Drawbacks / Trade-offs

Additional Notes

@sabrina-datadog sabrina-datadog added changelog/no-changelog qa/no-code-change No code change in Agent code requiring validation labels Dec 11, 2024
@github-actions github-actions bot added the medium review PR review might take time label Dec 11, 2024
@agent-platform-auto-pr
Copy link
Contributor

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

[Fast Unit Tests Report]

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

@sabrina-datadog sabrina-datadog marked this pull request as ready for review December 12, 2024 05:14
@sabrina-datadog sabrina-datadog requested review from a team as code owners December 12, 2024 05:14
@sabrina-datadog sabrina-datadog changed the title add agent 6 weekly schedule to create rc pr workflow add agent 6 schedule to create rc pr workflow Dec 12, 2024
@agent-platform-auto-pr
Copy link
Contributor

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

Package size comparison

Comparison with ancestor f483cc4c0dffec6f7bcd4824dc8df65c15957e27

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 1265.94MB 1265.94MB 140.00MB
datadog-iot-agent-amd64-deb 0.00MB 113.28MB 113.28MB 10.00MB
datadog-dogstatsd-amd64-deb 0.00MB 78.52MB 78.52MB 10.00MB
datadog-heroku-agent-amd64-deb 0.00MB 502.50MB 502.50MB 70.00MB
datadog-agent-x86_64-rpm 0.00MB 1275.18MB 1275.18MB 140.00MB
datadog-agent-x86_64-suse 0.00MB 1275.18MB 1275.18MB 140.00MB
datadog-iot-agent-x86_64-rpm 0.00MB 113.35MB 113.35MB 10.00MB
datadog-iot-agent-x86_64-suse 0.00MB 113.35MB 113.35MB 10.00MB
datadog-dogstatsd-x86_64-rpm 0.00MB 78.59MB 78.59MB 10.00MB
datadog-dogstatsd-x86_64-suse 0.00MB 78.59MB 78.59MB 10.00MB
datadog-agent-arm64-deb 0.00MB 1001.02MB 1001.02MB 140.00MB
datadog-iot-agent-arm64-deb 0.00MB 108.76MB 108.76MB 10.00MB
datadog-dogstatsd-arm64-deb 0.00MB 55.74MB 55.74MB 10.00MB
datadog-agent-aarch64-rpm 0.00MB 1010.24MB 1010.24MB 140.00MB
datadog-iot-agent-aarch64-rpm 0.00MB 108.83MB 108.83MB 10.00MB

Decision

✅ Passed

Copy link

cit-pr-commenter bot commented Dec 12, 2024

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 0847d67c-565c-4538-82c6-f633f1c87b95

Baseline: f483cc4
Comparison: fd0ef74
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
tcp_syslog_to_blackhole ingress throughput +0.45 [+0.39, +0.51] 1 Logs
quality_gate_idle_all_features memory utilization +0.45 [+0.32, +0.57] 1 Logs bounds checks dashboard
otel_to_otel_logs ingress throughput +0.43 [-0.24, +1.11] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.37 [-0.34, +1.09] 1 Logs
file_tree memory utilization +0.33 [+0.20, +0.45] 1 Logs
quality_gate_logs % cpu utilization +0.30 [-2.63, +3.22] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.20 [-0.44, +0.83] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.19 [-0.57, +0.96] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.15 [-0.77, +1.07] 1 Logs
quality_gate_idle memory utilization +0.15 [+0.11, +0.19] 1 Logs bounds checks dashboard
file_to_blackhole_0ms_latency egress throughput +0.03 [-0.84, +0.90] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.01 [-0.86, +0.84] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.09, +0.07] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.03 [-0.72, +0.66] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.05 [-0.51, +0.42] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.06 [-0.84, +0.71] 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 memory_usage 10/10 bounds checks dashboard
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

Passed. All Quality Gates passed.

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

Comment on lines +24 to +38
if: ${{ env.IS_AGENT6_RELEASE == 'false' }}
uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
with:
sparse-checkout: 'tasks'
persist-credentials: false

- name: Install python
if: ${{ env.IS_AGENT6_RELEASE == 'false' }}
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: 3.11
cache: "pip"

- name: Install Python dependencies
if: ${{ env.IS_AGENT6_RELEASE == 'false' }}
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 disabled when releasing agent 6?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Since the agent 6 will only have one unrelease branch (6.53.x) there is no need to find them. I tried adding an if condition at the job level, but it doesn't have access to the env variables at that point (docs).

.github/workflows/create_rc_pr.yml Outdated Show resolved Hide resolved
.github/workflows/create_rc_pr.yml Outdated Show resolved Hide resolved
fi

- name: Create RC PR
if: ${{ steps.check_for_changes.outputs.CHANGES == 'true'}}
if: ${{ steps.check_for_changes.outputs.CHANGES == 'true' || env.IS_AGENT6_RELEASE == 'true' }}
Copy link
Contributor

Choose a reason for hiding this comment

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

Should we remove the previous step if the output is ignored when releasing agent 6 ?

Copy link
Contributor Author

@sabrina-datadog sabrina-datadog Dec 12, 2024

Choose a reason for hiding this comment

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

No, I think we should keep it because the check_for_changes function not only checks for changes but can also modify the tags. There is additional logic that needs to be executed as part of the process here.

.github/workflows/create_rc_pr.yml Outdated Show resolved Hide resolved
.github/workflows/create_rc_pr.yml Outdated Show resolved Hide resolved
Comment on lines +280 to +294
def get_git_config(key):
result = subprocess.run(['git', 'config', '--get', key], capture_output=True, text=True)
return result.stdout.strip() if result.returncode == 0 else None


def set_git_config(key, value):
subprocess.run(['git', 'config', key, value])


def revert_git_config(original_config):
for key, value in original_config.items():
if value is None:
subprocess.run(['git', 'config', '--unset', key])
else:
subprocess.run(['git', 'config', key, value])
Copy link
Contributor

Choose a reason for hiding this comment

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

💬 suggestion: ‏Could you use ctx.run instead? (e.g. ctx.run('...', hide=True).stdout). Note that this will raise an error if the process exits with non zero value

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'm trying to reuse what the OTel folks did here, following @chouetz's offline suggestion

tasks/release.py Show resolved Hide resolved
if github_action:
set_git_config('user.name', 'github-actions[bot]')
set_git_config('user.email', 'github-actions[bot]@users.noreply.github.com')
upstream = f"https://x-access-token:{os.environ.get('GITHUB_TOKEN')}@github.com/{GITHUB_REPO_NAME}.git"
Copy link
Contributor

Choose a reason for hiding this comment

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

Are we sure this will not leak the token when executing the command?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

GitHub masks the secret by default, so the token isn't exposed (example). let me know if there are any concerns

Comment on lines +183 to +187
do_retry = (
False
if github_action
else yes_no_question("Do you want to retry this operation?", color="orange", default=True)
)
Copy link
Contributor

Choose a reason for hiding this comment

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

It feels like this could be replaced by checking if a TTY is attached rather that "if running under a CI"

Comment on lines +280 to +286
def get_git_config(key):
result = subprocess.run(['git', 'config', '--get', key], capture_output=True, text=True)
return result.stdout.strip() if result.returncode == 0 else None


def set_git_config(key, value):
subprocess.run(['git', 'config', key, value])
Copy link
Contributor

Choose a reason for hiding this comment

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

These helpers are a good idea! They could even be split in their own PR and be used throughout our tasks if this PR takes long to be merged (but definitely not required)

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 will make a ticket to update the rest of our tasks

@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 12, 2024
Copy link
Member

@songy23 songy23 left a comment

Choose a reason for hiding this comment

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

Approval for OTel

@songy23 songy23 removed the request for review from liustanley December 12, 2024 14:19
@sabrina-datadog sabrina-datadog force-pushed the sabrina/a6-workflow branch 2 times, most recently from 56c6e63 to a719857 Compare December 12, 2024 20:44
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.

5 participants