promstat/README.rst

1.2 KiB

promstat

Library for reporting stats to both statsd and prometheus.

statsd and prometheus are both popular metrics collecting systems, but they operate quite differently from each other. promstat is a wrapper abstraction library around the statsd and prometheus clients that allows instrumenting code once so that operators can integrate with either system.

prometheus has a more structured reporting system, so the calling semantics of prometheus_client are used. Each metric reporter has an additional field, template which is a statsd metric name template to be used for the statsd reporting.

promstat does not have a global Registry like prometheus_client defaults to using. If you want to use the global Registry object with promstat, pass prometheus_client.REGISTRY to the registry parameter of the PromStat constructor.