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

Consistency of "packets_dropped_total" metric #641

Merged

Conversation

markmandel
Copy link
Contributor

What type of PR is this?

Uncomment only one /kind <> line, press enter to put that in a new line, and remove leading whitespace from that line:

/kind breaking
/kind bug

/kind cleanup

/kind documentation
/kind feature
/kind hotfix

What this PR does / Why we need it:

Per https://prometheus.io/docs/practices/naming/#metric-names

"A metric name should have a suffix describing the unit, in plural form Note that an accumulating count has total as a suffix, in addition to the unit if applicable."

Therefore, all "packets_dropped" metric names should be "packet_dropped_total".

This implements that change across all packets_dropped metric (which as far as I can tell is the only metric missing this suffix) for both the metric and variable name, which was sometimes implemented and sometimes not.

Which issue(s) this PR fixes:

N/A

Special notes for your reviewer:

N/A

Per https://prometheus.io/docs/practices/naming/#metric-names

"A metric name should have a suffix describing the unit, in plural form
Note that an accumulating count has `total` as a suffix, in addition to
the unit if applicable."

Therefore, all "packets_dropped" metric names should be
"packet_dropped_total".

This implements that change across all packets_dropped metric (which as
far as I can tell is the only metric missing this suffix) for both the
metric and variable name, which was sometimes implemented and sometimes
not.
@markmandel markmandel added area/operations Installation, updating, metrics etc kind/cleanup Refactoring code, fixing up documentation, etc labels Nov 3, 2022
@github-actions github-actions bot added the size/m label Nov 3, 2022
@quilkin-bot
Copy link
Collaborator

Build Succeeded 🥳

Build Id: 1f6e9ff2-08bf-4de6-89a8-6ebaca8edc93

The following development images have been built, and will exist for the next 30 days:

To build this version:

git fetch git@github.com:googleforgames/quilkin.git pull/641/head:pr_641 && git checkout pr_641
cargo build

@XAMPPRocky XAMPPRocky merged commit 05ca07f into googleforgames:main Nov 4, 2022
@markmandel markmandel deleted the metrics/packets_dropped_total branch November 8, 2022 03:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/operations Installation, updating, metrics etc kind/cleanup Refactoring code, fixing up documentation, etc size/m
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants