[release-1.5] Replace metric labels' none values with empty values #14918

machadovilaca · 2025-06-11T17:16:32Z

manual cherry-pick of #14805

Before this PR:

kubevirt_vmi_info and kubevirt_vm_info should not report for missing labels. Like workload, flavor, instance_type, and preference.

This complicates the dashboards, since we don't want to show value for labels that don't exist.

After this PR:

We only report labels if we have data for them

Fixes #

jira-ticket: https://issues.redhat.com/browse/CNV-62761

Partially addresses #
-->

Why we need it and why it was done in this way

The following tradeoffs were made:

The following alternatives were considered:

Links to places where the discussion took place:

Special notes for your reviewer

Checklist

This checklist is not enforcing, but it's a reminder of items that could be relevant to every PR.
Approvers are expected to review this list.

Design: A design document was considered and is present (link) or not required
PR: The PR description is expressive enough and will help future contributors
Code: Write code that humans can understand and Keep it simple
Refactor: You have left the code cleaner than you found it (Boy Scout Rule)
Upgrade: Impact of this change on upgrade flows was considered and addressed if required
Testing: New code requires new unit tests. New features and bug fixes require at least one e2e test
Documentation: A user-guide update was considered and is present (link) or not required. You want a user-guide update if it's a user facing feature / API change.
Community: Announcement to kubevirt-dev was considered

Release note

Replace metric labels' none values with empty values

Signed-off-by: João Vilaça <[email protected]>

machadovilaca · 2025-06-11T17:17:37Z

/cc @sradco @enp0s3

sradco · 2025-06-11T18:06:25Z

pkg/monitoring/metrics/virt-controller/vmistats_collector.go

 const (
-	none  = "<none>"
+	none  = "" // Empty values will be ignored by operator-observability and label will not be created
 	other = "<other>"


What is "other"?

custom instance types and preferences not whitelisted (not provided by neither kubevirt or redhat) to reduce cardinality of the metrics

Please update to other.

this is a backport, should be done now in different prs/jira issues

machadovilaca · 2025-06-16T10:09:48Z

/test pull-kubevirt-build

kubevirt-bot · 2025-06-16T10:09:53Z

@machadovilaca: The specified target(s) for /test were not found.
The following commands are available to trigger required jobs:

/test pull-kubevirt-apidocs-1.5

/test pull-kubevirt-build-1.5

/test pull-kubevirt-build-arm64-1.5

/test pull-kubevirt-build-s390x-1.5

/test pull-kubevirt-check-unassigned-tests-1.5

/test pull-kubevirt-client-python-1.5

/test pull-kubevirt-code-lint-1.5

/test pull-kubevirt-e2e-k8s-1.30-sig-compute-1.5

/test pull-kubevirt-e2e-k8s-1.30-sig-network-1.5

/test pull-kubevirt-e2e-k8s-1.30-sig-operator-1.5

/test pull-kubevirt-e2e-k8s-1.30-sig-storage-1.5

/test pull-kubevirt-e2e-k8s-1.31-sig-compute-1.5

/test pull-kubevirt-e2e-k8s-1.31-sig-monitoring-1.5

/test pull-kubevirt-e2e-k8s-1.31-sig-network-1.5

/test pull-kubevirt-e2e-k8s-1.31-sig-operator-1.5

/test pull-kubevirt-e2e-k8s-1.31-sig-performance-1.5

/test pull-kubevirt-e2e-k8s-1.31-sig-storage-1.5

/test pull-kubevirt-e2e-k8s-1.32-ipv6-sig-network-1.5

/test pull-kubevirt-e2e-k8s-1.32-sig-compute-1.5

/test pull-kubevirt-e2e-k8s-1.32-sig-compute-migrations-1.5

/test pull-kubevirt-e2e-k8s-1.32-sig-compute-serial-1.5

/test pull-kubevirt-e2e-k8s-1.32-sig-network-1.5

/test pull-kubevirt-e2e-k8s-1.32-sig-operator-1.5

/test pull-kubevirt-e2e-k8s-1.32-sig-storage-1.5

/test pull-kubevirt-e2e-kind-1.30-vgpu-1.5

/test pull-kubevirt-e2e-kind-sriov-1.5

/test pull-kubevirt-e2e-windows2016-1.5

/test pull-kubevirt-generate-1.5

/test pull-kubevirt-manifests-1.5

/test pull-kubevirt-prom-rules-verify-1.5

/test pull-kubevirt-unit-test-1.5

/test pull-kubevirt-unit-test-s390x-1.5

/test pull-kubevirt-verify-go-mod-1.5

The following commands are available to trigger optional jobs:

/test build-kubevirt-builder-1.5

/test pull-kubevirt-check-tests-for-flakes-1.5

/test pull-kubevirt-e2e-k8s-1.31-sig-compute-root-1.5

/test pull-kubevirt-e2e-k8s-1.31-sig-storage-root-1.5

/test pull-kubevirt-e2e-k8s-1.32-sig-compute-realtime-1.5

/test pull-kubevirt-e2e-k8s-1.32-sig-network-multus-v4-1.5

/test pull-kubevirt-e2e-k8s-1.32-sig-performance-kwok-1.5

/test pull-kubevirt-e2e-k8s-1.32-single-node-1.5

/test pull-kubevirt-e2e-k8s-1.32-swap-enabled-1.5

/test pull-kubevirt-fuzz-1.5

/test pull-kubevirt-gosec-1.5

/test pull-kubevirt-metrics-lint-1.5

/test pull-kubevirt-unit-test-arm64-1.5

/test pull-kubevirt-verify-rpms-1.5

Use /test all to run the following jobs that were automatically triggered:

pull-kubevirt-apidocs-1.5

pull-kubevirt-build-1.5

pull-kubevirt-build-arm64-1.5

pull-kubevirt-build-s390x-1.5

pull-kubevirt-check-tests-for-flakes-1.5

pull-kubevirt-check-unassigned-tests-1.5

pull-kubevirt-client-python-1.5

pull-kubevirt-code-lint-1.5

pull-kubevirt-e2e-k8s-1.30-sig-compute-1.5

pull-kubevirt-e2e-k8s-1.30-sig-network-1.5

pull-kubevirt-e2e-k8s-1.30-sig-operator-1.5

pull-kubevirt-e2e-k8s-1.30-sig-storage-1.5

pull-kubevirt-e2e-k8s-1.31-sig-compute-1.5

pull-kubevirt-e2e-k8s-1.31-sig-monitoring-1.5

pull-kubevirt-e2e-k8s-1.31-sig-network-1.5

pull-kubevirt-e2e-k8s-1.31-sig-operator-1.5

pull-kubevirt-e2e-k8s-1.31-sig-performance-1.5

pull-kubevirt-e2e-k8s-1.31-sig-storage-1.5

pull-kubevirt-e2e-k8s-1.32-ipv6-sig-network-1.5

pull-kubevirt-e2e-k8s-1.32-sig-compute-1.5

pull-kubevirt-e2e-k8s-1.32-sig-compute-migrations-1.5

pull-kubevirt-e2e-k8s-1.32-sig-compute-serial-1.5

pull-kubevirt-e2e-k8s-1.32-sig-network-1.5

pull-kubevirt-e2e-k8s-1.32-sig-operator-1.5

pull-kubevirt-e2e-k8s-1.32-sig-storage-1.5

pull-kubevirt-e2e-kind-1.30-vgpu-1.5

pull-kubevirt-e2e-kind-sriov-1.5

pull-kubevirt-e2e-windows2016-1.5

pull-kubevirt-fuzz-1.5

pull-kubevirt-generate-1.5

pull-kubevirt-manifests-1.5

pull-kubevirt-prom-rules-verify-1.5

pull-kubevirt-unit-test-1.5

pull-kubevirt-unit-test-arm64-1.5

pull-kubevirt-unit-test-s390x-1.5

pull-kubevirt-verify-go-mod-1.5

Details

In response to this:

/test pull-kubevirt-build

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

machadovilaca · 2025-06-16T10:17:09Z

/test pull-kubevirt-build-1.5

sradco · 2025-06-23T18:08:41Z

/approve

@avlitman please review

enp0s3 · 2025-07-07T11:43:32Z

/approve

kubevirt-bot · 2025-07-07T11:43:41Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: enp0s3, sradco

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~OWNERS~~ [enp0s3]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

machadovilaca · 2025-07-07T15:22:54Z

/lgtm

kubevirt-bot · 2025-07-07T15:22:56Z

@machadovilaca: you cannot LGTM your own PR.

Details

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

sradco · 2025-07-07T15:25:01Z

/lgtm

brianmcarey · 2025-07-07T16:13:58Z

/test pull-kubevirt-unit-test-s390x-1.5

Replace metric labels' none values with empty values

7a715a7

Signed-off-by: João Vilaça <[email protected]>

kubevirt-bot added release-note Denotes a PR that will be considered when it comes time to generate release notes. dco-signoff: yes Indicates the PR's author has DCO signed all their commits. labels Jun 11, 2025

kubevirt-bot requested review from orenc1 and victortoso June 11, 2025 17:16

kubevirt-bot added size/XL sig/observability Denotes an issue or PR that relates to observability. labels Jun 11, 2025

dosubot bot added the area/monitoring label Jun 11, 2025

kubevirt-bot requested review from enp0s3 and sradco June 11, 2025 17:17

sradco reviewed Jun 11, 2025

View reviewed changes

machadovilaca changed the title ~~Replace metric labels' none values with empty values~~ [release-1.5] Replace metric labels' none values with empty values Jul 7, 2025

kubevirt-bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jul 7, 2025

kubevirt-bot assigned sradco Jul 7, 2025

kubevirt-bot added the lgtm Indicates that a PR is ready to be merged. label Jul 7, 2025

kubevirt-bot merged commit af7734c into kubevirt:release-1.5 Jul 7, 2025
37 checks passed

[release-1.5] Replace metric labels' none values with empty values #14918

[release-1.5] Replace metric labels' none values with empty values #14918

Uh oh!

Conversation

machadovilaca commented Jun 11, 2025

Why we need it and why it was done in this way

Special notes for your reviewer

Checklist

Release note

Uh oh!

machadovilaca commented Jun 11, 2025

Uh oh!

sradco Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

machadovilaca Jun 11, 2025

Choose a reason for hiding this comment

Uh oh!

sradco Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

machadovilaca Jun 12, 2025

Choose a reason for hiding this comment

Uh oh!

machadovilaca commented Jun 16, 2025

Uh oh!

kubevirt-bot commented Jun 16, 2025

Uh oh!

machadovilaca commented Jun 16, 2025

Uh oh!

sradco commented Jun 23, 2025

Uh oh!

enp0s3 commented Jul 7, 2025

Uh oh!

kubevirt-bot commented Jul 7, 2025

Uh oh!

machadovilaca commented Jul 7, 2025

Uh oh!

kubevirt-bot commented Jul 7, 2025

Uh oh!

sradco commented Jul 7, 2025

Uh oh!

brianmcarey commented Jul 7, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants