fix(notify): Handle case with undefined variable #32165
Conversation
chouetz
added
changelog/no-changelog
qa/no-code-change
Gitlab CI Configuration ChangesModified Jobsnotify notify:
dependencies: []
image: registry.ddbuild.io/slack-notifier:v27936653-9a2a7db-sdm-gbi-jammy@sha256:c9d1145319d1904fa72ea97904a15200d3cb684324723f9e1700bc02cc85065c
resource_group: notification
rules:
- if: $DEPLOY_AGENT == "true" || $DDR_WORKFLOW_ID != null
when: always
- if: $CI_COMMIT_BRANCH == "main"
when: always
- if: $CI_COMMIT_BRANCH =~ /^[0-9]+\.[0-9]+\.x$/
when: always
script:
- GITLAB_TOKEN=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $GITLAB_TOKEN read_api)
|| exit $?; export GITLAB_TOKEN
- DD_API_KEY=$($CI_PROJECT_DIR/tools/ci/fetch_secret.sh $AGENT_API_KEY_ORG2 token)
|| exit $?; export DD_API_KEY
- python3 -m pip install -r requirements.txt -r tasks/libs/requirements-notifications.txt
+ - invoke -e notify.send-message -p $CI_PIPELINE_ID
+ - invoke -e notify.check-consistent-failures -p $CI_PIPELINE_ID
- - "# Do not send notifications if this is a child pipeline of another repo\n# The\
- \ triggering repo should already have its own notification system\nif [ \"$CI_PIPELINE_SOURCE\"\
- \ != \"pipeline\" ]; then\n if [ \"$DEPLOY_AGENT\" = \"true\" ]; then\n invoke\
- \ -e notify.send-message --notification-type \"deploy\"\n elif [ \"$CI_PIPELINE_SOURCE\"\
- \ != \"push\" ]; then\n invoke -e notify.send-message --notification-type \"\
- trigger\"\n else\n invoke -e notify.send-message --notification-type \"merge\"\
- \n fi\n if [ \"$CI_COMMIT_BRANCH\" = \"$CI_DEFAULT_BRANCH\" ]; then\n invoke\
- \ notify.check-consistent-failures\n fi\nelse\n echo \"This pipeline was triggered\
- \ by another repository, skipping notification.\"\nfi\n"
stage: notify
tags:
- arch:amd64
timeout: 15 minutesChanges Summary
ℹ️ Diff available in the job log. |
|
[Fast Unit Tests Report] On pipeline 51462650 (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 |
Uncompressed package size comparisonComparison with ancestor Diff per package
Decision |
tasks/libs/notify/utils.py
Outdated
| return ( | ||
| os.environ['CI_PIPELINE_SOURCE'] != 'pipeline' | ||
| or os.environ['CI_PIPELINE_SOURCE'] == 'pipeline' | ||
| and pipeline.user['id'] == CONDUCTOR_ID |
There was a problem hiding this comment.
Are we reasonably confident that the conductor id is not going to change over time?
There was a problem hiding this comment.
It is the ID of the conductor user that triggers the pipeline. Even if I see no reason for it to change, I might think about a warning if this changes, indeed.
An alternative would be to notified on non codesync downstream, but this is weak as well, as we can have manually triggered pipelines.
There was a problem hiding this comment.
I changed this to use the environment variables that are passed by the conductor nightly pipeline here
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: f95df91 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gate_logs | % cpu utilization | +1.74 | [-1.21, +4.70] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | +0.10 | [-0.76, +0.96] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | +0.02 | [-0.67, +0.71] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency_http1 | egress throughput | +0.00 | [-0.87, +0.87] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | +0.00 | [-0.01, +0.01] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | -0.01 | [-0.11, +0.10] | 1 | Logs |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | -0.03 | [-0.10, +0.03] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | -0.07 | [-0.83, +0.69] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | -0.10 | [-0.15, -0.06] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_0ms_latency_http2 | egress throughput | -0.14 | [-0.94, +0.66] | 1 | Logs |
| ➖ | file_to_blackhole_300ms_latency | egress throughput | -0.17 | [-0.80, +0.47] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency_linear_load | egress throughput | -0.23 | [-0.69, +0.24] | 1 | Logs |
| ➖ | file_tree | memory utilization | -0.25 | [-0.38, -0.13] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.34 | [-0.44, -0.23] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | -0.63 | [-1.43, +0.17] | 1 | Logs |
| ➖ | otel_to_otel_logs | ingress throughput | -1.23 | [-1.94, -0.51] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api_cpu | % cpu utilization | -2.24 | [-2.96, -1.52] | 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:
-
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
✅ 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, 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.
tasks/libs/notify/utils.py
Outdated
| ) | ||
|
|
||
|
|
||
| def notification_type(): |
There was a problem hiding this comment.
💬 suggestion
Rather than the notification type (slack, email), this looks like the pipeline type. Suggesting changing the name accordingly
| def notification_type(): | |
| def pipeline_type_from_env(): |
…g and change the conductor origin detection
chouetz
force-pushed
the
nschweitzer/conductor
branch
from
14b6b63 to
acddb29
Compare
What does this PR do?
Prevent hard failure in the script when the
DEPLOY_AGENTenvironment variable is not definedMotivation
#incident-33274 and failure on the notify job
https://datadoghq.atlassian.net/browse/ACIX-507
Describe how you validated your changes
Updated the
TestSendMessage.test_mergeto not define theDEPLOY_AGENTvariable. The other env variables (CI_PIPELINE_SOURCE,CI_PIPELINE_IDare predefined gitlab ones, they must be defined.Possible Drawbacks / Trade-offs
The identification of the the conductor pipeline is based on the environment variables sent from here. As a consequence we could loss the detection of conductor pipelines if this happen to change
Additional Notes