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

[CONTP-656] wmeta kubelet unknown envvar handling #34450

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

gabedos
Copy link
Contributor

@gabedos gabedos commented Feb 25, 2025

What does this PR do?

Modifies pod parsing from Kubelet collector to discard environment variables that it can't resolve.

The Agent's Kubelet collector does not support environment variables that are externally sourced. This includes ConfigMap, Secrets, FieldRef, etc. If the customer has a runtime collector running, the value will be properly sourced and fully resolved from there instead.

Motivation

Customer support case where they used ConfigMap envvars to define another envvar. The Configmap envvars are unresolvable and were creating issues since they expanded in a poor manner and was overwriting the correct value from the runtime collector. By ignoring the value the kubelet collector can't resolve, the runtime collector (docker/containerd) will have the full value and place it into wmeta/tagger correctly.

Describe how you validated your changes

Unit tests should cover all these cases. Additional tests were also written. Plus a quick manual QA with the following spec

spec:
      containers:
        - name: sample-python-app
          image: xxxxx:latest
          env:
            - name: SERVICE_NAME
              valueFrom:
                fieldRef:
                  apiVersion: v1
                  fieldPath: metadata.labels['app']
            - name: SERVICE_CARID
              valueFrom:
                fieldRef:
                  apiVersion: v1
                  fieldPath: metadata.labels['usb-carId']
            - name: OTEL_SERVICE_NAME
              value: "$(SERVICE_NAME)-$(SERVICE_CARID)"

Possible Drawbacks / Trade-offs

We will need to iterate through every environment variable in every container in order to know which ones need to be dropped. The collector cache is frequently invalidated and thus this will execute often. However, there are many other operations that also execute at this frequency/level.

Additional Notes

@gabedos gabedos force-pushed the gabedos/kubelet-envvar-handling branch from f8eef53 to 856f458 Compare February 25, 2025 20:54
@github-actions github-actions bot added team/container-platform The Container Platform Team medium review PR review might take time labels Feb 25, 2025
@gabedos gabedos added the qa/done QA done before merge and regressions are covered by tests label Feb 25, 2025
@gabedos gabedos added this to the 7.65.0 milestone Feb 25, 2025
@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 25, 2025
@gabedos gabedos marked this pull request as ready for review February 25, 2025 21:08
@gabedos gabedos requested review from a team as code owners February 25, 2025 21:08
Copy link
Contributor

@maycmlee maycmlee left a comment

Choose a reason for hiding this comment

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

Small suggestions, approving to not block merge.

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 25, 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=57143914 --os-family=ubuntu

Note: This applies to commit bbe4a94

@gabedos gabedos requested a review from maycmlee February 25, 2025 21:43
@agent-platform-auto-pr
Copy link
Contributor

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

Uncompressed package size comparison

Comparison with ancestor e1841bcbca0b8f1e31fd87bfcd6dc75b4ebdbea5

Diff per package
package diff status size ancestor threshold
datadog-agent-arm64-deb 0.01MB ⚠️ 808.85MB 808.84MB 0.50MB
datadog-agent-aarch64-rpm 0.01MB ⚠️ 818.62MB 818.62MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 827.66MB 827.66MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 827.66MB 827.66MB 0.50MB
datadog-agent-amd64-deb 0.00MB 817.87MB 817.87MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.09MB 62.09MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.09MB 62.09MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.33MB 59.33MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 39.50MB 39.50MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 39.50MB 39.50MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 39.42MB 39.42MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 37.96MB 37.96MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 443.28MB 443.28MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.02MB 62.02MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.27MB 59.27MB 0.50MB

Decision

⚠️ Warning

@agent-platform-auto-pr
Copy link
Contributor

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

Static quality checks ✅

Please find below the results from static quality gates

Successful checks

Info

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_deb_amd64 791.27MiB 801.8MiB 192.59MiB 202.62MiB
static_quality_gate_agent_deb_arm64 782.65MiB 793.14MiB 174.27MiB 184.51MiB
static_quality_gate_agent_rpm_amd64 791.26MiB 801.79MiB 195.07MiB 205.03MiB
static_quality_gate_agent_rpm_arm64 782.64MiB 793.09MiB 176.41MiB 186.44MiB
static_quality_gate_agent_suse_amd64 791.26MiB 801.81MiB 195.07MiB 205.03MiB
static_quality_gate_agent_suse_arm64 782.64MiB 793.14MiB 176.41MiB 186.44MiB
static_quality_gate_dogstatsd_deb_amd64 37.67MiB 47.67MiB 9.78MiB 19.78MiB
static_quality_gate_dogstatsd_deb_arm64 36.27MiB 46.27MiB 8.49MiB 18.49MiB
static_quality_gate_dogstatsd_rpm_amd64 37.67MiB 47.67MiB 9.79MiB 19.79MiB
static_quality_gate_dogstatsd_suse_amd64 37.67MiB 47.67MiB 9.79MiB 19.79MiB
static_quality_gate_iot_agent_deb_amd64 59.22MiB 69.0MiB 14.89MiB 24.8MiB
static_quality_gate_iot_agent_deb_arm64 56.59MiB 66.4MiB 12.84MiB 22.8MiB
static_quality_gate_iot_agent_rpm_amd64 59.22MiB 69.0MiB 14.9MiB 24.8MiB
static_quality_gate_iot_agent_rpm_arm64 56.59MiB 66.4MiB 12.85MiB 22.8MiB
static_quality_gate_iot_agent_suse_amd64 59.22MiB 69.0MiB 14.9MiB 24.8MiB
static_quality_gate_docker_agent_amd64 876.13MiB 886.12MiB 294.21MiB 304.21MiB
static_quality_gate_docker_agent_arm64 890.79MiB 900.79MiB 280.46MiB 290.47MiB
static_quality_gate_docker_agent_jmx_amd64 1.05GiB 1.06GiB 369.32MiB 379.33MiB
static_quality_gate_docker_agent_jmx_arm64 1.05GiB 1.06GiB 351.57MiB 361.55MiB
static_quality_gate_docker_dogstatsd_amd64 45.81MiB 55.78MiB 17.28MiB 27.28MiB
static_quality_gate_docker_dogstatsd_arm64 44.46MiB 54.45MiB 16.16MiB 26.16MiB
static_quality_gate_docker_cluster_agent_amd64 264.95MiB 274.78MiB 106.34MiB 116.28MiB
static_quality_gate_docker_cluster_agent_arm64 280.91MiB 290.82MiB 101.18MiB 111.12MiB

Copy link

cit-pr-commenter bot commented Feb 25, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 8e23922a-3a28-4ccb-95bc-bd684d3bbc4e

Baseline: e1841bc
Comparison: bbe4a94
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +1.24 [+0.37, +2.11] 1 Logs
quality_gate_logs % cpu utilization +0.62 [-2.28, +3.51] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.02 [-0.60, +0.65] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.02 [-0.79, +0.83] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.01 [-0.77, +0.80] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.01 [-0.01, +0.03] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.00 [-0.46, +0.46] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.00 [-0.81, +0.80] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.30, +0.27] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.03 [-0.71, +0.65] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.13 [-0.91, +0.64] 1 Logs
file_to_blackhole_1000ms_latency egress throughput -0.17 [-0.94, +0.61] 1 Logs
quality_gate_idle_all_features memory utilization -0.26 [-0.31, -0.22] 1 Logs bounds checks dashboard
file_tree memory utilization -0.48 [-0.54, -0.41] 1 Logs
quality_gate_idle memory utilization -0.77 [-0.81, -0.73] 1 Logs bounds checks dashboard
tcp_syslog_to_blackhole ingress throughput -1.13 [-1.19, -1.07] 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_idle, 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_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.

@@ -19,23 +19,23 @@ func syntaxWrap(input string) string {
// implements the expansion semantics defined in the expansion spec; it
// returns the input string wrapped in the expansion syntax if no mapping
// for the input is found.
func MappingFuncFor(context ...map[string]string) func(string) string {
return func(input string) string {
func MappingFuncFor(context ...map[string]string) func(string) (string, bool) {
Copy link
Member

Choose a reason for hiding this comment

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

Since this file is in the third_party directory, it was likely copy-pasted. It might be helpful to add a brief comment explaining any modifications to ensure we remember the changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/container-platform The Container Platform Team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants