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

system-probe: flare: Pull runtime configuration via the config handler of system-probe #33655

Merged
merged 2 commits into from
Feb 4, 2025

Conversation

guyarb
Copy link
Contributor

@guyarb guyarb commented Feb 3, 2025

What does this PR do?

When a flare is being requested, we will pull system-probe configuration via the /config handler of the system-probe config.

Motivation

The current code, represented the configuration loaded from the configuration yaml, and didn't take into account the environment variables in the system-probe container.
As a result, pulling a flare over k8s environment, resulted in inaccurate system-probe runtime configuration dump.

Describe how you validated your changes

Existing E2E tests

Manual QA -

System-probe enabled

  1. Deploy the image on k8s with system-probe enabled
    datadog:
     apiKeyExistingSecret: datadog-secret
     serviceMonitoring:
      enabled: true
    
    agents:
      containers:
        systemProbe:
          env:
            - name: DD_SERVICE_MONITORING_CONFIG_ENABLE_HTTP2_MONITORING
              value: "true"
            - name: DD_SERVICE_MONITORING_CONFIG_TLS_ISTIO_ENABLED
              value: "false"
            - name: DD_SERVICE_MONITORING_CONFIG_TLS_NODEJS_ENABLED
              value: "true"
  2. Request for a flare via the UI or via the agent container agent flare
  3. Verify the value of service_monitoring_config.enable_http2_monitoring is true, service_monitoring_config.tls.istio.enabled is false, and service_monitoring_config.tls.nodejs.enabled is true

System-probe disabled

  1. Deploy the image on k8s with system-probe enabled
    datadog:
     apiKeyExistingSecret: datadog-secret
    
    agents:
      containers:
        systemProbe:
          env:
            - name: DD_SERVICE_MONITORING_CONFIG_ENABLE_HTTP2_MONITORING
              value: "true"
            - name: DD_SERVICE_MONITORING_CONFIG_TLS_ISTIO_ENABLED
              value: "false"
            - name: DD_SERVICE_MONITORING_CONFIG_TLS_NODEJS_ENABLED
              value: "true"
  2. Request for a flare via the UI or via the agent container agent flare
  3. Verify the value of service_monitoring_config.enable_http2_monitoring is false, service_monitoring_config.tls.istio.enabled is true, and service_monitoring_config.tls.nodejs.enabled is missing

Possible Drawbacks / Trade-offs

Additional Notes

@guyarb guyarb added changelog/no-changelog component/system-probe qa/rc-required Only for a PR that requires validation on the Release Candidate team/agent-configuration labels Feb 3, 2025
@guyarb guyarb requested a review from a team as a code owner February 3, 2025 11:01
@github-actions github-actions bot added short review PR is simple enough to be reviewed quickly and removed component/system-probe labels Feb 3, 2025
@agent-platform-auto-pr
Copy link
Contributor

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

Note: This applies to commit 15d101e

@agent-platform-auto-pr
Copy link
Contributor

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

Uncompressed package size comparison

Comparison with ancestor 2d763d6d5b3102e3abc79144adc8907d608b0eff

Diff per package
package diff status size ancestor threshold
datadog-iot-agent-x86_64-rpm 0.00MB 93.91MB 93.91MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 93.91MB 93.91MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 89.96MB 89.96MB 0.50MB
datadog-agent-amd64-deb 0.00MB 877.18MB 877.18MB 0.50MB
datadog-agent-arm64-deb 0.00MB 864.97MB 864.97MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 874.69MB 874.69MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 59.02MB 59.02MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 59.10MB 59.10MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 59.10MB 59.10MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 56.51MB 56.51MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 456.45MB 456.45MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 93.84MB 93.84MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 89.89MB 89.89MB 0.50MB
datadog-agent-x86_64-rpm -0.00MB 886.92MB 886.92MB 0.50MB
datadog-agent-x86_64-suse -0.00MB 886.92MB 886.92MB 0.50MB

Decision

✅ Passed

Copy link

cit-pr-commenter bot commented Feb 3, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 894fd82b-967f-4e91-b6da-d0dc116eac1d

Baseline: 2d763d6
Comparison: 15d101e
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_logs % cpu utilization +1.83 [-1.23, +4.90] 1 Logs
quality_gate_idle memory utilization +0.41 [+0.36, +0.45] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency egress throughput +0.25 [-0.52, +1.02] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.10 [-0.83, +1.03] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.09 [-0.70, +0.88] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.04 [-0.43, +0.51] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.02 [-0.87, +0.92] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.00 [-0.63, +0.64] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.29, +0.29] 1 Logs
file_to_blackhole_0ms_latency egress throughput -0.01 [-0.85, +0.84] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.02 [-0.94, +0.91] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.04 [-0.72, +0.63] 1 Logs
quality_gate_idle_all_features memory utilization -0.15 [-0.22, -0.08] 1 Logs bounds checks dashboard
file_tree memory utilization -0.18 [-0.25, -0.11] 1 Logs
tcp_syslog_to_blackhole ingress throughput -1.19 [-1.26, -1.13] 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_logs, bounds check lost_bytes: 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_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 memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.

Copy link
Contributor

@hmahmood hmahmood left a comment

Choose a reason for hiding this comment

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

Great find 👍

If SP is disabled, still provide config dump
Copy link
Member

@hush-hush hush-hush left a comment

Choose a reason for hiding this comment

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

Added a quick comment, feel free to merge after answering it.

@@ -261,6 +264,12 @@ func getSystemProbeTelemetry() ([]byte, error) {
return getHTTPData(sysProbeClient, url)
}

func getSystemProbeConfig() ([]byte, error) {
Copy link
Member

Choose a reason for hiding this comment

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

Could you add a comment saying this is a temporary fix until we align configuration between all containers ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry missed the comment

Why is it temporary?
The system-probe container contains ENV variables that affect the runtime configuration

@guyarb
Copy link
Contributor Author

guyarb commented Feb 4, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Feb 4, 2025

Devflow running: /merge

View all feedbacks in Devflow UI.


2025-02-04 11:39:03 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 27m.


2025-02-04 12:03:15 UTC ℹ️ MergeQueue: This merge request was merged

@guyarb guyarb added 7.35.0-drop backport/7.63.x Automatically create a backport PR to 7.63.x and removed 7.35.0-drop labels Feb 4, 2025
@dd-mergequeue dd-mergequeue bot merged commit 5025a79 into main Feb 4, 2025
258 checks passed
@dd-mergequeue dd-mergequeue bot deleted the arbitman/flare-fetch-sysprobe-cfg branch February 4, 2025 12:03
@github-actions github-actions bot added this to the 7.64.0 milestone Feb 4, 2025
agent-platform-auto-pr bot pushed a commit that referenced this pull request Feb 4, 2025
@github-actions github-actions bot added medium review PR review might take time and removed short review PR is simple enough to be reviewed quickly labels Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/7.63.x Automatically create a backport PR to 7.63.x changelog/no-changelog medium review PR review might take time qa/rc-required Only for a PR that requires validation on the Release Candidate team/agent-configuration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants