Module katja_vmstats_collector

The katja_vmstats_collector module is responsible for collecting metrics and sending them to Riemann.

Version: 0.8.2

Behaviours: gen_server.

Authors: Daniel Kempkens (daniel@kempkens.io).

Description

The katja_vmstats_collector module is responsible for collecting metrics and sending them to Riemann.

collect/1	Collects the specified metrics and sends them to Riemann.
get_collection/1	Returns a list of all collections registered under the given `Name`.
start_collection/2	Registers a new collection under the given `Name`.
start_link/0	Starts a collector server process and registers it as `katja_vmstats_collector`.
stop/0	Stops a collector server process.
stop_collection/1	Stops all collections registered under the given `Name`.

collect(Metrics::[katja_vmstats:metric()]) -> ok

Collects the specified metrics and sends them to Riemann.

atom(): A function defined and exported in the katja_vmstats_metrics module.
{iolist(), atom(), [any()]}: A function defined and exported in the katja_vmstats_metrics module. The first tuple field is the name of the metric, the second and the third field are the FA part of MFA.
{iolist(), module(), atom(), [any()]}: Any function in any module that returns a number(). The first tuple field is the name of the metric, the following fields are MFA.

get_collection(Name::atom()) -> [katja_vmstats:collection()]

Returns a list of all collections registered under the given Name. Setting Name to all will return all registered collections.

start_collection(Name::atom(), MetricsIntervals::[katja_vmstats:collection()]) -> ok

Registers a new collection under the given Name.
MetricsIntervals has to be a list like the collector configuration option.

start_link() -> {ok, pid()} | ignore | {error, term()}

Starts a collector server process and registers it as katja_vmstats_collector.

stop() -> ok

Stops a collector server process.

stop_collection(Name::atom()) -> ok

Stops all collections registered under the given Name. Setting Name to all will stop all registered collections.

Generated by EDoc