Rheostat.Adapter behaviour (Rheostat v0.2.1) View Source

Link to this section Summary

Types

key()

Callbacks

Opens the connection to the StatsD-compatible server. The configuration is read from the configuration for the :statix application (both globally and per connection).

count(map, arg2, number)

decrement(key)

Same as decrement(key, 1, []).

decrement(key, value)

Same as decrement(key, value, []).

decrement(key, value, options)

Decrements the StatsD counter identified by key by the given value. Works same as increment/3 but subtracts value instead of adding it. For this reason value should be zero or negative.

gauge(key, value)

Same as gauge(key, value, []).

gauge(key, value, options)

Writes to the StatsD gauge identified by key.

histogram(key, value)

Same as histogram(key, value, []).

histogram(key, value, options)

Writes value to the histogram identified by key. Not all StatsD-compatible servers support histograms. An example of a such server statsite.

increment(key)

Same as increment(key, 1, []).

increment(key, value)

Same as increment(key, value, []).

increment(key, value, options)

Increments the StatsD counter identified by key by the given value. value is supposed to be zero or positive and decrement/3 should be used for negative values.

measure(map, arg2, any)

sample(map, arg2, any)

set(key, value)

Same as set(key, value, []).

set(key, value, options)

Writes the given value to the StatsD set identified by key.

timing(key, value)

Same as timing(key, value, []).

timing(key, value, options)

Writes the given value to the StatsD timing identified by key. value is expected in milliseconds.

Link to this section Types

key()

Specs

key() :: iodata()

on_send()

Specs

on_send() :: :ok | {:error, term()}

options()

Specs

options() :: [sample_rate: float(), tags: [String.t()]]

Link to this section Callbacks

connect(list)

Specs

connect(list()) :: :ok

Opens the connection to the StatsD-compatible server. The configuration is read from the configuration for the :statix application (both globally and per connection).

count(map, arg2, number)

Specs

count(map(), String.t(), number()) :: any()

decrement(key)

Specs

decrement(key()) :: on_send()

Same as decrement(key, 1, []).

decrement(key, value)

Specs

decrement(key(), value :: number()) :: on_send()

Same as decrement(key, value, []).

decrement(key, value, options)

Specs

decrement(key(), value :: number(), options()) :: on_send()

Decrements the StatsD counter identified by key by the given value. Works same as 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

gauge(key, value)

Specs

gauge(key(), value :: String.Chars.t()) :: on_send()

Same as gauge(key, value, []).

gauge(key, value, options)

Specs

gauge(key(), value :: String.Chars.t(), options()) :: on_send()

Writes to the StatsD gauge identified by key.

Examples

iex> MyApp.Statix.gauge("cpu_usage", 0.83, [])
:ok

histogram(key, value)

Specs

histogram(key(), value :: String.Chars.t()) :: on_send()

Same as histogram(key, value, []).

histogram(key, value, options)

Specs

histogram(key(), value :: String.Chars.t(), options()) :: on_send()

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

increment(key)

Specs

increment(key()) :: on_send()

Same as increment(key, 1, []).

increment(key, value)

Specs

increment(key(), value :: number()) :: on_send()

Same as increment(key, value, []).

increment(key, value, options)

Specs

increment(key(), value :: number(), options()) :: on_send()

Increments the StatsD counter identified by key by the given value. value is supposed to be zero or positive and decrement/3 should be used for negative values.

Examples

iex> MyApp.Statix.increment("hits", 1, [])
:ok

measure(map, arg2, any)

Specs

measure(map(), String.t(), any()) :: any()

measure(String.t(), list(), any()) :: any()

sample(map, arg2, any)

Specs

sample(map(), String.t(), any()) :: any()

set(key, value)

Specs

set(key(), value :: String.Chars.t()) :: on_send()

Same as set(key, value, []).

set(key, value, options)

Specs

set(key(), value :: String.Chars.t(), options()) :: on_send()

Writes the given value to the StatsD set identified by key.

Examples

iex> MyApp.Statix.set("unique_visitors", "user1", [])
:ok

timing(key, value)

Specs

timing(key(), value :: String.Chars.t()) :: on_send()

Same as timing(key, value, []).

timing(key, value, options)

Specs

timing(key(), value :: String.Chars.t(), options()) :: on_send()

Writes the given value to the StatsD timing identified by key. value is expected in milliseconds.

Examples

iex> MyApp.Statix.timing("rendering", 12, [])
:ok