Reliable Insights

A blog on monitoring, scale and operational sanity

Exposing the software version to Prometheus

I’ve previously mentioned that you shouldn’t have the version of your software as either a target label, or exposed via a label on all metrics of your server as it’ll make using the metrics more challenging. What should you do instead?

The way to approach this is the similar to machine roles. You expose a single time series with all the labels you want, and the value 1. For example Prometheus itself exports a time series called prometheus_build_info:

prometheus_build_info{branch="HEAD",goversion="go1.6.2",
    revision="16d70a8b6bd90f0ff793813405e84d5724a9ba65",version="1.0.1"} 1

To export a metric like this with Python we’d do:

build_info = Gauge('prometheus_build_info', 'Build information', 
    ['branch', 'goversion', 'revision', 'version'])
build_info.labels('HEAD', 'go1.6.2', 
    '16d70a8b6bd90f0ff793813405e84d5724a9ba65', '1.0.1').set(1)

(Don’t ask why a Python program has a Go version).

 

This isn’t much use on its own, how can we slice and aggregate based on it?

Selecting all instances with a particular label can be done with the and operator, which will return the right hand side if the labels on the left hand side has matching labels. For example to display the number of time series for all Prometheus servers running 1.0.1:

  prometheus_local_storage_memory_series{job="prometheus"}
and on (instance, job)
  prometheus_build_info{job="prometheus",version="1.0.1"}

 

If you want to add the version label to a time series you can do:

  prometheus_local_storage_memory_series{job="prometheus"}
* on (instance, job) group_left(version)
  prometheus_build_info{job="prometheus",version="1.0.1"}

 

To top it off, let’s find the average number of time series per Prometheus version:

avg by (version)(
    prometheus_local_storage_memory_series{job="prometheus"}
  * on (instance, job) group_left(version)
    prometheus_build_info{job="prometheus"}
)

 

This is just a small taste of what’s possible. This technique can be extended to information beyond software version!

Brian BrazilExposing the software version to Prometheus
Share this post

Related Posts