Prometheus.ex v1.0.0-alpha10 Prometheus.Metric.Histogram
A Histogram tracks the size and number of events in buckets. You can use Histograms for aggregatable calculation of quantiles.
Example use cases for Histograms:
- Response latency;
- Request size.
Histogram expects buckets
key in a metric spec. Buckets can be:
- a list of numbers in increasing order;
one of the generate specs (shortcuts for
Prometheus.Buckets
macros)- :default;
- {:linear, start, step, count};
- {:exponential, start, step, count}.
Example:
defmodule ExampleInstrumenter do
use Prometheus.Metric
## to be called at app/supervisor startup.
## to tolerate restarts use declare.
def setup do
Histogram.new([name: :http_request_duration_milliseconds,
labels: [:method],
buckets: [100, 300, 500, 750, 1000],
help: "Http Request execution time."])
end
def instrument(%{time: time, method: method}) do
Histogram.observe([name: :http_request_duration_milliseconds, labels: [method]], time)
end
end
Summary
Macros
Creates a histogram using spec
.
Histogram cannot have a label named “le”
Observes the given amount.
If amount
happened to be a float number even one time(!) you shouldn’t use observe/2
after dobserve
Creates a histogram using spec
.
Histogram cannot have a label named “le”
Observes the given amount
Observes the amount of seconds spent executing fun
Removes histogram series identified by spec
Resets the value of the histogram identified by spec
Returns the value of the histogram identified by spec
. If there is no histogram for
given labels combination, returns :undefined
Macros
Creates a histogram using spec
.
Histogram cannot have a label named “le”.
If a histogram with the same spec
exists returns false
.
Raises Prometheus.MissingMetricSpecKeyError
if required spec
key is missing.
Raises Prometheus.InvalidMetricNameError
if metric name is invalid.
Raises Prometheus.InvalidMetricHelpError
if help is invalid.
Raises Prometheus.InvalidMetricLabelsError
if labels isn’t a list.
Raises Prometheus.InvalidMetricNameError
if label name is invalid.
Raises Prometheus.InvalidValueError
exception if duration_unit is unknown or doesn’t match metric name.
Histogram-specific exceptions:
Raises Prometheus.HistogramNoBucketsError
if buckets are missing, not a list, empty list or not known buckets spec.
Raises Prometheus.HistogramInvalidBucketsError
if buckets aren’t in increasing order.
Raises Prometheus.HistogramInvalidBoundError
if bucket bound isn’t a number.
Observes the given amount.
If amount
happened to be a float number even one time(!) you shouldn’t use observe/2
after dobserve.
Raises Prometheus.InvalidValueError
exception if amount
isn’t a positive integer.
Raises Prometheus.UnknownMetricError
exception if a histogram for spec
can’t be found.
Raises Prometheus.InvalidMetricArityError
exception if labels count mismatch.
Creates a histogram using spec
.
Histogram cannot have a label named “le”.
Raises Prometheus.MissingMetricSpecKeyError
if required spec
key is missing.
Raises Prometheus.InvalidMetricNameError
if metric name is invalid.
Raises Prometheus.InvalidMetricHelpError
if help is invalid.
Raises Prometheus.InvalidMetricLabelsError
if labels isn’t a list.
Raises Prometheus.InvalidMetricNameError
if label name is invalid.
Raises Prometheus.InvalidValueError
exception if duration_unit is unknown or doesn’t match metric name.
Raises Prometheus.MFAlreadyExistsError
if a histogram with the same spec
exists.
Histogram-specific exceptions:
Raises Prometheus.HistogramNoBucketsError
if buckets are missing, not a list, empty list or not known buckets spec.
Raises Prometheus.HistogramInvalidBucketsError
if buckets aren’t in increasing order.
Raises Prometheus.HistogramInvalidBoundError
if bucket bound isn’t a number.
Observes the given amount.
Raises Prometheus.InvalidValueError
exception if amount
isn’t a positive integer.
Raises Prometheus.UnknownMetricError
exception if a histogram for spec
can’t be found.
Raises Prometheus.InvalidMetricArityError
exception if labels count mismatch.
Observes the amount of seconds spent executing fun
.
Raises Prometheus.UnknownMetricError
exception if a histogram for spec
can’t be found.
Raises Prometheus.InvalidMetricArityError
exception if labels count mismatch.
Raises Prometheus.InvalidValueError
exception if fun isn’t a function or block.
Removes histogram series identified by spec.
Raises Prometheus.UnknownMetricError
exception if a gauge for spec
can’t be found.
Raises Prometheus.InvalidMetricArityError
exception if labels count mismatch.
Resets the value of the histogram identified by spec
.
Raises Prometheus.UnknownMetricError
exception if a histogram for spec
can’t be found.
Raises Prometheus.InvalidMetricArityError
exception if labels count mismatch.
Returns the value of the histogram identified by spec
. If there is no histogram for
given labels combination, returns :undefined
.
Raises Prometheus.UnknownMetricError
exception if a histogram for spec
can’t be found.
Raises Prometheus.InvalidMetricArityError
exception if labels count mismatch.