Skip to content

Fix the naming for Metrics as per convention #7810

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
Apr 3, 2024
Merged

Fix the naming for Metrics as per convention #7810

merged 1 commit into from
Apr 3, 2024

Conversation

khrm
Copy link
Contributor

@khrm khrm commented Mar 27, 2024 •
edited
Loading

Most of the metrics aren't as per convention. This fixes it in a backward-compatible way. We introduce metrics with compliant naming.
Gauge metrics: Gauge metrics shouldn't end with count as it implies a counter.
Counter metrics: Counter metrics shouldn't end with count as it implies a
counter from the histogram. Instead, we should use total.
https://prometheus.io/docs/practices/naming/
https://www.robustperception.io/on-the-naming-of-things/
Fixes #7096

Changes

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • pre-commit Passed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

We introduce new metrics with compliant naming.
Gauge metrics: Gauge metrics shouldn't end with count as it implies a counter.
Counter metrics: Counter metrics shouldn't end with count as it implies a counter from the histogram. Instead, we should use total.

Previous Metrics are deprecated because they don't satisfy the Prometheus naming convention.  Consult https://github.com/tektoncd/pipeline/blob/main/docs/metrics.md to know the updated names and tags.

@tekton-robot tekton-robot added the release-note-none Denotes a PR that doesnt merit a release note. label Mar 27, 2024
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Mar 27, 2024
khrm
khrm commented Mar 27, 2024
View reviewed changes
Copy link
Contributor Author

@khrm khrm left a comment

Choose a reason for hiding this comment

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

/kind bug

@tekton-robot tekton-robot added the kind/bug Categorizes issue or PR as related to a bug. label Mar 27, 2024
@khrm
Copy link
Contributor Author

khrm commented Mar 27, 2024

/test check-pr-has-kind-label

@tekton-robot
Copy link
Collaborator

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

  • /test pull-tekton-pipeline-alpha-integration-tests
  • /test pull-tekton-pipeline-beta-integration-tests
  • /test pull-tekton-pipeline-build-tests
  • /test pull-tekton-pipeline-integration-tests
  • /test pull-tekton-pipeline-unit-tests

The following commands are available to trigger optional jobs:

  • /test pull-tekton-pipeline-go-coverage

Use /test all to run all jobs.

In response to this:

/test check-pr-has-kind-label

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/test-infra repository.

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

@khrm
Copy link
Contributor Author

khrm commented Mar 28, 2024

@vdemeester Please look into this.

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. and removed release-note-none Denotes a PR that doesnt merit a release note. labels Mar 28, 2024
vdemeester
vdemeester reviewed Mar 28, 2024
View reviewed changes
Copy link
Member

@vdemeester vdemeester left a comment

Choose a reason for hiding this comment

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

This is backward compatible because we don't remove any metrics (that we rename), right ? Can the commit message (and the PR description) list the changes and why ? It's present in the issue but when we look at the code history we won't look at the github issue. Also the issue only talks about *_total but it seems there is more thingsy added.

@khrm khrm force-pushed the metricsConv branch 2 times, most recently from 0314a4b to 8d53a40 Compare March 28, 2024 14:44
@khrm
Fix the naming for Metrics as per convention
d7c1039 
Most of the metrics aren't as per convention. This fixes it in a backward
compatible way. We introduce metrics with compliant naming.
Gauge metrics: Gauge metrics shouldn't end with `count` as it implies a counter.
Counter metrics: Counter metrics shouldn't end with `count` as it implies a
counter from histogram. Instead, we should use `total`.
https://prometheus.io/docs/practices/naming/
https://www.robustperception.io/on-the-naming-of-things/
khrm
khrm commented Mar 28, 2024
View reviewed changes
Copy link
Contributor Author

@khrm khrm left a comment

Choose a reason for hiding this comment

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

@vdemeester Please check now.

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
pkg/pipelinerunmetrics/metrics.go 82.9% 84.0% 1.2
pkg/taskrunmetrics/metrics.go 84.0% 84.8% 0.8

khrm
khrm commented Apr 2, 2024
View reviewed changes
Copy link
Contributor Author

@khrm khrm left a comment

Choose a reason for hiding this comment

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

@vdemeester @afrittoli Can we get this merged before v0.59.0? So please review this.

@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vdemeester

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

The pull request process is described here

Needs approval from an approver in each of these files:

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 2, 2024
@JeromeJu JeromeJu self-assigned this Apr 2, 2024
@chitrangpatel
Copy link
Contributor

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Apr 3, 2024
@tekton-robot tekton-robot merged commit 4203fbd into tektoncd:main Apr 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vdemeester vdemeester vdemeester approved these changes

@dibyom dibyom Awaiting requested review from dibyom

Assignees

@chitrangpatel chitrangpatel

@JeromeJu JeromeJu

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/bug Categorizes issue or PR as related to a bug. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Metrics aren't in Convention
5 participants
@khrm @tekton-robot @chitrangpatel @vdemeester @JeromeJu