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

[collectd 6] df plugin: Align metrics with OpenTelemetry recommendations. #4218

Merged
merged 7 commits into from
Jan 19, 2024

Conversation

octo
Copy link
Member

@octo octo commented Dec 29, 2023

  • Fixed an error that caused inode utilization (a ratio) to be reported as "usage" (a count).
  • Report utilization as "ratio" (i.e. fraction of one) instead of percentage.
  • Change label names to match OpenTelemetry semantic conventions. E.g. use system.filesystem.state instead of state.
  • Report the filesystem mode (read-only, read-write).

ChangeLog: DF plugin: The metric schema has been aligned with OpenTelemetry semantic conventions.

@octo octo requested a review from a team as a code owner December 29, 2023 09:12
@collectd-bot collectd-bot added this to the 6.0 milestone Dec 29, 2023
@octo octo added this to In progress in collectd 6 via automation Dec 29, 2023
@octo octo modified the milestones: 6.0, 6 MVP Jan 3, 2024
@octo octo requested a review from a team as a code owner January 10, 2024 21:12
@octo octo added Feature Automerge Labels PRs to be merged by a bot once approved labels Jan 11, 2024
Copy link
Contributor

@eero-t eero-t left a comment

Choose a reason for hiding this comment

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

Approved.

I've suggested option names that are IMHO more readable/understandable, but such change can be done in separate PR (updating also options for already merged other PRs).

Comment on lines +671 to +672
# ReportUsage true
# ReportUtilization false
Copy link
Contributor

Choose a reason for hiding this comment

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

While I haven't complained about these in other PRs, I think these names are too similar i.e. easily confused. Adding unit to their names would make them more understandable without user needing to resort to documentation:

Suggested change
# ReportUsage true
# ReportUtilization false
# UsageBytes true
# UtilizationRatio false

What do you think?

Comment on lines +74 to +75
static bool report_usage = true;
static bool report_utilization;
Copy link
Contributor

Choose a reason for hiding this comment

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

If config option names are changed, maybe these too?

Suggested change
static bool report_usage = true;
static bool report_utilization;
static bool report_bytes = true;
static bool report_ratio;

@collectd-bot collectd-bot merged commit ec9c06b into collectd:collectd-6.0 Jan 19, 2024
27 checks passed
collectd 6 automation moved this from In progress to Done Jan 19, 2024
@octo
Copy link
Member Author

octo commented Jan 19, 2024

I agree that "usage" and "utilization" can be confusing. I quite liked the old "absolute" vs. "relative" framing, that was very intuitive for me.

Absolute/relative is also much better than usage/utilization. I don't really care whether it's that, or adding units, as long as those IMHO usability-wise awful usage/utilization names are avoided.

I don't particularly like to add the unit, since I'd like to have one common set of options across all "standard" plugins.

Yes, those names should be consistent across plugins. I.e. such changes are better in separate PR that changes all relevant names.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Automerge Labels PRs to be merged by a bot once approved Feature
Projects
collectd 6
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants