# Prometheus.ex v5.1.0 - Table of Contents

Elixir-friendly Prometheus monitoring system client.

## Pages

- [prometheus_and_grafana_setup](prometheus_and_grafana_setup.md)
- [Mnesia Collector](mnesia-collector.md)
- [VM Memory Collector](vm-memory-collector.md)
- [VM Statistics Collector](vm-statistics-collector.md)
- [VM System Info Collector](vm-system-info-collector.md)
- [Time](time.md)
- [LICENSE](license.md)

## Modules

- [Prometheus](Prometheus.md): 
[Prometheus.io](https://prometheus.io) client library powered by
[prometheus.erl](https://hexdocs.pm/prometheus)
- [Prometheus.Buckets](Prometheus.Buckets.md): Histogram buckets generators.

- [Prometheus.Collector](Prometheus.Collector.md): A collector for a set of metrics.
- [Prometheus.Config](Prometheus.Config.md): 
Configuration templates for custom collectors/exporters.
- [Prometheus.Contrib.HTTP](Prometheus.Contrib.HTTP.md): HTTP instrumentation helpers

- [Prometheus.Contrib.Mnesia](Prometheus.Contrib.Mnesia.md): Mnesia instrumentation helpers.

- [Prometheus.Format.Protobuf](Prometheus.Format.Protobuf.md): Serializes Prometheus registry using [protocol buffer format](http://bit.ly/2cxSuJP).

- [Prometheus.Format.Text](Prometheus.Format.Text.md): Serializes Prometheus registry using the latest [text format](http://bit.ly/2cxSuJP).
- [Prometheus.Injector](Prometheus.Injector.md): Prometheus injector.

- [Prometheus.Metric](Prometheus.Metric.md): 
Prometheus metrics shortcuts.
- [Prometheus.Metric.Boolean](Prometheus.Metric.Boolean.md): Boolean metric, to report booleans and flags.
- [Prometheus.Metric.Counter](Prometheus.Metric.Counter.md): Counter is a Metric that represents a single numerical value that only ever
goes up. That implies that it cannot be used to count items whose number can
also go down, e.g. the number of currently running processes. Those
"counters" are represented by `Prometheus.Metric.Gauge`.
- [Prometheus.Metric.Gauge](Prometheus.Metric.Gauge.md): Gauge metric, to report instantaneous values.
- [Prometheus.Metric.Histogram](Prometheus.Metric.Histogram.md): A Histogram tracks the size and number of events in buckets.
You can use Histograms for aggregating calculation of quantiles.
- [Prometheus.Metric.Summary](Prometheus.Metric.Summary.md): Summary metric, to track the size of events.
- [Prometheus.Model](Prometheus.Model.md): Helpers for working with Prometheus data model. For advanced users.
- [Prometheus.Registry](Prometheus.Registry.md): A registry of Collectors.

- Exceptions
  - [Prometheus.Config.KeyNotFoundError](Prometheus.Config.KeyNotFoundError.md): Raised when mandatory configuration option not found in app env.

  - [Prometheus.InvalidBlockArityError](Prometheus.InvalidBlockArityError.md): Raised when fn passed as block has more then 0 arguments

  - [Prometheus.InvalidBoundError](Prometheus.InvalidBoundError.md): Raised by histogram constructors when bucket bound isn't a number.

  - [Prometheus.InvalidBucketsError](Prometheus.InvalidBucketsError.md): Raised by histogram constructors when buckets are invalid i.e. not sorted in increasing
order or generator spec is unknown.

  - [Prometheus.InvalidLabelNameError](Prometheus.InvalidLabelNameError.md): Raised when label `name` is invalid i.e. can't be represented as printable utf-8 string
that matches `^[a-zA-Z_][a-zA-Z0-9_]*$` regular expression or starts with `__`.
  - [Prometheus.InvalidMetricArityError](Prometheus.InvalidMetricArityError.md): Raised when metric arity is invalid e.g. counter metric was created with two labels but
only one label value is passed to `Prometheus.Metric.Counter.inc/2`.

  - [Prometheus.InvalidMetricHelpError](Prometheus.InvalidMetricHelpError.md): Raised when given metric `help` is invalid i.e. isn't a printable utf-8 string.

  - [Prometheus.InvalidMetricLabelsError](Prometheus.InvalidMetricLabelsError.md): Raised when `labels` isn't a list.

  - [Prometheus.InvalidMetricNameError](Prometheus.InvalidMetricNameError.md): Raised when given metric `name` is invalid i.e. can't be represented as printable utf-8
string that matches `^[a-zA-Z_:][a-zA-Z0-9_:]*$` regular expression.

  - [Prometheus.InvalidValueError](Prometheus.InvalidValueError.md): Raised when given `value` is invalid i.e. when you pass a negative number to
`Prometheus.Metric.Counter.inc/2`.

  - [Prometheus.MFAlreadyExistsError](Prometheus.MFAlreadyExistsError.md): Raised when one tries to create metric in `registry` with `name` it already exists.

  - [Prometheus.MissingMetricSpecKeyError](Prometheus.MissingMetricSpecKeyError.md): Raised when required metric `spec` `key` is missing. All metrics
require at least `name` and when metric created `help`.
  - [Prometheus.NoBucketsError](Prometheus.NoBucketsError.md): Raised by histogram constructors when buckets can't be found in spec, or
found value is empty list.

  - [Prometheus.UnknownMetricError](Prometheus.UnknownMetricError.md)