-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
[APM] Normalize X-Datadog-Container-Tags header #28662
Conversation
HTTP header values cannot contain line breaks. This PR ensures that if Container Tags contain line breaks, the value is sanitized to replace those line breaks with underscores. It would otherwise result in an invalid header/request.
Test changes on VMUse this command from test-infra-definitions to manually test this PR changes on a VM: inv create-vm --pipeline-id=42588293 --os-family=ubuntu Note: This applies to commit bad09ab |
Regression DetectorRegression Detector ResultsRun ID: 97939add-d4b0-4705-b827-3c5ecc18a75d Metrics dashboard Target profiles Baseline: e28eea1 Performance changes are noted in the perf column of each table:
No significant changes in experiment optimization goalsConfidence level: 90.00% There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.
|
perf | experiment | goal | Δ mean % | Δ mean % CI | links |
---|---|---|---|---|---|
➖ | uds_dogstatsd_to_api_cpu | % cpu utilization | +0.56 | [-0.23, +1.36] | Logs |
➖ | otel_to_otel_logs | ingress throughput | +0.47 | [-0.34, +1.28] | Logs |
➖ | pycheck_lots_of_tags | % cpu utilization | +0.11 | [-2.45, +2.67] | Logs |
➖ | uds_dogstatsd_to_api | ingress throughput | +0.00 | [-0.00, +0.00] | Logs |
➖ | tcp_dd_logs_filter_exclude | ingress throughput | -0.00 | [-0.01, +0.01] | Logs |
➖ | idle | memory utilization | -0.16 | [-0.20, -0.12] | Logs |
➖ | basic_py_check | % cpu utilization | -1.07 | [-3.68, +1.55] | Logs |
➖ | file_tree | memory utilization | -1.26 | [-1.35, -1.18] | Logs |
➖ | tcp_syslog_to_blackhole | ingress throughput | -4.93 | [-17.30, +7.45] | Logs |
Bounds Checks
perf | experiment | bounds_check_name | replicates_passed |
---|---|---|---|
✅ | idle | 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:
-
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".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm really surprised the net/http
library doesn't handle this somehow.
The values that can go in an http header are limited, but it doesn't look like .Set()
normalizes or validates the values, nor can I find a function to validate values manually.
We may want to at least check for \r
and \n
, but should we do more?
I'm basing this on the syntax rules from the current HTTP RFC: https://www.rfc-editor.org/rfc/rfc9112#name-message-parsing.
/merge |
🚂 MergeQueue: pull request added to the queue The median merge time in Use |
(cherry picked from commit 296ae23)
HTTP header values cannot contain line breaks. This PR ensures that if Container Tags contain line breaks, the value is sanitized to replace those line breaks with underscores. It would otherwise result in an invalid header/request.
What does this PR do?
This is a fix for https://datadoghq.atlassian.net/browse/APMS-13035
HTTP header values cannot contain line breaks. This PR ensures that if Container Tags contain line breaks, the value is sanitized to replace those line breaks with underscores. It would otherwise result in an invalid header/request.
Motivation
https://datadoghq.atlassian.net/browse/APMS-13035
Additional Notes
Possible Drawbacks / Trade-offs
Describe how to test/QA your changes