Skip to content
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

feat(ssi): add namespace support for labels/expressions #33796

Merged
merged 6 commits into from
Feb 10, 2025

Conversation

betterengineering
Copy link
Member

@betterengineering betterengineering commented Feb 6, 2025

What does this PR do?

This commit adds the ability to use a namespace selector to match against namespaces defined in the targets list. For example, this config will match a pod in a namespace with tracing: yes and env: prod:

    - name: "Enabled Prod Namespaces"
        namespaceSelector:
          matchLabels:
            tracing: "yes"
          matchExpressions:
            - key: "env"
              operator: "In"
              values:
                - "prod"
        ddTraceVersions:
          python: "default" 

This PR maintains the ability to use matchNames as a convenience method. For example, this config would match the billing-service namespace:

      - name: "Billing Service"
        namespaceSelector:
          matchNames:
          - "billing-service"
        ddTraceVersions:
          python: "default"       

Motivation

This change is adding the full support for namespaces defined in Kubernetes SSI | Workload Selection 🎯. It was not added to the change in feat(ssi): add target based filtering as it required a bit more effort to get correct.

Describe how you validated your changes

The added unit tests offer strong coverage of these changes. To ensure they worked outside of unit tests, I also ran the following tests.

Metadata collection

To ensure that the metadata collection for namespaces is enabled, I used the following Helm config:

  datadog_cluster_yaml:
    apm_config:
      instrumentation:
        enabled: true
        targets:
          - name: "Microservices"
            selector:
              matchLabels:
                language: "python"
            ddTraceVersions:
              python: "default"

I ran the following:

 kubectl -n system exec -it svc/datadog-agent-cluster-agent -c cluster-agent -- agent workload-list

Here is a snippet of the output with my namespaces defined:

...
=== Entity kubernetes_metadata sources(merged):[kubeapiserver] id: /namespaces//system ===
----------- Entity ID -----------
Kind: kubernetes_metadata ID: /namespaces//system

----------- Entity Meta -----------
Name: system
Namespace:
===

=== Entity kubernetes_metadata sources(merged):[kubeapiserver] id: /namespaces//test-1 ===
----------- Entity ID -----------
Kind: kubernetes_metadata ID: /namespaces//test-1

----------- Entity Meta -----------
Name: test-1
Namespace:
===
...

Injector metadata

To ensure I was able to fetch the metadata for a namespace during injection, I added temporary code to the inject function:

func (w *Webhook) inject(pod *corev1.Pod, ns string, cl dynamic.Interface) (bool, error) {
	id := util.GenerateKubeMetadataEntityID("", "namespaces", "", pod.Namespace)
	namespace, err := w.wmeta.GetKubernetesMetadata(id)
	if err != nil {
		return false, fmt.Errorf("[MARK HACKS] could not get kubernetes namespace to match against for %s: %w", pod.Namespace, err)
	} else {
		log.Info("[MARK HACKS] namespace found from metadata: %v", namespace)
	}

	return w.mutator.MutatePod(pod, ns, cl)
}

After deploying a pod that received injection, I saw the following log line:

│ cluster-agent 2025-02-09 14:29:35 UTC | CLUSTER | INFO | (pkg/clusteragent/admission/mutate/autoinstrumentation/auto_instrumentation.go:132 in inject) | [MARK HACKS] namespace found from metadata: %v &{{kubernetes_metadata /namespaces//test-1} {test-1  map[kubectl.kubernetes.io/last-applied-configuration:{"apiVersion":"v1","kind":"Namespace","metadata":{"annotations":{},"name":"test-1"}}

Possible Drawbacks / Trade-offs

Additional Notes

One thing to note, this config/filter is not yet active or exposed. It's simply modifying a struct with unit tests that's not wired in anywhere. We're working hard to get this feature ready for the next agent release milestone and will include release notes, additional testing, etc before that happens.

This commit adds the ability to use a namespace selector to match
against namespaces defined in the targets list.
@betterengineering betterengineering added changelog/no-changelog qa/done QA done before merge and regressions are covered by tests labels Feb 6, 2025
@betterengineering betterengineering requested review from a team as code owners February 6, 2025 17:50
@github-actions github-actions bot added the medium review PR review might take time label Feb 6, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 6, 2025

Uncompressed package size comparison

Comparison with ancestor 26f96c8554a5546acd016da35c60ba45330b7d38

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 873.71MB 873.71MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 883.45MB 883.45MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 883.45MB 883.45MB 0.50MB
datadog-agent-arm64-deb 0.00MB 861.58MB 861.58MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 871.30MB 871.30MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 59.10MB 59.10MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 59.18MB 59.18MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 59.18MB 59.18MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 56.57MB 56.57MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 445.91MB 445.91MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 86.38MB 86.38MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 86.45MB 86.45MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 86.45MB 86.45MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 82.65MB 82.65MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 82.72MB 82.72MB 0.50MB

Decision

✅ Passed

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 6, 2025

Static quality checks ✅

Please find below the results from static quality gates

Info

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_deb_amd64 845.16MiB 858.45MiB 203.57MiB 214.3MiB
static_quality_gate_docker_agent_amd64 929.36MiB 942.69MiB 310.75MiB 321.56MiB

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 6, 2025

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv aws.create-vm --pipeline-id=55384220 --os-family=ubuntu

Note: This applies to commit e8b86e9

Copy link

cit-pr-commenter bot commented Feb 6, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: c049bf79-6817-4264-bf27-d7f5cb812581

Baseline: 26f96c8
Comparison: e8b86e9
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_idle_all_features memory utilization +0.83 [+0.77, +0.89] 1 Logs bounds checks dashboard
quality_gate_idle memory utilization +0.40 [+0.36, +0.44] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency egress throughput +0.31 [-0.46, +1.08] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.15 [-0.31, +0.62] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.05 [-0.81, +0.90] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.03 [-0.82, +0.88] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.01 [-0.75, +0.78] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.01 [-0.02, +0.03] 1 Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.26, +0.27] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.01 [-0.64, +0.63] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput -0.04 [-0.88, +0.80] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.05 [-0.84, +0.73] 1 Logs
quality_gate_logs % cpu utilization -0.14 [-3.21, +2.93] 1 Logs
file_tree memory utilization -0.31 [-0.38, -0.24] 1 Logs
tcp_syslog_to_blackhole ingress throughput -1.04 [-1.11, -0.97] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -1.11 [-1.97, -0.24] 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 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
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:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. 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.

  3. 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 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 intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.

namespaceSelector:
matchLabels:
tracing: "yes"
matchExpressions:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that I see this, I'm not sure if matchExpressions is a good name.
Is it clear that it refers to labels? Maybe this is something that we can discuss later on when we review all the new config options.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MatchLabels/MatchExpressions are a standard Kubernetes concept. Straying from that would likely add more confusion.

@betterengineering betterengineering requested a review from a team as a code owner February 7, 2025 22:17
@betterengineering betterengineering marked this pull request as draft February 7, 2025 22:18
@github-actions github-actions bot added long review PR is complex, plan time to review it and removed medium review PR review might take time labels Feb 7, 2025
@betterengineering betterengineering force-pushed the mark.spicer/INPLAT-466-add-ns-matchlabels-support branch from 12e3bb1 to 88f8d9b Compare February 9, 2025 13:58
@github-actions github-actions bot added medium review PR review might take time and removed long review PR is complex, plan time to review it labels Feb 9, 2025
@betterengineering betterengineering requested review from a team and stanistan and removed request for a team and rahulkaukuntla February 9, 2025 14:00
This commit adds namespace metadata collection if auto instrumentation
is enabled with a target list defined.
@betterengineering betterengineering force-pushed the mark.spicer/INPLAT-466-add-ns-matchlabels-support branch from 88f8d9b to bec81f8 Compare February 9, 2025 14:23
@betterengineering betterengineering marked this pull request as ready for review February 9, 2025 14:33
@github-actions github-actions bot added long review PR is complex, plan time to review it and removed medium review PR review might take time labels Feb 10, 2025
@betterengineering
Copy link
Member Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Feb 10, 2025

Devflow running: /merge

View all feedbacks in Devflow UI.


2025-02-10 13:12:05 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 29m.


2025-02-10 13:40:31 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit a6cf259 into main Feb 10, 2025
236 checks passed
@dd-mergequeue dd-mergequeue bot deleted the mark.spicer/INPLAT-466-add-ns-matchlabels-support branch February 10, 2025 13:40
@github-actions github-actions bot added this to the 7.64.0 milestone Feb 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants