No OneTemporary
Actions

Size

34 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/lib/prometheus/erlang.ex b/lib/prometheus/erlang.ex
	index 2c2aa49..285e41b 100644
	--- a/lib/prometheus/erlang.ex
	+++ b/lib/prometheus/erlang.ex
	@@ -1,157 +1,50 @@
	defmodule Prometheus.Erlang do
	@moduledoc false

	require Prometheus.Metric
	alias Prometheus.Metric

	defmacro __using__(erlang_module) do
	quote do
	@erlang_module unquote(erlang_module)
	- alias Prometheus.Erlang

	require Prometheus.Error

	- import unquote(__MODULE__), only: [delegate: 1, delegate: 2]
	+ import unquote(__MODULE__)
	end
	end

	defmacro delegate(fun, opts \\ []) do
	fun = Macro.escape(fun, unquote: true)

	quote bind_quoted: [fun: fun, opts: opts] do
	target = Keyword.get(opts, :to, @erlang_module)

	- %{file: file, line: line} = __ENV__
	-
	{name, args, as, as_args} = Kernel.Utils.defdelegate(fun, opts)

	def unquote(name)(unquote_splicing(args)) do
	Prometheus.Error.with_prometheus_error(
	unquote(target).unquote(as)(unquote_splicing(as_args))
	)
	end
	end
	end

	- defmacro metric_call(mf_or_spec, spec \\ false, arguments \\ []) do
	- {mf, spec, arguments} = parse_metric_call_args(mf_or_spec, spec, arguments)
	-
	- {module, function, arguments} = parse_mfa(__CALLER__, mf, arguments)
	-
	- quote do
	- Prometheus.Erlang.metric_call_body(
	- unquote(module),
	- unquote(function),
	- unquote(spec),
	- unquote(arguments)
	- )
	- end
	- end
	-
	- def metric_call_body(module, function, spec, arguments) do
	- case spec do
	- _ when Metric.ct_parsable_spec?(spec) ->
	- {registry, name, labels} = Prometheus.Metric.parse_spec(spec)
	-
	- quote do
	- require Prometheus.Error
	-
	- Prometheus.Error.with_prometheus_error(
	- unquote(module).unquote(function)(
	- unquote(registry),
	- unquote(name),
	- unquote(labels),
	- unquote_splicing(arguments)
	- )
	- )
	- end
	-
	- _ ->
	- quote do
	- require Prometheus.Error
	-
	- {registry, name, labels} = Metric.parse_spec(unquote(spec))
	-
	- Prometheus.Error.with_prometheus_error(
	- unquote(module).unquote(function)(
	- registry,
	- name,
	- labels,
	- unquote_splicing(arguments)
	- )
	- )
	- end
	- end
	- end
	-
	- defp parse_metric_call_args(mf_or_spec, spec, arguments) do
	- case mf_or_spec do
	- ## Erlang.metric_call({:prometheus_counter, :dinc}, spec, [value])
	- {_, _} ->
	- {mf_or_spec, spec, arguments}
	-
	- ## Erlang.metric_call(:inc, spec, [value])
	- _ when is_atom(mf_or_spec) ->
	- {mf_or_spec, spec, arguments}
	-
	- _ ->
	- ## args are 'shifted' to left
	- [] = arguments
	-
	- if spec == false do
	- ## only spec is needed, e.g. Erlang.metric_call(spec)
	- {false, mf_or_spec, []}
	- else
	- ## Erlang.metric_call(spec, [value])
	- {false, mf_or_spec, spec}
	- end
	- end
	- end
	-
	- defp parse_mfa(caller, mf, arguments) do
	- arguments =
	- case mf do
	- _ when is_list(mf) ->
	- [] = arguments
	- mf
	-
	- _ ->
	- arguments
	- end
	+ defmacro delegate_metric(fun, opts \\ []) do
	+ fun = Macro.escape(fun, unquote: true)

	- {module, function} =
	- case mf do
	- false ->
	- {f, _arity} = caller.function
	- {Module.get_attribute(caller.module, :erlang_module), f}
	+ quote bind_quoted: [fun: fun, opts: opts] do
	+ target = Keyword.get(opts, :to, @erlang_module)

	- _ when is_list(mf) ->
	- {f, _arity} = caller.function
	- {Module.get_attribute(caller.module, :erlang_module), f}
	+ {name, args, as, [spec \| as_args]} = Kernel.Utils.defdelegate(fun, opts)

	- {_, _} ->
	- mf
	+ def unquote(name)(unquote_splicing(args)) do
	+ {registry, name, labels} = Metric.parse_spec(unquote(spec))

	- _ when is_atom(mf) ->
	- {Module.get_attribute(caller.module, :erlang_module), mf}
	+ Prometheus.Error.with_prometheus_error(
	+ unquote(target).unquote(as)(registry, name, labels, unquote_splicing(as_args))
	+ )
	end
	-
	- {module, function, arguments}
	- end
	-
	- def ensure_fn(var) do
	- case var do
	- [do: block] ->
	- quote do
	- fn ->
	- unquote(block)
	- end
	- end
	-
	- fun ->
	- quote do
	- unquote(fun)
	- end
	end
	end
	end
	diff --git a/lib/prometheus/metric/boolean.ex b/lib/prometheus/metric/boolean.ex
	index f75bf2e..66a3719 100644
	--- a/lib/prometheus/metric/boolean.ex
	+++ b/lib/prometheus/metric/boolean.ex
	@@ -1,126 +1,116 @@
	defmodule Prometheus.Metric.Boolean do
	@moduledoc """
	Boolean metric, to report booleans and flags.

	Boolean is a non-standard metric that uses untyped metric underneath.

	A Boolean is typically used as a flag i.e. enabled/disabled, online/offline.

	Example:
	```
	-module(my_fuse_instrumenter).

	-export([setup/0,
	fuse_event/2]).

	setup() ->
	prometheus_boolean:declare([{name, app_fuse_state},
	{labels, [name]}, %% fuse name
	{help, "State of various app fuses."}]),

	fuse_event(Fuse, Event) ->
	case Event of
	ok -> prometheus_boolean:set(app_fuse_state, [Fuse], true);
	blown -> prometheus_boolean:set(app_fuse_state, [Fuse], false);
	_ -> ok
	end.
	```
	"""

	use Prometheus.Erlang, :prometheus_boolean

	@doc """
	Creates a boolean using `spec`.

	Raises `Prometheus.MissingMetricSpecKeyError` if required `spec` key is missing.<br>
	Raises `Prometheus.InvalidMetricNameError` if metric name is invalid.<br>
	Raises `Prometheus.InvalidMetricHelpError` if help is invalid.<br>
	Raises `Prometheus.InvalidMetricLabelsError` if labels isn't a list.<br>
	Raises `Prometheus.InvalidLabelNameError` if label name is invalid.<br>
	Raises `Prometheus.MFAlreadyExistsError` if a boolean with
	the same `spec` already exists.
	"""
	delegate new(spec)

	@doc """
	Creates a boolean using `spec`.
	If a boolean with the same `spec` exists returns `false`.

	Raises `Prometheus.MissingMetricSpecKeyError` if required `spec` key is missing.<br>
	Raises `Prometheus.InvalidMetricNameError` if metric name is invalid.<br>
	Raises `Prometheus.InvalidMetricHelpError` if help is invalid.<br>
	Raises `Prometheus.InvalidMetricLabelsError` if labels isn't a list.<br>
	Raises `Prometheus.InvalidLabelNameError` if label name is invalid.
	"""
	delegate declare(spec)

	@doc """
	Sets the boolean identified by `spec` to `value`.

	Valid "truthy" values:
	- `true`;
	- `false`;
	- `0` -> false;
	- `number > 0` -> true;
	- `[]` -> false
	- `non-empty list` -> true;
	- `:undefined` -> undefined

	Other values will generate `Prometheus.InvalidValueError` error.

	Raises `Prometheus.InvalidValueError` exception if `value` isn't
	a boolean or `:undefined`.<br>
	Raises `Prometheus.UnknownMetricError` exception if a boolean for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro set(spec, value) do
	- Erlang.metric_call(spec, [value])
	- end
	+ delegate_metric set(spec, value)

	@doc """
	Toggles the boolean identified by `spec` to `value`.

	Raises `Prometheus.InvalidValueError` exception if boolean is `:undefined`.<br>
	Raises `Prometheus.UnknownMetricError` exception if a boolean for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro toggle(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric toggle(spec)

	@doc """
	Removes boolean series identified by spec.

	Raises `Prometheus.UnknownMetricError` exception if a boolean
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro remove(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric remove(spec)

	@doc """
	Resets the value of the boolean identified by `spec`.

	Raises `Prometheus.UnknownMetricError` exception if a boolean
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro reset(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric reset(spec)

	@doc """
	Returns the value of the boolean identified by `spec`. If there is no boolean for
	given labels combination, returns `:undefined`.

	Raises `Prometheus.UnknownMetricError` exception if a boolean
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro value(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric value(spec)
	end
	diff --git a/lib/prometheus/metric/counter.ex b/lib/prometheus/metric/counter.ex
	index e79c97f..4c7eeac 100644
	--- a/lib/prometheus/metric/counter.ex
	+++ b/lib/prometheus/metric/counter.ex
	@@ -1,227 +1,219 @@
	defmodule Prometheus.Metric.Counter do
	@moduledoc """
	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`.

	A Counter is typically used to count requests served, tasks completed, errors
	occurred, etc.

	Example use cases for Counters:
	- Number of requests processed;
	- Number of items that were inserted into a queue;
	- Total amount of data that a system has processed.

	Use the [`rate()`](https://prometheus.io/docs/querying/functions/#rate())/
	[`irate()`](https://prometheus.io/docs/querying/functions/#irate())
	functions in Prometheus to calculate the rate of increase of a Counter.
	By convention, the names of Counters are suffixed by `_total`.

	To create a counter use either `new/1` or `declare/1`, the difference is that
	`new/` will raise `Prometheus.MFAlreadyExistsError` exception if counter with
	the same `registry`, `name` and `labels` combination already exists.
	Both accept `spec` `Keyword` with the same set of keys:

	- `:registry` - optional, default is `:default`;
	- `:name` - required, can be an atom or a string;
	- `:help` - required, must be a string;
	- `:labels` - optional, default is `[]`.

	Example:

	```
	defmodule MyServiceInstrumenter do

	use Prometheus.Metric

	## to be called at app/supervisor startup.
	## to tolerate restarts use declare.
	def setup() do
	Counter.declare([name: :my_service_requests_total,
	help: "Requests count.",
	labels: [:caller]])
	end

	def inc(caller) do
	Counter.inc([name: :my_service_requests_total,
	labels: [caller]])
	end

	end

	```

	"""

	use Prometheus.Erlang, :prometheus_counter

	@doc """
	Creates a counter using `spec`.

	Raises `Prometheus.MissingMetricSpecKeyError` if required `spec` key is missing.<br>
	Raises `Prometheus.InvalidMetricNameError` if metric name is invalid.<br>
	Raises `Prometheus.InvalidMetricHelpError` if help is invalid.<br>
	Raises `Prometheus.InvalidMetricLabelsError` if labels isn't a list.<br>
	Raises `Prometheus.InvalidLabelNameError` if label name is invalid.<br>
	Raises `Prometheus.MFAlreadyExistsError` if a counter with
	the same `spec` already exists.
	"""
	delegate new(spec)

	@doc """
	Creates a counter using `spec`.
	If a counter with the same `spec` exists returns `false`.

	Raises `Prometheus.MissingMetricSpecKeyError` if required `spec` key is missing.<br>
	Raises `Prometheus.InvalidMetricNameError` if metric name is invalid.<br>
	Raises `Prometheus.InvalidMetricHelpError` if help is invalid.<br>
	Raises `Prometheus.InvalidMetricLabelsError` if labels isn't a list.<br>
	Raises `Prometheus.InvalidLabelNameError` if label name is invalid.
	"""
	delegate declare(spec)

	@doc """
	Increments the counter identified by `spec` by `value`.

	Raises `Prometheus.InvalidValueError` exception if `value` isn't a positive number.<br>
	Raises `Prometheus.UnknownMetricError` exception if a counter
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro inc(spec, value \\ 1) do
	- Erlang.metric_call(:inc, spec, [value])
	- end
	+ delegate_metric inc(spec, value \\ 1)

	@doc """
	Increments the counter identified by `spec` by 1 when `body` executed.

	Read more about bodies: `Prometheus.Injector`.

	Raises `Prometheus.UnknownMetricError` exception if a counter
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	defmacro count(spec, body) do
	env = __CALLER__

	Prometheus.Injector.inject(
	fn block ->
	quote do
	Prometheus.Metric.Counter.inc(unquote(spec), 1)
	unquote(block)
	end
	end,
	env,
	body
	)
	end

	@doc """
	Increments the counter identified by `spec` by 1 when `body` raises `exception`.

	Read more about bodies: `Prometheus.Injector`.

	Raises `Prometheus.UnknownMetricError` exception if a counter
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	defmacro count_exceptions(spec, exception \\ :_, body) do
	env = __CALLER__

	Prometheus.Injector.inject(
	fn block ->
	quote do
	require Prometheus.Error

	Prometheus.Error.with_prometheus_error(
	try do
	unquote(block)
	rescue
	e in unquote(exception) ->
	stacktrace =
	unquote(
	if macro_exported?(Kernel.SpecialForms, :__STACKTRACE__, 0) do
	quote(do: __STACKTRACE__)
	else
	quote(do: System.stacktrace())
	end
	)

	{registry, name, labels} = Prometheus.Metric.parse_spec(unquote(spec))
	:prometheus_counter.inc(registry, name, labels, 1)
	reraise(e, stacktrace)
	end
	)
	end
	end,
	env,
	body
	)
	end

	@doc """
	Increments the counter identified by `spec` by 1 when `body` raises no exceptions.

	Read more about bodies: `Prometheus.Injector`.

	Raises `Prometheus.UnknownMetricError` exception if a counter
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	defmacro count_no_exceptions(spec, body) do
	env = __CALLER__

	Prometheus.Injector.inject(
	fn block ->
	quote do
	require Prometheus.Error

	try do
	unquote(block)
	else
	value ->
	Prometheus.Metric.Counter.inc(unquote(spec), 1)
	value
	end
	end
	end,
	env,
	body
	)
	end

	@doc """
	Removes counter series identified by spec.

	Raises `Prometheus.UnknownMetricError` exception if a counter
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro remove(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric remove(spec)

	@doc """
	Resets the value of the counter identified by `spec`.

	Raises `Prometheus.UnknownMetricError` exception if a counter
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro reset(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric reset(spec)

	@doc """
	Returns the value of the counter identified by `spec`. If there is no counter for
	given labels combination, returns `:undefined`.

	Raises `Prometheus.UnknownMetricError` exception if a counter
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro value(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric value(spec)
	end
	diff --git a/lib/prometheus/metric/gauge.ex b/lib/prometheus/metric/gauge.ex
	index d2d450b..2166821 100644
	--- a/lib/prometheus/metric/gauge.ex
	+++ b/lib/prometheus/metric/gauge.ex
	@@ -1,227 +1,213 @@
	defmodule Prometheus.Metric.Gauge do
	@moduledoc """
	Gauge metric, to report instantaneous values.

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

	A Gauge is typically used for measured values like temperatures or current
	memory usage, but also "counts" that can go up and down, like the number of
	running processes.

	Example use cases for Gauges:
	- Inprogress requests;
	- Number of items in a queue;
	- Free memory;
	- Total memory;
	- Temperature.

	Example:

	```
	defmodule MyPoolInstrumenter do

	use Prometheus.Metric

	## to be called at app/supervisor startup.
	## to tolerate restarts use declare.
	def setup() do
	Gauge.declare([name: :my_pool_size,
	help: "Pool size."])

	Gauge.declare([name: :my_pool_checked_out,
	help: "Number of sockets checked out from the pool"])
	end

	def set_size(size) do
	Gauge.set([name: :my_pool_size], size)
	end

	def track_checked_out_sockets(checkout_fun) do
	Gauge.track_inprogress([name: :my_pool_checked_out], checkout_fun.())
	end

	def track_checked_out_sockets_block(socket) do
	Gauge.track_inprogress([name: :my_pool_checked_out]) do
	# checkout code
	socket
	end
	end

	end

	```

	"""

	use Prometheus.Erlang, :prometheus_gauge

	@doc """
	Creates a gauge using `spec`.

	Raises `Prometheus.MissingMetricSpecKeyError` if required `spec` key is missing.<br>
	Raises `Prometheus.InvalidMetricNameError` if metric name is invalid.<br>
	Raises `Prometheus.InvalidMetricHelpError` if help is invalid.<br>
	Raises `Prometheus.InvalidMetricLabelsError` if labels isn't a list.<br>
	Raises `Prometheus.InvalidMetricNameError` if label name is invalid.<br>
	Raises `Prometheus.InvalidValueError` exception if duration_unit is unknown or
	doesn't match metric name.<br>
	Raises `Prometheus.MFAlreadyExistsError` if a gauge with the same `spec` exists.
	"""
	delegate new(spec)

	@doc """
	Creates a gauge using `spec`.
	If a gauge with the same `spec` exists returns `false`.

	Raises `Prometheus.MissingMetricSpecKeyError` if required `spec` key is missing.<br>
	Raises `Prometheus.InvalidMetricNameError` if metric name is invalid.<br>
	Raises `Prometheus.InvalidMetricHelpError` if help is invalid.<br>
	Raises `Prometheus.InvalidMetricLabelsError` if labels isn't a list.<br>
	Raises `Prometheus.InvalidMetricNameError` if label name is invalid.<br>
	Raises `Prometheus.InvalidValueError` exception if duration_unit is unknown or
	doesn't match metric name.
	"""
	delegate declare(spec)

	@doc """
	Sets the gauge identified by `spec` to `value`.

	Raises `Prometheus.InvalidValueError` exception if `value` isn't
	a number or `:undefined`.<br>
	Raises `Prometheus.UnknownMetricError` exception if a gauge for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro set(spec, value) do
	- Erlang.metric_call(spec, [value])
	- end
	+ delegate_metric set(spec, value)

	@doc """
	Increments the gauge identified by `spec` by `value`.

	Raises `Prometheus.InvalidValueError` exception if `value` isn't a number.<br>
	Raises `Prometheus.UnknownMetricError` exception if a gauge for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro inc(spec, value \\ 1) do
	- Erlang.metric_call(spec, [value])
	- end
	+ delegate_metric inc(spec, value \\ 1)

	@doc """
	Decrements the gauge identified by `spec` by `value`.

	Raises `Prometheus.InvalidValueError` exception if `value` isn't a number.<br>
	Raises `Prometheus.UnknownMetricError` exception if a gauge for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro dec(spec, value \\ 1) do
	- Erlang.metric_call(spec, [value])
	- end
	+ delegate_metric dec(spec, value \\ 1)

	@doc """
	Sets the gauge identified by `spec` to the current unixtime.

	Raises `Prometheus.UnknownMetricError` exception if a gauge
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro set_to_current_time(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric set_to_current_time(spec)

	@doc """
	Sets the gauge identified by `spec` to the number of currently executing `body`s.

	Raises `Prometheus.UnknownMetricError` exception if a gauge
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	Raises `Prometheus.InvalidValueError` exception if fun isn't a function or block.
	"""
	defmacro track_inprogress(spec, body) do
	env = __CALLER__

	Prometheus.Injector.inject(
	fn block ->
	quote do
	Prometheus.Metric.Gauge.inc(unquote(spec))

	try do
	unquote(block)
	after
	Prometheus.Metric.Gauge.dec(unquote(spec))
	end
	end
	end,
	env,
	body
	)
	end

	@doc """
	Tracks the amount of time spent executing `body`.

	Raises `Prometheus.UnknownMetricError` exception if a gauge
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	Raises `Prometheus.InvalidValueError` exception if `fun` isn't a function or block.
	"""
	defmacro set_duration(spec, body) do
	env = __CALLER__

	Prometheus.Injector.inject(
	fn block ->
	quote do
	start_time = :erlang.monotonic_time()

	try do
	unquote(block)
	after
	end_time = :erlang.monotonic_time()
	Prometheus.Metric.Gauge.set(unquote(spec), end_time - start_time)
	end
	end
	end,
	env,
	body
	)
	end

	@doc """
	Removes gauge series identified by spec.

	Raises `Prometheus.UnknownMetricError` exception if a gauge
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro remove(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric remove(spec)

	@doc """
	Resets the value of the gauge identified by `spec`.

	Raises `Prometheus.UnknownMetricError` exception if a gauge
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro reset(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric reset(spec)

	@doc """
	Returns the value of the gauge identified by `spec`.

	If duration unit set, value will be converted to the duration unit.
	[Read more here.](time.html)

	Raises `Prometheus.UnknownMetricError` exception if a gauge
	for `spec` can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro value(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric value(spec)
	end
	diff --git a/lib/prometheus/metric/histogram.ex b/lib/prometheus/metric/histogram.ex
	index b5e9f6b..66e03aa 100644
	--- a/lib/prometheus/metric/histogram.ex
	+++ b/lib/prometheus/metric/histogram.ex
	@@ -1,167 +1,159 @@
	defmodule Prometheus.Metric.Histogram do
	@moduledoc """
	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

	```

	"""

	use Prometheus.Erlang, :prometheus_histogram

	@doc """
	Creates a histogram using `spec`.
	Histogram cannot have a label named "le".

	Raises `Prometheus.MissingMetricSpecKeyError` if required `spec` key is missing.<br>
	Raises `Prometheus.InvalidMetricNameError` if metric name is invalid.<br>
	Raises `Prometheus.InvalidMetricHelpError` if help is invalid.<br>
	Raises `Prometheus.InvalidMetricLabelsError` if labels isn't a list.<br>
	Raises `Prometheus.InvalidMetricNameError` if label name is invalid.<br>
	Raises `Prometheus.InvalidValueError` exception if duration_unit is unknown or
	doesn't match metric name.<br>
	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.<br>
	Raises `Prometheus.HistogramInvalidBucketsError` if buckets aren't
	in increasing order.<br>
	Raises `Prometheus.HistogramInvalidBoundError` if bucket bound isn't a number.
	"""
	delegate new(spec)

	@doc """
	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.<br>
	Raises `Prometheus.InvalidMetricNameError` if metric name is invalid.<br>
	Raises `Prometheus.InvalidMetricHelpError` if help is invalid.<br>
	Raises `Prometheus.InvalidMetricLabelsError` if labels isn't a list.<br>
	Raises `Prometheus.InvalidMetricNameError` if label name is invalid.<br>
	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.<br>
	Raises `Prometheus.HistogramInvalidBucketsError` if buckets aren't
	in increasing order.<br>
	Raises `Prometheus.HistogramInvalidBoundError` if bucket bound isn't a number.
	"""
	delegate declare(spec)

	@doc """
	Observes the given amount.

	Raises `Prometheus.InvalidValueError` exception if `amount` isn't
	a number.<br>
	Raises `Prometheus.UnknownMetricError` exception if a histogram for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro observe(spec, amount \\ 1) do
	- Erlang.metric_call(spec, [amount])
	- end
	+ delegate_metric observe(spec, amount \\ 1)

	@doc """
	Observes the amount of time spent executing `body`.

	Raises `Prometheus.UnknownMetricError` exception if a histogram for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	Raises `Prometheus.InvalidValueError` exception if fun isn't a function or block.
	"""
	defmacro observe_duration(spec, body) do
	env = __CALLER__

	Prometheus.Injector.inject(
	fn block ->
	quote do
	start_time = :erlang.monotonic_time()

	try do
	unquote(block)
	after
	end_time = :erlang.monotonic_time()
	Prometheus.Metric.Histogram.observe(unquote(spec), end_time - start_time)
	end
	end
	end,
	env,
	body
	)
	end

	@doc """
	Removes histogram series identified by spec.

	Raises `Prometheus.UnknownMetricError` exception if a histogram for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro remove(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric remove(spec)

	@doc """
	Resets the value of the histogram identified by `spec`.

	Raises `Prometheus.UnknownMetricError` exception if a histogram for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro reset(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric reset(spec)

	@doc """
	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.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro value(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric value(spec)
	end
	diff --git a/lib/prometheus/metric/summary.ex b/lib/prometheus/metric/summary.ex
	index 1baa019..c2922a0 100644
	--- a/lib/prometheus/metric/summary.ex
	+++ b/lib/prometheus/metric/summary.ex
	@@ -1,150 +1,142 @@
	defmodule Prometheus.Metric.Summary do
	@moduledoc """
	Summary metric, to track the size of events.

	Example use cases for Summaries:
	- Response latency;
	- Request size;
	- Response size.

	Example:

	```
	defmodule MyProxyInstrumenter do

	use Prometheus.Metric

	## to be called at app/supervisor startup.
	## to tolerate restarts use declare.
	def setup() do
	Summary.declare([name: :request_size_bytes,
	help: "Request size in bytes."])

	Summary.declare([name: :response_size_bytes,
	help: "Response size in bytes."])
	end

	def observe_request(size) do
	Summary.observe([name: :request_size_bytes], size)
	end

	def observe_response(size) do
	Summary.observe([name: :response_size_bytes], size)
	end
	end
	```

	"""

	use Prometheus.Erlang, :prometheus_summary

	@doc """
	Creates a summary using `spec`.
	Summary cannot have a label named "quantile".

	Raises `Prometheus.MissingMetricSpecKeyError` if required `spec` key is missing.<br>
	Raises `Prometheus.InvalidMetricNameError` if metric name is invalid.<br>
	Raises `Prometheus.InvalidMetricHelpError` if help is invalid.<br>
	Raises `Prometheus.InvalidMetricLabelsError` if labels isn't a list.<br>
	Raises `Prometheus.InvalidMetricNameError` if label name is invalid.<br>
	Raises `Prometheus.InvalidValueError` exception if duration_unit is unknown or
	doesn't match metric name.<br>
	Raises `Prometheus.MFAlreadyExistsError` if a summary with the same `spec`
	already exists.
	"""
	delegate new(spec)

	@doc """
	Creates a summary using `spec`.
	Summary cannot have a label named "quantile".

	If a summary with the same `spec` exists returns `false`.

	Raises `Prometheus.MissingMetricSpecKeyError` if required `spec` key is missing.<br>
	Raises `Prometheus.InvalidMetricNameError` if metric name is invalid.<br>
	Raises `Prometheus.InvalidMetricHelpError` if help is invalid.<br>
	Raises `Prometheus.InvalidMetricLabelsError` if labels isn't a list.<br>
	Raises `Prometheus.InvalidMetricNameError` if label name is invalid;<br>
	Raises `Prometheus.InvalidValueError` exception if duration_unit is unknown or
	doesn't match metric name.
	"""
	delegate declare(spec)

	@doc """
	Observes the given amount.

	Raises `Prometheus.InvalidValueError` exception if `amount` isn't a number.<br>
	Raises `Prometheus.UnknownMetricError` exception if a summary for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro observe(spec, amount \\ 1) do
	- Erlang.metric_call(spec, [amount])
	- end
	+ delegate_metric observe(spec, amount \\ 1)

	@doc """
	Observes the amount of time spent executing `body`.

	Raises `Prometheus.UnknownMetricError` exception if a summary for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	Raises `Prometheus.InvalidValueError` exception if `fun` isn't a function or block.
	"""
	defmacro observe_duration(spec, body) do
	env = __CALLER__

	Prometheus.Injector.inject(
	fn block ->
	quote do
	start_time = :erlang.monotonic_time()

	try do
	unquote(block)
	after
	end_time = :erlang.monotonic_time()
	Prometheus.Metric.Summary.observe(unquote(spec), end_time - start_time)
	end
	end
	end,
	env,
	body
	)
	end

	@doc """
	Removes summary series identified by spec.

	Raises `Prometheus.UnknownMetricError` exception if a summary for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro remove(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric remove(spec)

	@doc """
	Resets the value of the summary identified by `spec`.

	Raises `Prometheus.UnknownMetricError` exception if a summary for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro reset(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric reset(spec)

	@doc """
	Returns the value of the summary identified by `spec`. If there is no summary for
	given labels combination, returns `:undefined`.

	If duration unit set, sum will be converted to the duration unit.
	[Read more here.](time.html)

	Raises `Prometheus.UnknownMetricError` exception if a summary for `spec`
	can't be found.<br>
	Raises `Prometheus.InvalidMetricArityError` exception if labels count mismatch.
	"""
	- defmacro value(spec) do
	- Erlang.metric_call(spec)
	- end
	+ delegate_metric value(spec)
	end

File Metadata

Mime Type: text/x-diff
Expires: Tue, Nov 26, 7:52 AM (1 d, 13 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 40245
Default Alt Text: (34 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions