Run regression-detector on main, but make it a no-op #31099
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
scottopell
added
changelog/no-changelog
qa/no-code-change
Gitlab CI Configuration ChangesModified Jobssingle-machine-performance-regression_detector single-machine-performance-regression_detector:
allow_failure: false
artifacts:
expire_in: 1 weeks
paths:
- submission_metadata
- ${CI_COMMIT_SHA}-baseline_sha
- outputs/report.md
- outputs/regression_signal.json
- outputs/bounds_check_signal.json
- outputs/junit.xml
- outputs/report.json
- outputs/decision_record.md
when: always
image: registry.ddbuild.io/ci/datadog-agent-buildimages/docker_x64$DATADOG_AGENT_BUILDIMAGES_SUFFIX:$DATADOG_AGENT_BUILDIMAGES
needs:
- artifacts: false
job: single_machine_performance-amd64-a7
rules:
- - if: $CI_COMMIT_BRANCH == "main"
- when: never
- if: $CI_COMMIT_BRANCH =~ /^[0-9]+\.[0-9]+\.x$/
when: never
- if: $CI_COMMIT_BRANCH =~ /^mq-working-branch-/
when: never
- when: on_success
script:
+ - $CI_COMMIT_BRANCH == "main" && echo "No-op for main branch" && exit 0
- mkdir outputs
- git fetch origin
- SMP_BASE_BRANCH=$(inv release.get-release-json-value base_branch)
- echo "Looking for merge base for branch ${SMP_BASE_BRANCH}"
- SMP_MERGE_BASE=$(git merge-base ${CI_COMMIT_SHA} origin/${SMP_BASE_BRANCH})
- echo "Merge base is ${SMP_MERGE_BASE}"
- AWS_NAMED_PROFILE="single-machine-performance"
- SMP_ACCOUNT_ID=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $SMP_ACCOUNT account_id)
|| exit $?
- SMP_ECR_URL=${SMP_ACCOUNT_ID}.dkr.ecr.us-west-2.amazonaws.com
- SMP_AGENT_TEAM_ID=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $SMP_ACCOUNT agent_team_id)
|| exit $?
- SMP_API=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $SMP_ACCOUNT api_url) || exit
$?
- SMP_BOT_ID=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $SMP_ACCOUNT bot_login)
|| exit $?
- SMP_BOT_KEY=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $SMP_ACCOUNT bot_token)
|| exit $?
- aws configure set aws_access_key_id "$SMP_BOT_ID" --profile ${AWS_NAMED_PROFILE}
- aws configure set aws_secret_access_key "$SMP_BOT_KEY" --profile ${AWS_NAMED_PROFILE}
- aws configure set region us-west-2 --profile ${AWS_NAMED_PROFILE}
- aws --profile single-machine-performance s3 cp s3://smp-cli-releases/v${SMP_VERSION}/x86_64-unknown-linux-gnu/smp
smp
- chmod +x smp
- BASELINE_SHA="${SMP_MERGE_BASE}"
- echo "Computing baseline..."
- echo "Checking if commit ${BASELINE_SHA} is recent enough..."
- FOUR_DAYS_BEFORE_NOW=$(date --date="-4 days +1 hour" "+%s")
- BASELINE_COMMIT_TIME=$(git -c log.showSignature=false show --no-patch --format=%ct
${BASELINE_SHA})
- "if [[ ${BASELINE_COMMIT_TIME} -le ${FOUR_DAYS_BEFORE_NOW} ]]\nthen\n echo\
\ \"ERROR: Merge-base of this branch is too old for SMP. Please update your branch\
\ by merging an up-to-date main branch into your branch or by rebasing it on an\
\ up-to-date main branch.\"\n exit 1\nfi\n"
- echo "Commit ${BASELINE_SHA} is recent enough"
- echo "Checking if image exists for commit ${BASELINE_SHA}..."
- "while [[ ! $(aws ecr describe-images --region us-west-2 --profile single-machine-performance\
\ --registry-id \"${SMP_ACCOUNT_ID}\" --repository-name \"${SMP_AGENT_TEAM_ID}-agent\"\
\ --image-ids imageTag=\"${BASELINE_SHA}-7-amd64\") ]]\ndo\n echo \"No image\
\ exists for ${BASELINE_SHA} - checking predecessor of ${BASELINE_SHA} next\"\n\
\ BASELINE_SHA=$(git rev-parse ${BASELINE_SHA}^)\n echo \"Checking if commit\
\ ${BASELINE_SHA} is recent enough...\"\n BASELINE_COMMIT_TIME=$(git -c log.showSignature=false\
\ show --no-patch --format=%ct ${BASELINE_SHA})\n if [[ ${BASELINE_COMMIT_TIME}\
\ -le ${FOUR_DAYS_BEFORE_NOW} ]]\n then\n echo \"ERROR: Merge-base of\
\ this branch is too old for SMP. Please update your branch by merging an up-to-date\
\ main branch into your branch or by rebasing it on an up-to-date main branch.\"\
\n exit 1\n fi\n echo \"Commit ${BASELINE_SHA} is recent enough\"\
\n echo \"Checking if image exists for commit ${BASELINE_SHA}...\"\ndone\n"
- echo "Image exists for commit ${BASELINE_SHA}"
- echo "Baseline SHA is ${BASELINE_SHA}"
- echo -n "${BASELINE_SHA}" > "${CI_COMMIT_SHA}-baseline_sha"
- aws s3 cp --profile single-machine-performance --only-show-errors "${CI_COMMIT_SHA}-baseline_sha"
"s3://${SMP_AGENT_TEAM_ID}-smp-artifacts/information/"
- BASELINE_IMAGE=${SMP_ECR_URL}/${SMP_AGENT_TEAM_ID}-agent:${BASELINE_SHA}-7-amd64
- echo "${BASELINE_SHA} | ${BASELINE_IMAGE}"
- COMPARISON_IMAGE=${SMP_ECR_URL}/${SMP_AGENT_TEAM_ID}-agent:${CI_COMMIT_SHA}-7-amd64
- echo "${CI_COMMIT_SHA} | ${COMPARISON_IMAGE}"
- RUST_LOG="info,aws_config::profile::credentials=error"
- RUST_LOG_DEBUG="debug,aws_config::profile::credentials=error"
- RUST_LOG="${RUST_LOG}" ./smp --team-id ${SMP_AGENT_TEAM_ID} --api-base ${SMP_API}
--aws-named-profile ${AWS_NAMED_PROFILE} job submit --baseline-image ${BASELINE_IMAGE}
--comparison-image ${COMPARISON_IMAGE} --baseline-sha ${BASELINE_SHA} --comparison-sha
${CI_COMMIT_SHA} --target-config-dir test/regression/ --submission-metadata submission_metadata
- RUST_LOG="${RUST_LOG}" ./smp --team-id ${SMP_AGENT_TEAM_ID} --api-base ${SMP_API}
--aws-named-profile ${AWS_NAMED_PROFILE} job status --wait --wait-delay-seconds
60 --submission-metadata submission_metadata
- RUST_LOG="${RUST_LOG}" ./smp --team-id ${SMP_AGENT_TEAM_ID} --api-base ${SMP_API}
--aws-named-profile ${AWS_NAMED_PROFILE} job sync --submission-metadata submission_metadata
--output-path outputs
- cat outputs/report.md | sed "s/^\$/$(echo -ne '\uFEFF\u00A0\u200B')/g"
- DATADOG_API_KEY="$("$CI_PROJECT_DIR"/tools/ci/fetch_secret.sh "$AGENT_API_KEY_ORG2"
token)" || exit $?; export DATADOG_API_KEY
- datadog-ci junit upload --service datadog-agent outputs/junit.xml
- "python3 <<'EOF'\nimport json\nimport sys\n\ntry:\n with open('outputs/report.json')\
\ as f:\n data = json.load(f)\nexcept FileNotFoundError:\n print(\"\
Machine readable report not found.\")\n sys.exit(1)\nexcept json.JSONDecodeError\
\ as e:\n print(f\"Error parsing JSON report: {e}\")\n sys.exit(1)\n\nexperiments\
\ = data.get('experiments', {})\nfailed = False\ndecision_record = []\n\nfor exp_name,\
\ exp_data in experiments.items():\n if exp_name.startswith('quality_gate_'):\n\
\ bounds_checks = exp_data.get('bounds_checks', {})\n for check_name,\
\ check_data in bounds_checks.items():\n results = check_data.get('results',\
\ {})\n comparison = results.get('comparison', [])\n num_total\
\ = len(comparison)\n failed_replicates = [\n replicate\
\ for replicate in comparison if not replicate.get('passed', False)\n \
\ ]\n num_failed = len(failed_replicates)\n num_passed\
\ = num_total - num_failed\n if failed_replicates:\n \
\ decision_record.append(\n f\"- **{exp_name}**, bounds check\
\ **{check_name}**: {num_passed}/{num_total} replicas passed. Failed {num_failed}\
\ which is > 0. Gate **FAILED**.\"\n )\n failed\
\ = True\n else:\n decision_record.append(\n \
\ f\"- **{exp_name}**, bounds check **{check_name}**: {num_passed}/{num_total}\
\ replicas passed. Gate passed.\"\n )\n\nwith open('outputs/decision_record.md',\
\ 'w') as f:\n # Extra newline since this is appended to another report\n \
\ f.write('\\n\\n## CI Pass/Fail Decision\\n\\n')\n if failed:\n f.write('\u274C\
\ **Failed.** Some Quality Gates were violated.\\n\\n')\n f.write('\\n'.join(decision_record))\n\
\ else:\n f.write('\u2705 **Passed.** All Quality Gates passed.\\n\\\
n')\n f.write('\\n'.join(decision_record))\n\nif failed:\n print(\"\
Quality gate failed, see decision record\")\n sys.exit(1)\nelse:\n print(\"\
Quality gate passed.\")\n sys.exit(0)\nEOF\n"
stage: functional_test
tags:
- arch:amd64
timeout: 1h10m
variables:
SMP_VERSION: 0.18.2single-machine-performance-regression_detector-pr-comment single-machine-performance-regression_detector-pr-comment:
allow_failure: true
artifacts:
expire_in: 1 weeks
paths:
- report_as_json_string.txt
- pr_comment_payload.json
image:
entrypoint:
- ''
name: 486234852809.dkr.ecr.us-east-1.amazonaws.com/pr-commenter:3
needs:
- job: single-machine-performance-regression_detector
rules:
- - if: $CI_COMMIT_BRANCH == "main"
- when: never
- if: $CI_COMMIT_BRANCH =~ /^[0-9]+\.[0-9]+\.x$/
when: never
- if: $CI_COMMIT_BRANCH =~ /^mq-working-branch-/
when: never
- when: always
script:
- "if [[ ! -s \"outputs/report.md\" ]]\nthen\n echo \"ERROR: Regression Detector\
\ report not found -- no PR comment posted\"\n exit 1\nfi\n"
- cat outputs/report.md outputs/decision_record.md | sed -z 's/\n/\\n/g' | sed -z
's/"/\\"/g' > report_as_json_string.txt
- cat report_as_json_string.txt
- PR_COMMENT_JSON_PAYLOAD='{"org":"DataDog", "repo":"datadog-agent", "commit":"'"${CI_COMMIT_SHA}"'",
"header":"Regression Detector", "message":"'"$(cat report_as_json_string.txt)"'"}'
- printf "%s\n" "PR comment JSON payload:${PR_COMMENT_JSON_PAYLOAD}"
- printf "%s\n" "${PR_COMMENT_JSON_PAYLOAD}" > pr_comment_payload.json
- "set +e\nout=$(curl https://pr-commenter.us1.ddbuild.io/internal/cit/pr-comment\
\ \\\n -H \"$(authanywhere)\" \\\n -H \"X-DdOrigin: curl\" \\\n -X PATCH\
\ \\\n -d \"${PR_COMMENT_JSON_PAYLOAD}\")\nexitcode=$?\nset -e\nif [ -n \"\
${out}\" ]; then\n if [ $exitcode -eq 0 ]; then\n echo $out\n else\n echo\
\ $out >&2\n fi\nfi\nif [ \"${out}\" != \"${out/invalid request: no pr found\
\ for this commit}\" ]; then\n exit 0\nfi\nexit $exitcode\n"
stage: functional_test
tags:
- arch:amd64
variables:
FF_KUBERNETES_HONOR_ENTRYPOINT: falseAdded Jobs.except_release_branch.except_release_branch:
- if: $CI_COMMIT_BRANCH =~ /^[0-9]+\.[0-9]+\.x$/
when: never
- if: $CI_COMMIT_BRANCH =~ /^mq-working-branch-/
when: neverChanges Summary
ℹ️ Diff available in the job log. |
|
[Fast Unit Tests Report] On pipeline 49076582 (CI Visibility). The following jobs did not run any unit tests: Jobs:
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 DetectorRegression Detector ResultsMetrics dashboard Baseline: 37e69fb Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | pycheck_lots_of_tags | % cpu utilization | +0.87 | [-2.62, +4.35] | 1 | Logs |
| ➖ | otel_to_otel_logs | ingress throughput | +0.85 | [+0.23, +1.48] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | +0.43 | [+0.37, +0.50] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle_all_features | memory utilization | +0.34 | [+0.22, +0.46] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | +0.12 | [-0.12, +0.37] | 1 | Logs |
| ➖ | file_to_blackhole_300ms_latency | egress throughput | +0.04 | [-0.15, +0.23] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | +0.01 | [-0.50, +0.51] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | +0.00 | [-0.09, +0.09] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | -0.00 | [-0.01, +0.01] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | -0.00 | [-0.32, +0.32] | 1 | Logs |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | -0.05 | [-0.09, -0.01] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | -0.30 | [-0.78, +0.19] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency_linear_load | egress throughput | -0.35 | [-0.84, +0.14] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api_cpu | % cpu utilization | -0.43 | [-1.15, +0.30] | 1 | Logs |
| ➖ | basic_py_check | % cpu utilization | -1.42 | [-5.23, +2.39] | 1 | Logs |
| ➖ | file_tree | memory utilization | -2.48 | [-2.62, -2.34] | 1 | Logs |
Bounds Checks: ❌ Failed
| perf | experiment | bounds_check_name | replicates_passed | links |
|---|---|---|---|---|
| ❌ | quality_gate_idle | memory_usage | 2/10 | bounds checks dashboard |
| ❌ | quality_gate_idle_all_features | memory_usage | 9/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_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 | memory_usage | 10/10 | |
| ✅ | file_to_blackhole_500ms_latency | 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:
-
Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.
-
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.
-
Its configuration does not mark it "erratic".
CI Pass/Fail Decision
❌ Failed. Some Quality Gates were violated.
- quality_gate_idle, bounds check memory_usage: 2/10 replicas passed. Failed 8 which is > 0. Gate FAILED.
- quality_gate_idle_all_features, bounds check memory_usage: 9/10 replicas passed. Failed 1 which is > 0. Gate FAILED.
GeorgeHahn
reviewed
Nov 14, 2024
.gitlab-ci.yml
Outdated
| SSH_PUBLIC_KEY_RSA: ci.datadog-agent.ssh_public_key_rsa # agent-devx-loops | ||
| VCPKG_BLOB_SAS_URL: ci.datadog-agent-buildimages.vcpkg_blob_sas_url # windows-agent | ||
| WINGET_PAT: ci.datadog-agent.winget_pat # windows-agent | ||
| AGENT_QA_PROFILE: ci.datadog-agent.agent-qa-profile # agent-devx-infra |
There was a problem hiding this comment.
Nit, prefer not having formatting changes in the same commit
GeorgeHahn
approved these changes
Nov 14, 2024
goxberry
approved these changes
Nov 14, 2024
|
/merge |
Devflow running:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Github's branch protection seems to not include jobs that don't run on
main.SMP is making this job required soon (planned tomorrow) and this change should allow this job name to show up correctly in github and allow it to be a required check.
Motivation
SMP is making this job required soon (planned tomorrow) and this change should allow this job name to show up correctly in github and allow it to be a required check.
Describe how to test/QA your changes
n/a
Possible Drawbacks / Trade-offs
Additional Notes