batch_elixir v0.2.2 BatchElixir.Stats.Statix View Source
Link to this section Summary
Functions
Returns a specification to start this module under a supervisor
Opens the connection to the StatsD-compatible server
Decrements the StatsD counter identified by key
by the given value
Writes to the StatsD gauge identified by key
Writes value
to the histogram identified by key
Increments the StatsD counter identified by key
by the given value
Invoked when the server is started. start_link/3
or start/3
will
block until it returns
Measures the execution time of the given function
and writes that to the
StatsD timing identified by key
Writes the given value
to the StatsD set identified by key
Writes the given value
to the StatsD timing identified by key
Link to this section Functions
child_spec(init_arg) View Source
Returns a specification to start this module under a supervisor.
See Supervisor
.
connect() View Source
Opens the connection to the StatsD-compatible server.
The configuration is read from the configuration for the :statix
application
(both globally and per connection).
Callback implementation for Statix.connect/0
.
decrement(key, val \\ 1, options \\ []) View Source
Decrements the StatsD counter identified by key
by the given value
.
Works same as c:increment/3
but subtracts value
instead of adding it. For
this reason value
should be zero or negative.
Examples
iex> MyApp.Statix.decrement("open_connections", 1, [])
:ok
Callback implementation for Statix.decrement/3
.
gauge(key, val, options \\ []) View Source
Writes to the StatsD gauge identified by key
.
Examples
iex> MyApp.Statix.gauge("cpu_usage", 0.83, [])
:ok
Callback implementation for Statix.gauge/3
.
histogram(key, val, options \\ []) View Source
Writes value
to the histogram identified by key
.
Not all StatsD-compatible servers support histograms. An example of a such server statsite.
Examples
iex> MyApp.Statix.histogram("online_users", 123, [])
:ok
Callback implementation for Statix.histogram/3
.
increment(key, val \\ 1, options \\ []) View Source
Increments the StatsD counter identified by key
by the given value
.
value
is supposed to be zero or positive and c:decrement/3
should be
used for negative values.
Examples
iex> MyApp.Statix.increment("hits", 1, [])
:ok
Callback implementation for Statix.increment/3
.
init(atom) View Source
Invoked when the server is started. start_link/3
or start/3
will
block until it returns.
init_arg
is the argument term (second argument) passed to start_link/3
.
Returning {:ok, state}
will cause start_link/3
to return
{:ok, pid}
and the process to enter its loop.
Returning {:ok, state, timeout}
is similar to {:ok, state}
except handle_info(:timeout, state)
will be called after timeout
milliseconds if no messages are received within the timeout.
Returning {:ok, state, :hibernate}
is similar to {:ok, state}
except the process is hibernated before entering the loop. See
c:handle_call/3
for more information on hibernation.
Returning {:ok, state, {:continue, continue}}
is similar to
{:ok, state}
except that immediately after entering the loop
the c:handle_continue/2
callback will be invoked with the value
continue
as first argument.
Returning :ignore
will cause start_link/3
to return :ignore
and
the process will exit normally without entering the loop or calling
c:terminate/2
. If used when part of a supervision tree the parent
supervisor will not fail to start nor immediately try to restart the
GenServer
. The remainder of the supervision tree will be started
and so the GenServer
should not be required by other processes.
It can be started later with Supervisor.restart_child/2
as the child
specification is saved in the parent supervisor. The main use cases for
this are:
- The
GenServer
is disabled by configuration but might be enabled later. - An error occurred and it will be handled by a different mechanism than the
Supervisor
. Likely this approach involves callingSupervisor.restart_child/2
after a delay to attempt a restart.
Returning {:stop, reason}
will cause start_link/3
to return
{:error, reason}
and the process to exit with reason reason
without
entering the loop or calling c:terminate/2
.
Callback implementation for GenServer.init/1
.
measure(key, options \\ [], fun) View Source
Measures the execution time of the given function
and writes that to the
StatsD timing identified by key
.
This function returns the value returned by function
, making it suitable for
easily wrapping existing code.
Examples
iex> MyApp.Statix.measure("integer_to_string", [], fn -> Integer.to_string(123) end)
"123"
Callback implementation for Statix.measure/3
.
set(key, val, options \\ []) View Source
Writes the given value
to the StatsD set identified by key
.
Examples
iex> MyApp.Statix.set("unique_visitors", "user1", [])
:ok
Callback implementation for Statix.set/3
.
start_link() View Source
timing(key, val, options \\ []) View Source
Writes the given value
to the StatsD timing identified by key
.
value
is expected in milliseconds.
Examples
iex> MyApp.Statix.timing("rendering", 12, [])
:ok
Callback implementation for Statix.timing/3
.