exmetrics v1.1.0 Exmetrics.Counter

Counters represent integer values that increase monotonically.

Summary

Functions

Increments the counter 'name' by n

Gets the value of a counter

Increments the counter 'name' by 1

Reset counter 'name' to 0

Reset counter 'name' to n

Functions

add(name, n)

Specs

add(String.t, integer) :: atom

Increments the counter 'name' by n.

iex> Exmetrics.Counter.add "bar", 5
:ok
iex> Exmetrics.Counter.get "bar"
5
get(name)

Specs

get(String.t) :: integer | nil

Gets the value of a counter.

iex> Exmetrics.Counter.add "baz", 42
:ok
iex> Exmetrics.Counter.get "baz"
42

iex> Exmetrics.Counter.get "doesnt_exist"
nil
incr(name)

Specs

incr(String.t) :: atom

Increments the counter 'name' by 1.

iex> Exmetrics.Counter.incr "foo"
:ok
iex> Exmetrics.Counter.get "foo"
1
reset(name)

Specs

reset(String.t) :: atom

Reset counter 'name' to 0.

iex> Exmetrics.Counter.reset "reset_to_zero"
:ok
iex> Exmetrics.Counter.get "reset_to_zero"
0
reset(name, n)

Specs

reset(String.t, integer) :: atom

Reset counter 'name' to n.

iex> Exmetrics.Counter.reset "reset_to_fourty_two", 42
:ok
iex> Exmetrics.Counter.get "reset_to_fourty_two"
42