-
Notifications
You must be signed in to change notification settings - Fork 1.4k
[CWS] Improve documentation for setsockopt fields #43610
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
Conversation
c0f4b89 to
a490e87
Compare
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
|
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: 5acfb51 Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | -0.96 | [-3.89, +1.97] | 1 | Logs |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | quality_gate_logs | % cpu utilization | +1.53 | [+0.08, +2.98] | 1 | Logs bounds checks dashboard |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | +1.26 | [+1.20, +1.33] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | +0.28 | [+0.23, +0.33] | 1 | Logs bounds checks dashboard |
| ➖ | file_tree | memory utilization | +0.19 | [+0.15, +0.24] | 1 | Logs |
| ➖ | ddot_metrics_sum_delta | memory utilization | +0.17 | [-0.04, +0.38] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulativetodelta_exporter | memory utilization | +0.17 | [-0.07, +0.40] | 1 | Logs |
| ➖ | ddot_metrics | memory utilization | +0.16 | [-0.04, +0.37] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulative | memory utilization | +0.15 | [+0.00, +0.30] | 1 | Logs |
| ➖ | docker_containers_memory | memory utilization | +0.13 | [+0.05, +0.22] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api_v3 | ingress throughput | -0.00 | [-0.14, +0.13] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | -0.00 | [-0.08, +0.08] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | -0.00 | [-0.13, +0.12] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | -0.02 | [-0.07, +0.03] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | -0.04 | [-0.44, +0.36] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.05 | [-0.10, -0.00] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | -0.06 | [-0.44, +0.32] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | -0.08 | [-0.45, +0.29] | 1 | Logs |
| ➖ | uds_dogstatsd_20mb_12k_contexts_20_senders | memory utilization | -0.15 | [-0.20, -0.10] | 1 | Logs |
| ➖ | otlp_ingest_logs | memory utilization | -0.19 | [-0.30, -0.09] | 1 | Logs |
| ➖ | ddot_logs | memory utilization | -0.28 | [-0.34, -0.22] | 1 | Logs |
| ➖ | quality_gate_metrics_logs | memory utilization | -0.58 | [-0.78, -0.37] | 1 | Logs bounds checks dashboard |
| ➖ | otlp_ingest_metrics | memory utilization | -0.80 | [-0.94, -0.66] | 1 | Logs |
| ➖ | docker_containers_cpu | % cpu utilization | -0.96 | [-3.89, +1.97] | 1 | Logs |
Bounds Checks: ✅ Passed
| perf | experiment | bounds_check_name | replicates_passed | links |
|---|---|---|---|---|
| ✅ | docker_containers_cpu | simple_check_run | 10/10 | |
| ✅ | docker_containers_memory | memory_usage | 10/10 | |
| ✅ | docker_containers_memory | simple_check_run | 10/10 | |
| ✅ | file_to_blackhole_0ms_latency | lost_bytes | 10/10 | |
| ✅ | file_to_blackhole_0ms_latency | memory_usage | 10/10 | |
| ✅ | file_to_blackhole_1000ms_latency | lost_bytes | 10/10 | |
| ✅ | file_to_blackhole_1000ms_latency | 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_500ms_latency | lost_bytes | 10/10 | |
| ✅ | file_to_blackhole_500ms_latency | memory_usage | 10/10 | |
| ✅ | quality_gate_idle | intake_connections | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_idle | memory_usage | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | intake_connections | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_idle_all_features | memory_usage | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_logs | intake_connections | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_logs | lost_bytes | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_logs | memory_usage | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | intake_connections | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | lost_bytes | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | memory_usage | 10/10 | bounds checks dashboard |
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_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check cpu_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_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
| | [`setsockopt.filter_hash`](#setsockopt-filter_hash-doc) | Hash of the currently attached filter using sha256. Only available if the optname is SO_ATTACH_FILTER | | ||
| | [`setsockopt.filter_instructions`](#setsockopt-filter_instructions-doc) | Instructions of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER | | ||
| | [`setsockopt.filter_len`](#setsockopt-filter_len-doc) | Length of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER | | ||
| | [`setsockopt.is_filter_truncated`](#setsockopt-is_filter_truncated-doc) | Indicates that the currently attached filter is truncated. Only available if the optname is SO_ATTACH_FILTER | |
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.
| | [`setsockopt.filter_hash`](#setsockopt-filter_hash-doc) | Hash of the currently attached filter using sha256. Only available if the optname is SO_ATTACH_FILTER | | |
| | [`setsockopt.filter_instructions`](#setsockopt-filter_instructions-doc) | Instructions of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER | | |
| | [`setsockopt.filter_len`](#setsockopt-filter_len-doc) | Length of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER | | |
| | [`setsockopt.is_filter_truncated`](#setsockopt-is_filter_truncated-doc) | Indicates that the currently attached filter is truncated. Only available if the optname is SO_ATTACH_FILTER | | |
| | [`setsockopt.filter_hash`](#setsockopt-filter_hash-doc) | Hash of the currently attached filter using sha256. Only available if the optname is `SO_ATTACH_FILTER` | | |
| | [`setsockopt.filter_instructions`](#setsockopt-filter_instructions-doc) | Instructions of the currently attached filter. Only available if the optname is `SO_ATTACH_FILTER` | | |
| | [`setsockopt.filter_len`](#setsockopt-filter_len-doc) | Length of the currently attached filter. Only available if the optname is `SO_ATTACH_FILTER` | | |
| | [`setsockopt.is_filter_truncated`](#setsockopt-is_filter_truncated-doc) | Indicates that the currently attached filter is truncated. Only available if the optname is `SO_ATTACH_FILTER` | |
I think the name might be easier to pick out with some different formatting
| | [`setsockopt.socket_protocol`](#setsockopt-socket_protocol-doc) | Socket protocol | | ||
| | [`setsockopt.socket_type`](#setsockopt-socket_type-doc) | Socket type | | ||
| | [`setsockopt.used_immediates`](#setsockopt-used_immediates-doc) | List of immediate values used in the filter | | ||
| | [`setsockopt.used_immediates`](#setsockopt-used_immediates-doc) | List of immediate values used in the currently attached filter. Only available if the optname is SO_ATTACH_FILTER | |
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.
| | [`setsockopt.used_immediates`](#setsockopt-used_immediates-doc) | List of immediate values used in the currently attached filter. Only available if the optname is SO_ATTACH_FILTER | | |
| | [`setsockopt.used_immediates`](#setsockopt-used_immediates-doc) | List of immediate values used in the currently attached filter. Only available if the optname is `SO_ATTACH_FILTER` | |
| Type: string | ||
|
|
||
| Definition: Hash of the socket filter using sha256 | ||
| Definition: Hash of the currently attached filter using sha256. Only available if the optname is SO_ATTACH_FILTER |
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.
| Definition: Hash of the currently attached filter using sha256. Only available if the optname is SO_ATTACH_FILTER | |
| Definition: Hash of the currently attached filter using sha256. Only available if the optname is `SO_ATTACH_FILTER` |
| Type: string | ||
|
|
||
| Definition: Filter instructions | ||
| Definition: Instructions of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER |
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.
| Definition: Instructions of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER | |
| Definition: Instructions of the currently attached filter. Only available if the optname is `SO_ATTACH_FILTER` |
| Type: int | ||
|
|
||
| Definition: Length of the filter | ||
| Definition: Length of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER |
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.
| Definition: Length of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER | |
| Definition: Length of the currently attached filter. Only available if the optname is `SO_ATTACH_FILTER` |
| "link": "setsockopt-filter_hash-doc", | ||
| "type": "string", | ||
| "definition": "Hash of the socket filter using sha256", | ||
| "definition": "Hash of the currently attached filter using sha256. Only available if the optname is SO_ATTACH_FILTER", |
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.
| "definition": "Hash of the currently attached filter using sha256. Only available if the optname is SO_ATTACH_FILTER", | |
| "definition": "Hash of the currently attached filter using sha256. Only available if the optname is `SO_ATTACH_FILTER`", |
| "link": "setsockopt-filter_instructions-doc", | ||
| "type": "string", | ||
| "definition": "Filter instructions", | ||
| "definition": "Instructions of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER", |
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.
| "definition": "Instructions of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER", | |
| "definition": "Instructions of the currently attached filter. Only available if the optname is `SO_ATTACH_FILTER`", |
| "link": "setsockopt-filter_len-doc", | ||
| "type": "int", | ||
| "definition": "Length of the filter", | ||
| "definition": "Length of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER", |
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.
| "definition": "Length of the currently attached filter. Only available if the optname is SO_ATTACH_FILTER", | |
| "definition": "Length of the currently attached filter. Only available if the optname is `SO_ATTACH_FILTER`", |
| "link": "setsockopt-is_filter_truncated-doc", | ||
| "type": "bool", | ||
| "definition": "Indicates that the filter is truncated", | ||
| "definition": "Indicates that the currently attached filter is truncated. Only available if the optname is SO_ATTACH_FILTER", |
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.
| "definition": "Indicates that the currently attached filter is truncated. Only available if the optname is SO_ATTACH_FILTER", | |
| "definition": "Indicates that the currently attached filter is truncated. Only available if the optname is `SO_ATTACH_FILTER`", |
| "link": "setsockopt-used_immediates-doc", | ||
| "type": "int", | ||
| "definition": "List of immediate values used in the filter", | ||
| "definition": "List of immediate values used in the currently attached filter. Only available if the optname is SO_ATTACH_FILTER", |
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.
| "definition": "List of immediate values used in the currently attached filter. Only available if the optname is SO_ATTACH_FILTER", | |
| "definition": "List of immediate values used in the currently attached filter. Only available if the optname is `SO_ATTACH_FILTER`", |
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.
You're right. Since these files are auto-generated, I'll check if I can make it how you suggested :)
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.
It's done! I will merge.
587e3ee to
1bc3c25
Compare
|
/trigger-ci |
|
View all feedbacks in Devflow UI.
Post "https://gitlab.ddbuild.io/api/v4/projects/DataDog%2Fdatadog-agent/pipeline": net/http: request canceled (Client.Timeout exceeded while awaiting headers) DetailsIf you need support, contact us on Slack #devflow with those details! |
1bc3c25 to
164f707
Compare
|
/merge |
|
View all feedbacks in Devflow UI.
The expected merge time in
|
What does this PR do?
This PR improves the definition of some fields of the setsockopt event type.
Motivation
Some definitions lacked important information—for example, that certain fields are only present when setsockopt is invoked with specific options or in specific contexts.
Describe how you validated your changes
Additional Notes