package prometheus

  1. Overview
  2. Docs

Module PrometheusSource

Collect metrics for Prometheus. See: https://prometheus.io/

Notes:

  • The Prometheus docs require that client libraries are thread-safe. We interpret this to mean safe with Lwt threads, NOT with native threading.
  • This library is intended to be a dependency of any library that might need to report metrics, even though many applications will not enable it. Therefore it should have minimal dependencies.
Sourcetype metric_type =
  1. | Counter
  2. | Gauge
  3. | Summary
  4. | Histogram
Sourcemodule type NAME = sig ... end

A string that meets some additional requirements.

A valid name for a metric.

A valid name for a label.

Sourcemodule MetricInfo : sig ... end

Metadata about a metric.

Sourcemodule LabelSetMap : Asetmap.Map.S with type key = string list

A map indexed by a set of labels.

A map indexed by metric families.

Sourcemodule Sample_set : sig ... end
Sourcemodule CollectorRegistry : sig ... end

A collection of metric reporters. Usually, only CollectorRegistry.default is used.

Sourcemodule type METRIC = sig ... end

Operations common to all types of metric.

Sourcemodule Counter : sig ... end

A counter is a cumulative metric that represents a single numerical value that only ever goes up.

Sourcemodule Gauge : sig ... end

A gauge is a metric that represents a single numerical value that can arbitrarily go up and down.

Sourcemodule Summary : sig ... end

A summary is a metric that records both the number of readings and their total. This allows calculating the average.

Sourcemodule Histogram_spec : sig ... end
Sourcemodule type HISTOGRAM = sig ... end
Sourcemodule Histogram (Buckets : sig ... end) : HISTOGRAM

A histogram configured with reasonable defaults for measuring network request times in seconds.