Please help improve it by filing issues or pull requests. Grams is preferred over kilograms to avoid issues with the kilo prefix. Prefer exporting a counter of joules, then rate(joules) gives you power in Watts. The usual metric name follows the pattern A_per_B. ratio is only used as a suffix for names like disk_usage_ratio. To avoid confusion combining different metrics, always use bytes, even where bits appear more common. kelvin is acceptable as a base unit in special cases like color temperature or where temperature has to be absolute. The following lists some metrics families with their base unit.Ĭelsius is preferred over kelvin for practical reasons. Prometheus does not have any units hard coded. (many different label values), such as user IDs, email addresses, or other Do not use labels to store dimensions with high cardinality Pairs represents a new time series, which can dramatically increase the amount api_request_duration_seconds - differentiate request stages: stage='extract|transform|load'ĭo not put the label names in the metric name, as this introduces redundancyĪnd will cause confusion if the respective labels are aggregated away.ĬAUTION: Remember that every unique combination of key-value label.api_http_requests_total - differentiate request types: operation='create|update|delete'.Use labels to differentiate the characteristics of the thing that is being measured: Queue with the current number of elements in the queue is not. For example, having theĬapacity of various queues in one metric is good, while mixing the capacity of a Meaningful, split the data up into multiple metrics. Given metric should be meaningful (though not necessarily useful). instantaneous resource usage as a percentageĪs a rule of thumb, either the sum() or the avg() over all dimensions of a.should represent the same logical thing-being-measured across all label (for a timestamp that tracks the time of the latest record processed in a data processing pipeline) data_pipeline_last_record_processed_ timestamp_seconds.(for a pseudo-metric that provides metadata about the running binary) Note that an accumulating count has total as a suffix, in addition to the unit if applicable. should have a suffix describing the unit, in plural form. seconds, bytes, meters - not milliseconds, megabytes, kilometers). do not mix seconds with milliseconds, or seconds with bytes). Generic, like standardized metrics exported by client libraries. For metrics specific to an application, the prefix is The prefix is sometimes referred to as namespace byĬlient libraries. should have a (single-word) application prefix relevant to the domain the

must comply with the data model for valid characters.

Individual organizations may want to approach some of these The metric and label conventions presented in this document are not requiredįor using Prometheus, but can serve as both a style-guide and a collection ofīest practices.

Word counter io