Skip to content

[Backport 7.68.x] Contint4707/ksm customresource metric fix/shaina #37938

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 13, 2025
Merged

[Backport 7.68.x] Contint4707/ksm customresource metric fix/shaina #37938

merged 1 commit into from
Jun 13, 2025

Conversation

agent-platform-auto-pr[bot]
Copy link
Contributor

@agent-platform-auto-pr agent-platform-auto-pr bot commented Jun 13, 2025 •
edited by shaina-patel-23
Loading

Backport 641d806 from #37819.

<!--

  • Contributors are encouraged to read our CONTRIBUTING documentation.
  • Both Contributor and Reviewer Checklists are available at https://datadoghq.dev/datadog-agent/guidelines/contributing/#pull-requests.
  • The pull request:
    • Should only fix one issue or add one feature at a time.
    • Must update the test suite for the relevant functionality.
    • Should pass all status checks before being reviewed or merged.
  • Commit titles should be prefixed with general area of pull request's change.
  • Please fill the below sections if possible with relevant information or links.
    -->

What does this PR do?

This PR fixes the metric naming logic for custom resources is the Kubernetes State Metrics (KSM) check. Before, custom resource metrics were emitted under the incorrect prefix kubernetes_state.customresource.&lt;name&gt; which bypasses the custom metric billing logic. With this change, the correct naming format kubernetes_state_customresource.&lt;prefix&gt;_&lt;name&gt; is used.
Link to Jira ticket: https://datadoghq.atlassian.net/jira/software/c/projects/CONTINT/boards/5407?selectedIssue=CONTINT-4707

Motivation

The motivation is to ensure that metrics for Kubernetes custom resources are correctly prefixed and billed as custom metrics.

Describe how you validated your changes

<!--
Validate your changes before merge, ensuring that:

  • Your PR is tested by static / unit / integrations / e2e tests
  • Your PR description details which e2e tests cover your changes, if any
  • The PR description contains details of how you validated your changes. If you validated changes manually and not through automated tests, add context on why automated tests did not fit your changes validation.

If you want additional validation by a second person, you can ask reviewers to do it. Describe how to set up an environment for manual tests in the PR description. Manual validation is expected to happen on every commit before merge.

Any manual validation step should then map to an automated test. Manual validation should not substitute automation, minus exceptions not supported by test tooling yet.
-->
I used debugging log statements in kubernetes_state.go and cr.go to trace the metric generation logic:

  • Verified that metricFamily.name outputs gotk_csinode

  • Confirmed that k.metricNamesMapper contains the mapping gotk_csinode → customresource.gotk_csinode

  • Confirmed that the updated conditional logic now matches the customresource. prefix correctly

  • Verified the final emitted metric name is kubernetes_state_customresource.gotk_csinode

Emitted metric when there is no specified 'metrixNamePrefix' is kubernetes_state_customresource.csinode and kubernetes_state_customresource.gotk_csinode when there is.

Possible Drawbacks / Trade-offs

If new entries are introduced in metricNamesMapper without the customresource. prefix, they may be skipped by this logic and continue to be incorrectly named.

@shaina-patel-23 @buraizu @github-actions
Contint4707/ksm customresource metric fix/shaina (#37819)
911a14b 
Co-authored-by: Bryce Eadie <bryce.eadie@datadoghq.com>
(cherry picked from commit 641d806)
@agent-platform-auto-pr agent-platform-auto-pr bot added the qa/done QA done before merge and regressions are covered by tests label Jun 13, 2025
@agent-platform-auto-pr agent-platform-auto-pr bot requested a review from a team as a code owner June 13, 2025 14:38
@agent-platform-auto-pr agent-platform-auto-pr bot requested a review from a team as a code owner June 13, 2025 14:38
@cit-pr-commenter cit-pr-commenter
Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 1ef3008f-cf81-4398-b3d4-0407ad6ab25d

Baseline: 67e60e8
Comparison: 911a14b
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.13 [+0.23, +2.03] 1 Logs
➖ docker_containers_cpu % cpu utilization +0.36 [-2.72, +3.44] 1 Logs
➖ quality_gate_idle memory utilization +0.36 [+0.30, +0.41] 1 Logs bounds checks dashboard
➖ quality_gate_idle_all_features memory utilization +0.24 [+0.17, +0.32] 1 Logs bounds checks dashboard
➖ file_to_blackhole_500ms_latency egress throughput +0.12 [-0.47, +0.72] 1 Logs
➖ otlp_ingest_logs memory utilization +0.12 [-0.00, +0.25] 1 Logs
➖ file_to_blackhole_0ms_latency_http1 egress throughput +0.01 [-0.59, +0.61] 1 Logs
➖ uds_dogstatsd_to_api ingress throughput +0.00 [-0.29, +0.29] 1 Logs
➖ tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.02, +0.02] 1 Logs
➖ file_to_blackhole_0ms_latency_http2 egress throughput -0.01 [-0.56, +0.53] 1 Logs
➖ file_to_blackhole_300ms_latency egress throughput -0.03 [-0.65, +0.59] 1 Logs
➖ file_to_blackhole_1000ms_latency_linear_load egress throughput -0.04 [-0.28, +0.19] 1 Logs
➖ file_to_blackhole_100ms_latency egress throughput -0.06 [-0.63, +0.52] 1 Logs
➖ file_to_blackhole_0ms_latency egress throughput -0.06 [-0.67, +0.55] 1 Logs
➖ file_to_blackhole_1000ms_latency egress throughput -0.07 [-0.66, +0.52] 1 Logs
➖ file_tree memory utilization -0.11 [-0.23, +0.01] 1 Logs
➖ docker_containers_memory memory utilization -0.11 [-0.18, -0.04] 1 Logs
➖ otlp_ingest_metrics memory utilization -0.14 [-0.31, +0.03] 1 Logs
➖ tcp_syslog_to_blackhole ingress throughput -0.34 [-0.39, -0.28] 1 Logs
➖ ddot_logs memory utilization -0.44 [-0.56, -0.32] 1 Logs
➖ ddot_metrics memory utilization -0.46 [-0.57, -0.34] 1 Logs
➖ uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization -1.00 [-1.07, -0.94] 1 Logs
➖ quality_gate_logs % cpu utilization -1.82 [-4.56, +0.92] 1 Logs bounds checks dashboard

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_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 bounds checks dashboard
✅ quality_gate_logs lost_bytes 10/10 bounds checks dashboard
✅ quality_gate_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:

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

@agent-platform-auto-pr
Copy link
Contributor Author

Static quality checks

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

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
✅ agent_deb_amd64 $${+0}$$ $${696.42}$$ < $${752.99}$$ $${-0.01}$$ $${176.06}$$ < $${187.44}$$
✅ agent_deb_amd64_fips $${-0}$$ $${694.63}$$ < $${751.36}$$ $${-0.07}$$ $${175.49}$$ < $${187.06}$$
✅ agent_heroku_amd64 $${-0}$$ $${358.71}$$ < $${369.68}$$ $${-0}$$ $${96.52}$$ < $${99.55}$$
✅ agent_msi $${+0}$$ $${958.91}$$ < $${987.01}$$ $${-0.02}$$ $${146.3}$$ < $${150.72}$$
✅ agent_rpm_amd64 $${+0}$$ $${696.41}$$ < $${752.98}$$ $${-0.01}$$ $${177.6}$$ < $${190.03}$$
✅ agent_rpm_amd64_fips $${-0}$$ $${694.62}$$ < $${751.35}$$ $${-0.01}$$ $${177.46}$$ < $${189.81}$$
✅ agent_rpm_arm64 $${+0}$$ $${686.42}$$ < $${739.42}$$ $${+0.04}$$ $${161.08}$$ < $${171.23}$$
✅ agent_rpm_arm64_fips $${+0}$$ $${684.77}$$ < $${737.91}$$ $${-0}$$ $${160.15}$$ < $${170.22}$$
✅ agent_suse_amd64 $${+0}$$ $${696.41}$$ < $${752.98}$$ $${-0.01}$$ $${177.6}$$ < $${190.03}$$
✅ agent_suse_amd64_fips $${-0}$$ $${694.62}$$ < $${751.35}$$ $${-0.01}$$ $${177.46}$$ < $${189.81}$$
✅ agent_suse_arm64 $${+0}$$ $${686.42}$$ < $${739.42}$$ $${+0.04}$$ $${161.08}$$ < $${171.23}$$
✅ agent_suse_arm64_fips $${+0}$$ $${684.77}$$ < $${737.91}$$ $${-0}$$ $${160.15}$$ < $${170.22}$$
✅ docker_agent_amd64 $${+0}$$ $${780.21}$$ < $${849.39}$$ $${+0.01}$$ $${268.69}$$ < $${288.34}$$
✅ docker_agent_arm64 $${+0}$$ $${793.67}$$ < $${858.97}$$ $${+0.01}$$ $${256.06}$$ < $${274.36}$$
✅ docker_agent_jmx_amd64 $${+0}$$ $${971.4}$$ < $${1040.59}$$ $${-0.01}$$ $${337.64}$$ < $${357.3}$$
✅ docker_agent_jmx_arm64 $${+0}$$ $${973.46}$$ < $${1038.77}$$ $${-0.03}$$ $${320.99}$$ < $${339.32}$$
✅ docker_agent_windows1809 $${-0.06}$$ $${1487.01}$$ < $${1557.19}$$ $${+0.02}$$ $${488.01}$$ < $${507.33}$$
✅ docker_agent_windows1809_core $${+0}$$ $${6217.03}$$ < $${6287.46}$$ $${0}$$ $${2048.0}$$ < $${2067.76}$$
✅ docker_agent_windows1809_core_jmx $${+0}$$ $${6338.8}$$ < $${6409.04}$$ $${0}$$ $${2048.0}$$ < $${2067.76}$$
✅ docker_agent_windows1809_jmx $${+0}$$ $${1608.7}$$ < $${1679.14}$$ $${-0.05}$$ $${530.31}$$ < $${550.27}$$
✅ docker_agent_windows2022 $${+0.06}$$ $${1506.23}$$ < $${1576.85}$$ $${+0.03}$$ $${500.77}$$ < $${520.76}$$
✅ docker_agent_windows2022_core $${+0.2}$$ $${6190.29}$$ < $${6260.53}$$ $${0}$$ $${2048.0}$$ < $${2067.76}$$
✅ docker_agent_windows2022_core_jmx $${+0.2}$$ $${6311.97}$$ < $${6382.17}$$ $${0}$$ $${2048.0}$$ < $${2067.76}$$
✅ docker_agent_windows2022_jmx $${-0.01}$$ $${1627.94}$$ < $${1698.2}$$ $${+0.01}$$ $${543.03}$$ < $${562.99}$$
✅ docker_cluster_agent_amd64 $${-0}$$ $${212.84}$$ < $${259.73}$$ $${+0}$$ $${72.38}$$ < $${103.68}$$
✅ docker_cluster_agent_arm64 $${-0}$$ $${228.68}$$ < $${274.24}$$ $${-0}$$ $${68.64}$$ < $${98.45}$$
✅ docker_cws_instrumentation_amd64 $${-0}$$ $${7.08}$$ < $${7.12}$$ $${-0}$$ $${2.95}$$ < $${3.29}$$
✅ docker_cws_instrumentation_arm64 $${-0}$$ $${6.69}$$ < $${6.92}$$ $${+0}$$ $${2.7}$$ < $${3.07}$$
✅ docker_dogstatsd_amd64 $${-0}$$ $${39.22}$$ < $${39.57}$$ $${-0}$$ $${15.12}$$ < $${15.76}$$
✅ docker_dogstatsd_arm64 $${-0}$$ $${37.88}$$ < $${38.2}$$ $${-0}$$ $${14.53}$$ < $${14.83}$$
✅ dogstatsd_deb_amd64 $${-0}$$ $${30.44}$$ < $${31.52}$$ $${-0}$$ $${8.0}$$ < $${8.97}$$
✅ dogstatsd_deb_arm64 $${-0}$$ $${29.02}$$ < $${30.08}$$ $${+0}$$ $${6.94}$$ < $${7.92}$$
✅ dogstatsd_rpm_amd64 $${-0}$$ $${30.44}$$ < $${31.52}$$ $${+0}$$ $${8.01}$$ < $${8.98}$$
✅ dogstatsd_suse_amd64 $${-0}$$ $${30.44}$$ < $${31.52}$$ $${+0}$$ $${8.01}$$ < $${8.98}$$
✅ iot_agent_deb_amd64 $${-0}$$ $${50.42}$$ < $${60.17}$$ $${+0}$$ $${12.84}$$ < $${15.82}$$
✅ iot_agent_deb_arm64 $${-0}$$ $${47.9}$$ < $${56.94}$$ $${+0}$$ $${11.14}$$ < $${13.86}$$
✅ iot_agent_deb_armhf $${-0}$$ $${47.47}$$ < $${56.41}$$ $${-0.01}$$ $${11.2}$$ < $${13.86}$$
✅ iot_agent_rpm_amd64 $${-0}$$ $${50.42}$$ < $${60.18}$$ $${+0}$$ $${12.86}$$ < $${15.84}$$
✅ iot_agent_rpm_arm64 $${-0}$$ $${47.9}$$ < $${56.94}$$ $${-0}$$ $${11.16}$$ < $${13.76}$$
✅ iot_agent_suse_amd64 $${-0}$$ $${50.42}$$ < $${60.18}$$ $${+0}$$ $${12.86}$$ < $${15.84}$$

@spencergilbert
Copy link
Contributor

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jun 13, 2025 •
edited
Loading

View all feedbacks in Devflow UI.

2025-06-13 18:33:20 UTC ℹ️ Start processing command /merge

2025-06-13 18:33:29 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in 7.68.x is approximately 0s (p90).

2025-06-13 19:09:27 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit deaf2d5 into 7.68.x Jun 13, 2025
310 checks passed
@dd-mergequeue dd-mergequeue bot deleted the backport-37819-to-7.68.x branch June 13, 2025 19:09
@github-actions github-actions bot added this to the 7.68.0 milestone Jun 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@spencergilbert spencergilbert spencergilbert approved these changes

@shaina-patel-23 shaina-patel-23 shaina-patel-23 approved these changes

Assignees
No one assigned
Labels
backport bot qa/done QA done before merge and regressions are covered by tests short review PR is simple enough to be reviewed quickly team/agent-integrations team/container-integrations
Projects
None yet
Milestone
7.68.0
Development

Successfully merging this pull request may close these issues.
2 participants
@spencergilbert @shaina-patel-23