-
Couldn't load subscription status.
- Fork 1.4k
fix(ssi): merge target and namespace implementations #42068
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
fix(ssi): merge target and namespace implementations #42068
Conversation
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: c806836 Optimization Goals: ❌ Regression(s) detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ✅ | docker_containers_cpu | % cpu utilization | -11.84 | [-13.40, -10.27] | 1 | Logs |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ❌ | docker_containers_memory | memory utilization | +7.89 | [+7.41, +8.36] | 1 | Logs |
| ➖ | quality_gate_metrics_logs | memory utilization | +0.70 | [+0.51, +0.90] | 1 | Logs bounds checks dashboard |
| ➖ | file_tree | memory utilization | +0.48 | [+0.42, +0.54] | 1 | Logs |
| ➖ | otlp_ingest_metrics | memory utilization | +0.17 | [+0.05, +0.29] | 1 | Logs |
| ➖ | otlp_ingest_logs | memory utilization | +0.17 | [+0.03, +0.30] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulative | memory utilization | +0.13 | [+0.01, +0.25] | 1 | Logs |
| ➖ | ddot_logs | memory utilization | +0.08 | [+0.01, +0.15] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | +0.06 | [-0.54, +0.67] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | +0.01 | [-0.21, +0.23] | 1 | Logs |
| ➖ | ddot_metrics | memory utilization | +0.01 | [-0.16, +0.18] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | +0.00 | [-0.61, +0.61] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | -0.00 | [-0.01, +0.01] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulativetodelta_exporter | memory utilization | -0.02 | [-0.22, +0.18] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | -0.04 | [-0.64, +0.56] | 1 | Logs |
| ➖ | quality_gate_idle | memory utilization | -0.04 | [-0.09, +0.00] | 1 | Logs bounds checks dashboard |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | -0.09 | [-0.69, +0.50] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | -0.27 | [-0.31, -0.22] | 1 | Logs bounds checks dashboard |
| ➖ | uds_dogstatsd_20mb_12k_contexts_20_senders | memory utilization | -0.61 | [-0.66, -0.55] | 1 | Logs |
| ➖ | ddot_metrics_sum_delta | memory utilization | -0.71 | [-0.87, -0.56] | 1 | Logs |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | -1.52 | [-1.59, -1.44] | 1 | Logs |
| ➖ | quality_gate_logs | % cpu utilization | -1.63 | [-4.42, +1.15] | 1 | Logs bounds checks dashboard |
| ✅ | docker_containers_cpu | % cpu utilization | -11.84 | [-13.40, -10.27] | 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 | 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_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 intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check cpu_usage: 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 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.
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
|
| mockConfig.SetWithoutSource("admission_controller.mutate_unlabelled", false) | ||
| }, | ||
| }, | ||
| { |
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.
We had three versions of this test initially 😅
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.
Great cleanup! Have a few suggestions/questions on the implementation wrt annotations/target simplification
pkg/clusteragent/admission/mutate/autoinstrumentation/target_mutator.go
Outdated
Show resolved
Hide resolved
pkg/clusteragent/admission/mutate/autoinstrumentation/target_mutator.go
Outdated
Show resolved
Hide resolved
pkg/clusteragent/admission/mutate/autoinstrumentation/target_mutator.go
Outdated
Show resolved
Hide resolved
| // we would inject all SDKs to all pods. This target encompasses both of those cases. | ||
| func createDefaultTarget(namespaces []string, pinnedLibVersions map[string]string) Target { | ||
| // Create a default target. | ||
| target := Target{ |
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.
Right now we add an annotation to the pod that says which target this is coming from and what the configuration is.
Is that consistent for the behavior from namespaces? We'll have an applied-target with this JSON format?
What happens for the annotation? I'm not sure we should be adding an applied-target annotation there
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.
For enabledNamespaces, the generated target applies. I updated this change to no longer apply an annotation for local lib injection.
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.
Thanks!
| // getEnabledLable is a helper function to convert the found value from a string | ||
| // to a boolean. | ||
| func getEnabledLabel(pod *corev1.Pod) (bool, bool) { | ||
| val, found := pod.GetLabels()[common.EnabledLabelKey] |
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.
We should consolidate to using this in the common package:
datadog-agent/pkg/clusteragent/admission/mutate/common/filter.go
Lines 135 to 163 in 8ff7142
| type podMutationLabelFlag int | |
| const ( | |
| podMutationUnspecified podMutationLabelFlag = iota | |
| podMutationEnabled | |
| podMutationDisabled | |
| ) | |
| // getPodMutationLabelFlag returns podMutationUnspecified if the label is not | |
| // set or if the label is set to an invalid value. | |
| func getPodMutationLabelFlag(pod *corev1.Pod) podMutationLabelFlag { | |
| if val, found := pod.GetLabels()[common.EnabledLabelKey]; found { | |
| switch val { | |
| case "true": | |
| return podMutationEnabled | |
| case "false": | |
| return podMutationDisabled | |
| default: | |
| log.Warnf( | |
| "Invalid label value '%s=%s' on pod %s should be either 'true' or 'false', ignoring it", | |
| common.EnabledLabelKey, | |
| val, | |
| PodString(pod), | |
| ) | |
| } | |
| } | |
| return podMutationUnspecified | |
| } |
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.
Created this task as a follow up. I'd like to give these methods some love as part of that change and don't want to touch too much as part of this change: https://datadoghq.atlassian.net/browse/INPLAT-813
pkg/clusteragent/admission/mutate/autoinstrumentation/target_mutator_test.go
Outdated
Show resolved
Hide resolved
releasenotes-dca/notes/merge-namespace-targets-4c82b02d2c1dc1ca.yaml
Outdated
Show resolved
Hide resolved
pkg/clusteragent/admission/mutate/autoinstrumentation/target_mutator.go
Outdated
Show resolved
Hide resolved
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.
Requesting a few updates for branding, style, and clarity
releasenotes-dca/notes/merge-namespace-targets-4c82b02d2c1dc1ca.yaml
Outdated
Show resolved
Hide resolved
releasenotes-dca/notes/merge-namespace-targets-4c82b02d2c1dc1ca.yaml
Outdated
Show resolved
Hide resolved
releasenotes-dca/notes/merge-namespace-targets-4c82b02d2c1dc1ca.yaml
Outdated
Show resolved
Hide resolved
releasenotes-dca/notes/merge-namespace-targets-4c82b02d2c1dc1ca.yaml
Outdated
Show resolved
Hide resolved
releasenotes-dca/notes/merge-namespace-targets-4c82b02d2c1dc1ca.yaml
Outdated
Show resolved
Hide resolved
When we introduced targets, we created a seperate code path to handle the target based configuration. However, the namespace based configuration can also be represented and supported by the target implementation. This commit merges the two.
Co-authored-by: Stan Rozenraukh <[email protected]>
Co-authored-by: Stan Rozenraukh <[email protected]>
Co-authored-by: Stan Rozenraukh <[email protected]>
Co-authored-by: Bryce Eadie <[email protected]>
240bb7e to
c3b64e1
Compare
|
/merge |
|
View all feedbacks in Devflow UI.
This merge request is not mergeable according to GitHub. Common reasons include pending required checks, missing approvals, or merge conflicts — but it could also be blocked by other repository rules or settings.
The expected merge time in
|
What does this PR do?
When we introduced targets, we created a separate code path to handle the target based configuration. However, the namespace based configuration can also be represented and supported by the target implementation. This commit merges the two implementations.
When I merged these in code, I found bugs in the target implementation surrounding Local SDK Injection and how it was handled with targets defined. This change fixes those bugs to match the expectations around enabledNamespaces.
Motivation
We want to reduce the complexity of the auto instrumentation webhook. There is no need to have two implementations to support our customer facing configuration options and as shown with this change, two implementations open up more chances for bugs.
See SSI Kubernetes | Platform Stability for more details on all changes related to cleanup.
Describe how you validated your changes
I tested this change heavily using injector-dev. For each scenario listed, I ran with and without the
--buildflag to use the latest agent release vs this branch to ensure there was a seamless migration path.Broken annotation based injection with target list
This should have injection but it does not currently:
Annotation based injection
We expect injection:
Namespace based selection
We expect injection:
Workload selection
We expect injection:
Instrumentation disabled
We expect no injection to occur:
Additional Notes
This change opted to not change the behavior of any tests and to keep test changes minimal. A follow up PR will rewrite some of these tests to test the webhook behavior more directly.