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

KSM aggregator supports standard labels and labelsAsTags #26480

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

keisku
Copy link
Contributor

@keisku keisku commented Jun 10, 2024

What does this PR do?

The following metrics/service checks support standard labels and user-defined labels through LabelsAsTags config.

  • kubernetes_state.*.count
  • kubernetes_state.job.complete
  • kubernetes_state.job.completion.{succeeded,failed}
  • kubernetes_state.node.{cpu,memory,gpu,mig}_allocatable.total
  • kubernetes_state.node.{cpu,memory,gpu,mig}_capacity.total
  • kubernetes_state.container.{cpu,memory}_requested.total
  • kubernetes_state.container.{cpu,memory}_limit.total

Ref:

Motivation

Tags of those metrics are limited because of the following reason.

// maxNumberOfAllowedLabels contains the maximum number of labels that can be used to aggregate metrics.
// The only reason why there is a maximum is because the `accumulator` map is indexed on the label values
// and GO accepts arrays as valid map key type, but not slices.
// This hard coded limit is fine because the metrics to aggregate and the label list to use are hardcoded
// in the code and cannot be arbitrarily set by the end-user.
const maxNumberOfAllowedLabels = 4

Additional Notes

Possible Drawbacks / Trade-offs

Describe how to test/QA your changes

Copy link

codecov bot commented Jun 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 30.16%. Comparing base (4dd3f74) to head (a86e3b6).

Additional details and impacted files
@@             Coverage Diff             @@
##             main   #26480       +/-   ##
===========================================
- Coverage   44.94%   30.16%   -14.78%     
===========================================
  Files        2354       37     -2317     
  Lines      272845     3424   -269421     
===========================================
- Hits       122639     1033   -121606     
+ Misses     140536     2351   -138185     
+ Partials     9670       40     -9630     
Flag Coverage Δ
amzn_aarch64 ?
centos_x86_64 ?
ubuntu_aarch64 ?
ubuntu_x86_64 30.16% <ø> (-15.62%) ⬇️
windows_amd64 ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@keisku keisku changed the title KSM Aggregators support standard labels and labelsAsTags KSM aggregators support standard labels and labelsAsTags Jun 10, 2024
@pr-commenter
Copy link

pr-commenter bot commented Jun 10, 2024

Regression Detector

Regression Detector Results

Run ID: 13e54a8e-3d8b-446b-9e0f-e465b3ce257a Metrics dashboard Target profiles

Baseline: 6a6c459
Comparison: 5338888

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

No significant changes in experiment optimization goals

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

There were no significant changes in experiment optimization goals at this confidence level and effect size tolerance.

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI links
tcp_syslog_to_blackhole ingress throughput +2.94 [-10.07, +15.94] Logs
pycheck_1000_100byte_tags % cpu utilization +0.90 [-3.79, +5.59] Logs
idle memory utilization +0.50 [+0.47, +0.54] Logs
otel_to_otel_logs ingress throughput +0.21 [-0.60, +1.02] Logs
uds_dogstatsd_to_api ingress throughput +0.00 [-0.00, +0.00] Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.01] Logs
file_tree memory utilization -0.71 [-0.76, -0.66] Logs
basic_py_check % cpu utilization -0.75 [-3.48, +1.97] Logs
uds_dogstatsd_to_api_cpu % cpu utilization -1.47 [-2.36, -0.58] Logs

Explanation

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

@keisku keisku force-pushed the keisku/expand-aggregator-metrics-tags branch from 00fac2b to a9a524c Compare June 15, 2024 07:47
@keisku keisku changed the title KSM aggregators support standard labels and labelsAsTags KSM aggregator supports standard labels and labelsAsTags Jun 15, 2024
@pr-commenter
Copy link

pr-commenter bot commented Jun 15, 2024

Test changes on VM

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

inv create-vm --pipeline-id=37388967 --os-family=ubuntu

Note: This applies to commit 5338888

@keisku keisku force-pushed the keisku/expand-aggregator-metrics-tags branch 4 times, most recently from f4b482d to fca9623 Compare June 17, 2024 03:35
@keisku keisku force-pushed the keisku/expand-aggregator-metrics-tags branch from fca9623 to e24c2c2 Compare June 17, 2024 04:39
@@ -487,34 +487,6 @@ func TestProcessMetrics(t *testing.T) {
},
},
},
{
name: "phase tag for ns",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This test case is moved to "sumValuesAggregator aggregates namespace.count" in pkg/collector/corechecks/cluster/ksm/kubernetes_state_aggregators_test.go.

@keisku keisku force-pushed the keisku/expand-aggregator-metrics-tags branch 5 times, most recently from 87da68b to 43f2b98 Compare June 24, 2024 01:55
@keisku keisku force-pushed the keisku/expand-aggregator-metrics-tags branch from 43f2b98 to 5338888 Compare June 24, 2024 02:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant