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

Consistent labeling for Operator metric Services #846

Open
jsmolar opened this issue Sep 2, 2024 · 3 comments
Open

Consistent labeling for Operator metric Services #846

jsmolar opened this issue Sep 2, 2024 · 3 comments

Comments

@jsmolar
Copy link

jsmolar commented Sep 2, 2024

Current labeling for Operator Metric Services

  • kuadrant-operator-metrics - control-plane=controller-manager
  • authorino-operator-metrics - control-plane=authorino-operator
  • limitador-operator-metrics - control-plane=controller-manager
  • dns-operator-controller-manager-metrics-service - control-plane=dns-operator-controller-manager

Proposed Change

To achieve consistency in the labeling of Operator metric services, I propose aligning the labels according to the pattern implemented by the authorino-operator, or by a new common pattern.

Two potential approaches:

  1. Change label value to reflect correct service
    kuadrant-operator-metrics - control-plane=kuadrant-operator
    authorino-operator-metrics - control-plane=authorino-operator
    limitador-operator-metrics - control-plane=limitador-operator
    dns-operator-metrics - control-plane=dns-operator

  2. Change both key and value
    kuadrant-operator-metrics - component=kuadrant-operator
    authorino-operator-metrics - component=authorino-operator
    limitador-operator-metrics - component=limitador-operator
    dns-operator-metrics - component=dns-operator

@david-martin
Copy link
Member

When labels are changed, please also update the ServiceMonitors as needed to ensure they target the correct Services.
See #953 (comment) for related discussion on this.

@Boomatang
Copy link
Contributor

@david-martin Now that V1 is out. How much issues can be caused by changing the labels for metrics? Would it be regarded as a breaking change?

@david-martin
Copy link
Member

Would it be regarded as a breaking change

Strictly, yes.

Less strictly, depends on if they are being used by anyone/anything yet. Even then, the surface area may be sufficiently small that the beneift of the change indicated in this issue outweighs the work required.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

No branches or pull requests

3 participants