Follow prometheus metric name best practices #67
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
**Breaking Change for Prometheus**: OhmGraphite has not been following [Prometheus best practices](https://prometheus.io/docs/practices/naming/) when it came to naming metrics. Metric names now look like "ohm_cpu_celsius" with only the "hardware" and "sensor" labels remaining. The following changes have been implemented: * `app` metric label has been removed in favor of a metric namespace prefix of "ohm" * `hardware_type` metric label has been removed in favor of encapsulating it into the metric name (eg: "cpu", "nic"). * `sensor_index` metric label has been removed. This label proved superfluous as every sensor can be uniquely identified by it's name. * `host` metric label has been removed: This falls in line with other prometheus exporters like node_exporter, which does not export the host as a label. * base unit included in metric name (like "bytes", "revolutions per minute", etc) * The value that is exported to Prometheus is now converted into base units, such as converting GB (2^30) and MB (2^20) into bytes, MHz into hertz. Other units are unaffected. There are two candidates for this conversion that were unaffected: - Flow rate is still liters per hour, even though liters per second may seem more "base-unity", but grafana contained the former but not the latter. - Fan speed remains revolutions per minute, as I'm unaware of any manufacturer reporting fan speed as revolutions per second. * Side note: OhmGraphite now follows the [official data model naming scheme](https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels) by replacing invalid characters with an underscore.
|
Seems pretty good for me! 👍 |
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Breaking Change for Prometheus: OhmGraphite has not been following Prometheus best practices when it came to naming metrics. Metric names now look like "ohm_cpu_celsius" with only the "hardware" and "sensor" labels remaining. The following changes have been implemented:
appmetric label has been removed in favor of a metric namespace prefix of "ohm"hardware_typemetric label has been removed in favor of encapsulating it into the metric name (eg: "cpu", "nic").sensor_indexmetric label has been removed. This label proved superfluous as every sensor can be uniquely identified by it's name.hostmetric label has been removed: This falls in line with other prometheus exporters like node_exporter, which does not export the host as a label.Thanks @henriquegemignani for kicking off the initial work, let me know if you think this change is worse / better.
I'll let this PR linger for a little bit to allow for a potential discussion.