Link SMP with CI #30861
Draft
Link SMP with CI #30861
+64
−21
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
cmetz100
added
changelog/no-changelog
team/single-machine-performance
github-actions
bot
added
the
short review
|
[Fast Unit Tests Report] On pipeline 49019030 (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: 0b38b96 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | pycheck_lots_of_tags | % cpu utilization | +3.40 | [-0.07, +6.86] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api_cpu | % cpu utilization | +0.29 | [-0.44, +1.01] | 1 | Logs |
| ➖ | file_tree | memory utilization | +0.21 | [+0.08, +0.34] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | +0.13 | [+0.09, +0.18] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle_all_features | memory utilization | +0.11 | [+0.02, +0.20] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | +0.07 | [-0.17, +0.31] | 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.48, +0.47] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | -0.00 | [-0.34, +0.33] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | -0.01 | [-0.50, +0.47] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | -0.03 | [-0.12, +0.07] | 1 | Logs |
| ➖ | file_to_blackhole_300ms_latency | egress throughput | -0.03 | [-0.23, +0.16] | 1 | Logs |
| ➖ | basic_py_check | % cpu utilization | -0.04 | [-3.81, +3.72] | 1 | Logs |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | -0.10 | [-0.16, -0.05] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency_linear_load | egress throughput | -0.36 | [-0.85, +0.12] | 1 | Logs |
| ➖ | otel_to_otel_logs | ingress throughput | -1.01 | [-1.70, -0.31] | 1 | Logs |
Bounds Checks: ❌ Failed
| perf | experiment | bounds_check_name | replicates_passed | links |
|---|---|---|---|---|
| ❌ | file_to_blackhole_0ms_latency | lost_bytes | 7/10 | |
| ❌ | file_to_blackhole_100ms_latency | lost_bytes | 8/10 | |
| ❌ | quality_gate_idle | memory_usage | 8/10 | bounds checks dashboard |
| ❌ | quality_gate_idle_all_features | memory_usage | 9/10 | bounds checks dashboard |
| ✅ | 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 | 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".
Gitlab CI Configuration ChangesModified Jobssingle-machine-performance-regression_detector single-machine-performance-regression_detector:
allow_failure: true
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
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:
+ - DATADOG_API_KEY="$("$CI_PROJECT_DIR"/tools/ci/fetch_secret.sh "$AGENT_API_KEY_ORG2"
+ token)" || exit $?; export DATADOG_API_KEY
+ - datadog-ci tag --level job --tags smp_failure_mode:"unknown"
- 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"
+ \ up-to-date main branch.\"\n datadog-ci tag --level job --tags smp_failure_mode:\"\
+ old-merge-base\"\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 datadog-ci tag --level job --tags smp_failure_mode:\"old-predecessor-merge-base\"\
\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}"
+ - SMP_TAGS="ci_pipeline_id=${CI_PIPELINE_ID},ci_job_id=${CI_JOB_ID}"
+ - echo "Tags passed through SMP are ${SMP_TAGS}"
- 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}
+ - "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}
? ^^^^^^^^^^^^^^^^^^
+ \ --aws-named-profile ${AWS_NAMED_PROFILE} \\\njob submit \\\n--baseline-image\
? ++ ++++ ++++ ^
- --comparison-image ${COMPARISON_IMAGE} --baseline-sha ${BASELINE_SHA} --comparison-sha
- ${CI_COMMIT_SHA} --target-config-dir test/regression/ --submission-metadata submission_metadata
+ \ ${BASELINE_IMAGE} \\\n--comparison-image ${COMPARISON_IMAGE} \\\n--baseline-sha\
+ \ ${BASELINE_SHA} \\\n--comparison-sha ${CI_COMMIT_SHA} \\\n--target-config-dir\
+ \ test/regression/ \\\n--submission-metadata submission_metadata \\\n--tags ${SMP_TAGS}\
+ \ || {\n exit_code=$?\n echo \"job submit command failed\"\n datadog-ci tag\
+ \ --level job --tags smp_failure_mode:\"job-submit\"\n exit $exit_code\n}\n"
+ - SMP_JOB_ID=$(jq -r '.jobId' submission_metadata)
+ - echo "SMP Job Id is ${SMP_JOB_ID}"
+ - datadog-ci tag --level job --tags smp_job_id:${SMP_JOB_ID}
- - RUST_LOG="${RUST_LOG}" ./smp --team-id ${SMP_AGENT_TEAM_ID} --api-base ${SMP_API}
+ - "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
+ \ --aws-named-profile ${AWS_NAMED_PROFILE} \\\njob status \\\n--wait \\\n--wait-delay-seconds\
? ++ ++++ ++++ ++++ +
- 60 --submission-metadata submission_metadata
+ \ 60 \\\n--submission-metadata submission_metadata || {\n exit_code=$?\n echo\
+ \ \"job status command failed\"\n datadog-ci tag --level job --tags smp_failure_mode:\"\
+ job-status\"\n exit $exit_code\n}\n"
- - RUST_LOG="${RUST_LOG}" ./smp --team-id ${SMP_AGENT_TEAM_ID} --api-base ${SMP_API}
+ - "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
? ^^^^^^^^^^^^^^^^^^^^
+ \ --aws-named-profile ${AWS_NAMED_PROFILE} \\\njob sync \\\n--submission-metadata\
? ++ ++++ ++++ ^
- --output-path outputs
+ \ submission_metadata \\\n--output-path outputs || {\n exit_code=$?\n echo \"\
+ job sync command failed\"\n datadog-ci tag --level job --tags smp_failure_mode:\"\
+ job-sync\"\n exit $exit_code\n}\n"
- 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
- - RUST_LOG="${RUST_LOG}" ./smp --team-id ${SMP_AGENT_TEAM_ID} --api-base ${SMP_API}
+ - "RUST_LOG=\"${RUST_LOG}\" ./smp --team-id ${SMP_AGENT_TEAM_ID} --api-base ${SMP_API}\
? + + + +
- --aws-named-profile ${AWS_NAMED_PROFILE} job result --submission-metadata submission_metadata
? ^^^^^^^^^^^^^^^^^^^^
+ \ --aws-named-profile ${AWS_NAMED_PROFILE} \\\njob result \\\n--submission-metadata\
? ++ ++++ ++++ ^
+ \ submission_metadata || {\n exit_code=$?\n echo \"job result command failed,\
+ \ this is most likely a result of a regression\"\n datadog-ci tag --level job\
+ \ --tags smp_failure_mode:\"job-result\"\n exit $exit_code\n}\n"
+ - echo "script successfully executed"
+ - datadog-ci tag --level job --tags smp_failure_mode:"none"
stage: functional_test
tags:
- arch:amd64
timeout: 1h10m
variables:
SMP_VERSION: 0.18.1Changes Summary
ℹ️ Diff available in the job log. |
Signed-off-by: Caleb Metz <caleb.metz@datadoghq.com>
Signed-off-by: Caleb Metz <caleb.metz@datadoghq.com>
Signed-off-by: Caleb Metz <caleb.metz@datadoghq.com>
Signed-off-by: Caleb Metz <caleb.metz@datadoghq.com>
Signed-off-by: Caleb Metz <caleb.metz@datadoghq.com>
Signed-off-by: Caleb Metz <caleb.metz@datadoghq.com>
cmetz100
force-pushed
the
cmetz/link_smp_with_ci
branch
from
f19a8aa
to
54e9f17
Compare
Signed-off-by: Caleb Metz <caleb.metz@datadoghq.com>
Signed-off-by: Caleb Metz <caleb.metz@datadoghq.com>
Signed-off-by: Caleb Metz <caleb.metz@datadoghq.com>
Signed-off-by: Caleb Metz <caleb.metz@datadoghq.com>
Signed-off-by: Caleb Metz <caleb.metz@datadoghq.com>
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?
Adds
CI_PIPELINE_IDandCI_JOB_IDas tags passed through SMP jobs (tagged in smp asci_pipeline_idandci_job_idrespectively). Also adds the SMP job id as a tag to the gitlab job seen in CI Visibility (smp_job_id). In addition we catch errors caused by smp commands and label the job accordingly. If the job succeedssmp_failure_modewill benone. If the job fails for any other reason besides an smp command failure thensmp_failure_modewill beunknown. Note, timeouts will naturally fall under this tag as well. However, you can filter jobs by failure type to differentiate between an actualunknownfailure and a timeout failure. In addition, the duration of jobs tends to be a clear sign of timing out. Another thing to note issmp job resultwill fail if there is a regression so asmp_failure_mode:job-resultis most likely due to a regression (of course it is not impossible that the command itself failed in some way).Motivation
When analyzing job execution behavior, whether that be failures (including what types of failures), job execution time, or anything else provided by CI Visibility and SMP, we need a better way to link a SMP run to its corresponding CI run in the agent. In addition to the linking between SMP and CI Vis, this PR also works to give more granularity into the failure modes of the single-machine-performance-regression_detector job.
Additional Notes
Open Questions:
Would it be useful to tag jobs when they fallback to a predecessor merge-base?
SMPTNG-516
SMPTNG-519