Skip to content

discovery: module: add /services endpoint alongside existing /check endpoint #37504

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

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

Conversation

Yumasi
Copy link
Member

@Yumasi Yumasi commented May 30, 2025

  • Add new /services endpoint that accepts pids parameter and bypasses port retry logic
  • Restore original /check endpoint functionality with port retry logic
  • Separate test files: impl_linux_test.go for /check, impl_services_test.go for /services
  • Update params.go to handle both heartbeat and pids parameters
  • Maintain existing CheckResponse format for /check endpoint
  • Use new ServicesResponse format for /services endpoint

What does this PR do?

Adds a new /services endpoint to the discovery module that accept explicit PID lists and bypasses the port retry logic used by the existing /check endpoint.

Motivation

DSCVR-134

Describe how you validated your changes

Change covered by unit tests

Possible Drawbacks / Trade-offs

Additional Notes

@Yumasi Yumasi added changelog/no-changelog qa/done QA done before merge and regressions are covered by tests team/agent-discovery labels May 30, 2025
@github-actions github-actions bot added component/system-probe long review PR is complex, plan time to review it labels May 30, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented May 30, 2025

Uncompressed package size comparison

Comparison with ancestor b2d64a3485d69146497791fb5bba7c4d3db64ff2

Diff per package
package diff status size ancestor threshold
datadog-agent-aarch64-rpm 0.00MB 769.31MB 769.31MB 0.50MB
datadog-agent-amd64-deb 0.00MB 774.28MB 774.28MB 0.50MB
datadog-agent-arm64-deb 0.00MB 760.38MB 760.38MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 783.23MB 783.22MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 783.23MB 783.22MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 31.99MB 31.99MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 32.07MB 32.07MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 32.07MB 32.07MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 30.47MB 30.47MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 380.66MB 380.66MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 62.80MB 62.80MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 62.88MB 62.88MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 62.88MB 62.88MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 59.37MB 59.37MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 59.45MB 59.45MB 0.50MB

Decision

✅ Passed

Copy link

cit-pr-commenter bot commented May 30, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: ae5c3ef3-c841-491d-8946-797a8d7ff90e

Baseline: aa7d8ba
Comparison: 630ea6e
Diff

Optimization Goals: ❌ Regression(s) detected

perf experiment goal Δ mean % Δ mean % CI trials links
docker_containers_cpu % cpu utilization +7.59 [+4.26, +10.91] 1 Logs

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
docker_containers_cpu % cpu utilization +7.59 [+4.26, +10.91] 1 Logs
tcp_syslog_to_blackhole ingress throughput +1.04 [+0.98, +1.11] 1 Logs
quality_gate_idle_all_features memory utilization +0.67 [+0.52, +0.82] 1 Logs bounds checks dashboard
file_tree memory utilization +0.58 [+0.37, +0.79] 1 Logs
quality_gate_idle memory utilization +0.43 [+0.35, +0.50] 1 Logs bounds checks dashboard
otlp_ingest_logs memory utilization +0.13 [+0.00, +0.25] 1 Logs
docker_containers_memory memory utilization +0.07 [-0.01, +0.15] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.04 [-0.62, +0.71] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.01 [-0.61, +0.63] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.01 [-0.61, +0.62] 1 Logs
otlp_ingest_metrics memory utilization +0.01 [-0.15, +0.16] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.02] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.28, +0.26] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.02 [-0.64, +0.60] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput -0.02 [-0.25, +0.21] 1 Logs
file_to_blackhole_100ms_latency egress throughput -0.03 [-0.61, +0.55] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.03 [-0.65, +0.58] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.04 [-0.63, +0.56] 1 Logs
ddot_metrics memory utilization -0.08 [-0.19, +0.04] 1 Logs
ddot_logs memory utilization -0.68 [-0.82, -0.54] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -0.82 [-0.88, -0.76] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization -1.57 [-2.44, -0.70] 1 Logs
quality_gate_logs % cpu utilization -2.72 [-5.48, +0.05] 1 Logs bounds checks dashboard

Bounds Checks: ❌ Failed

perf experiment bounds_check_name replicates_passed links
docker_containers_memory memory_usage 0/10
quality_gate_logs memory_usage 7/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 9/10 bounds checks dashboard
docker_containers_cpu simple_check_run 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_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_logs intake_connections 10/10 bounds checks dashboard
quality_gate_logs lost_bytes 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:

  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

Failed. Some Quality Gates were violated.

  • 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.
  • 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_logs, bounds check memory_usage: 7/10 replicas passed. Failed 3 which is > 0. Gate FAILED.
  • quality_gate_idle_all_features, bounds check memory_usage: 9/10 replicas passed. Failed 1 which is > 0. Gate FAILED.
  • quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented May 30, 2025

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor aa7d8ba

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
agent_deb_amd64 $${\color{red}+0.01}$$ $${\color{green}747.06}$$ < $${752.99}$$ $${\color{green}-0.01}$$ $${\color{green}184.99}$$ < $${187.44}$$
agent_deb_amd64_fips $${\color{red}+0.01}$$ $${\color{green}745.44}$$ < $${751.36}$$ $${\color{green}-0.06}$$ $${\color{green}184.38}$$ < $${187.06}$$
agent_heroku_amd64 $${\color{red}+0}$$ $${\color{green}368.7}$$ < $${369.68}$$ $${\color{green}-0}$$ $${\color{green}98.68}$$ < $${99.55}$$
agent_msi $${\color{green}0}$$ $${\color{green}986.26}$$ < $${987.01}$$ $${\color{green}-0.01}$$ $${\color{green}149.69}$$ < $${150.72}$$
agent_rpm_amd64 $${\color{red}+0.01}$$ $${\color{green}747.05}$$ < $${752.98}$$ $${\color{green}-0}$$ $${\color{green}186.56}$$ < $${190.03}$$
agent_rpm_amd64_fips $${\color{red}+0.01}$$ $${\color{green}745.43}$$ < $${751.35}$$ $${\color{red}+0.01}$$ $${\color{green}186.23}$$ < $${189.81}$$
agent_rpm_arm64 $${\color{red}+0.01}$$ $${\color{green}733.78}$$ < $${739.42}$$ $${\color{red}+0.04}$$ $${\color{green}168.63}$$ < $${171.23}$$
agent_rpm_arm64_fips $${\color{red}+0.01}$$ $${\color{green}732.28}$$ < $${737.91}$$ $${\color{green}-0.03}$$ $${\color{green}167.69}$$ < $${170.22}$$
agent_suse_amd64 $${\color{red}+0.01}$$ $${\color{green}747.05}$$ < $${752.98}$$ $${\color{green}-0}$$ $${\color{green}186.56}$$ < $${190.03}$$
agent_suse_amd64_fips $${\color{red}+0.01}$$ $${\color{green}745.43}$$ < $${751.35}$$ $${\color{red}+0.01}$$ $${\color{green}186.23}$$ < $${189.81}$$
agent_suse_arm64 $${\color{red}+0.01}$$ $${\color{green}733.78}$$ < $${739.42}$$ $${\color{red}+0.04}$$ $${\color{green}168.63}$$ < $${171.23}$$
agent_suse_arm64_fips $${\color{red}+0.01}$$ $${\color{green}732.28}$$ < $${737.91}$$ $${\color{green}-0.03}$$ $${\color{green}167.69}$$ < $${170.22}$$
docker_agent_amd64 $${\color{red}+0.01}$$ $${\color{green}830.85}$$ < $${849.39}$$ $${\color{green}-0}$$ $${\color{green}282.17}$$ < $${288.34}$$
docker_agent_arm64 $${\color{red}+0.01}$$ $${\color{green}841.03}$$ < $${858.97}$$ $${\color{red}+0}$$ $${\color{green}268.28}$$ < $${274.36}$$
docker_agent_jmx_amd64 $${\color{red}+0.01}$$ $${\color{green}830.85}$$ < $${849.39}$$ $${\color{green}-0}$$ $${\color{green}282.17}$$ < $${288.34}$$
docker_agent_jmx_arm64 $${\color{red}+0.01}$$ $${\color{green}841.03}$$ < $${858.97}$$ $${\color{red}+0}$$ $${\color{green}268.28}$$ < $${274.36}$$
docker_agent_windows1809 $${\color{red}+0.01}$$ $${\color{green}830.85}$$ < $${849.39}$$ $${\color{green}-0}$$ $${\color{green}282.17}$$ < $${288.34}$$
docker_agent_windows1809_core $${\color{red}+0.01}$$ $${\color{green}830.85}$$ < $${849.39}$$ $${\color{green}-0}$$ $${\color{green}282.17}$$ < $${288.34}$$
docker_agent_windows1809_core_jmx $${\color{red}+0.01}$$ $${\color{green}830.85}$$ < $${849.39}$$ $${\color{green}-0}$$ $${\color{green}282.17}$$ < $${288.34}$$
docker_agent_windows1809_jmx $${\color{red}+0.01}$$ $${\color{green}830.85}$$ < $${849.39}$$ $${\color{green}-0}$$ $${\color{green}282.17}$$ < $${288.34}$$
docker_agent_windows2022 $${\color{red}+0.01}$$ $${\color{green}830.85}$$ < $${849.39}$$ $${\color{green}-0}$$ $${\color{green}282.17}$$ < $${288.34}$$
docker_agent_windows2022_core $${\color{red}+0.01}$$ $${\color{green}830.85}$$ < $${849.39}$$ $${\color{green}-0}$$ $${\color{green}282.17}$$ < $${288.34}$$
docker_agent_windows2022_core_jmx $${\color{red}+0.01}$$ $${\color{green}830.85}$$ < $${849.39}$$ $${\color{green}-0}$$ $${\color{green}282.17}$$ < $${288.34}$$
docker_agent_windows2022_jmx $${\color{red}+0.01}$$ $${\color{green}830.85}$$ < $${849.39}$$ $${\color{green}-0}$$ $${\color{green}282.17}$$ < $${288.34}$$
docker_cluster_agent_amd64 $${\color{red}+0}$$ $${\color{green}259.08}$$ < $${259.73}$$ $${\color{red}+0}$$ $${\color{green}102.83}$$ < $${103.68}$$
docker_cluster_agent_arm64 $${\color{red}+0}$$ $${\color{green}273.49}$$ < $${274.24}$$ $${\color{red}+0}$$ $${\color{green}97.55}$$ < $${98.45}$$
docker_cws_instrumentation_amd64 $${\color{green}0}$$ $${\color{green}7.08}$$ < $${7.12}$$ $${\color{green}-0}$$ $${\color{green}2.95}$$ < $${3.29}$$
docker_cws_instrumentation_arm64 $${\color{green}0}$$ $${\color{green}6.69}$$ < $${6.92}$$ $${\color{green}-0}$$ $${\color{green}2.7}$$ < $${3.07}$$
docker_dogstatsd_amd64 $${\color{green}0}$$ $${\color{green}38.9}$$ < $${39.57}$$ $${\color{red}+0}$$ $${\color{green}14.94}$$ < $${15.76}$$
docker_dogstatsd_arm64 $${\color{red}+0}$$ $${\color{green}37.52}$$ < $${38.2}$$ $${\color{red}+0}$$ $${\color{green}13.96}$$ < $${14.83}$$
dogstatsd_deb_amd64 $${\color{green}0}$$ $${\color{green}30.58}$$ < $${31.52}$$ $${\color{red}+0}$$ $${\color{green}8.03}$$ < $${8.97}$$
dogstatsd_deb_arm64 $${\color{green}0}$$ $${\color{green}29.14}$$ < $${30.08}$$ $${\color{green}-0}$$ $${\color{green}6.97}$$ < $${7.92}$$
dogstatsd_rpm_amd64 $${\color{green}0}$$ $${\color{green}30.58}$$ < $${31.52}$$ $${\color{red}+0}$$ $${\color{green}8.03}$$ < $${8.98}$$
dogstatsd_suse_amd64 $${\color{green}0}$$ $${\color{green}30.58}$$ < $${31.52}$$ $${\color{red}+0}$$ $${\color{green}8.03}$$ < $${8.98}$$
iot_agent_deb_amd64 $${\color{green}0}$$ $${\color{green}59.89}$$ < $${60.17}$$ $${\color{red}+0}$$ $${\color{green}14.97}$$ < $${15.82}$$
iot_agent_deb_arm64 $${\color{green}0}$$ $${\color{green}56.62}$$ < $${56.94}$$ $${\color{green}-0}$$ $${\color{green}12.85}$$ < $${13.86}$$
iot_agent_deb_armhf $${\color{green}0}$$ $${\color{green}56.07}$$ < $${56.41}$$ $${\color{red}+0.03}$$ $${\color{green}13.01}$$ < $${13.86}$$
iot_agent_rpm_amd64 $${\color{green}0}$$ $${\color{green}59.89}$$ < $${60.18}$$ $${\color{green}-0}$$ $${\color{green}15.0}$$ < $${15.84}$$
iot_agent_rpm_arm64 $${\color{green}0}$$ $${\color{green}56.62}$$ < $${56.94}$$ $${\color{red}+0}$$ $${\color{green}12.87}$$ < $${13.76}$$
iot_agent_suse_amd64 $${\color{green}0}$$ $${\color{green}59.89}$$ < $${60.18}$$ $${\color{green}-0}$$ $${\color{green}15.0}$$ < $${15.84}$$

…ndpoint

- Add new /services endpoint that accepts pids parameter and bypasses port retry logic
- Restore original /check endpoint functionality with port retry logic
- Separate test files: impl_linux_test.go for /check, impl_services_test.go for /services
- Update params.go to handle both heartbeat and pids parameters
- Maintain existing CheckResponse format for /check endpoint
- Use new ServicesResponse format for /services endpoint
@Yumasi Yumasi force-pushed the guillaume.pagnoux/DSCVR-134-discovery-module-services-endpoint branch from 9d780d4 to 43a69bd Compare May 30, 2025 12:59
@Yumasi Yumasi changed the title discovery: module: add /services endpoint alongside existing /check e… discovery: module: add /services endpoint alongside existing /check endpoint May 30, 2025
@Yumasi Yumasi marked this pull request as ready for review May 30, 2025 14:06
@Yumasi Yumasi requested a review from a team as a code owner May 30, 2025 14:06
}
if s.shouldIgnoreComm(pid) {
return nil
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Why can't these two checks be done in the caller in the core agent?

Copy link
Member Author

Choose a reason for hiding this comment

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

The ignored PID has indeed its place in the CA. I left shouldIgnoreComm in SP on purpose though, since it requires moving the config option from SP to the CA, and I think that keep be done in a later PR.

@Yumasi Yumasi force-pushed the guillaume.pagnoux/DSCVR-134-discovery-module-services-endpoint branch from 923b5a8 to f7e9df6 Compare June 2, 2025 09:26
@Yumasi Yumasi force-pushed the guillaume.pagnoux/DSCVR-134-discovery-module-services-endpoint branch from f7e9df6 to e729a82 Compare June 2, 2025 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog component/system-probe long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/agent-discovery
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants