Module katja_vmstats

This is the main module of the Katja VM Stats application: It provides the public API.

Copyright © 2014-2016 Daniel Kempkens

Version: 0.8.2

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

Description

This is the main module of the Katja VM Stats application: It provides the public API.
While it is possible to use katja_vmstats_collector directly, the recommended way is to use the functions defined in this module instead.

Data Types

collection()

collection() = [collection_attributes()]

collection_async_sample_rate()

collection_async_sample_rate() = {async_sample_rate, float()}

collection_attributes()

collection_attributes() = collection_name() | collection_metrics() | collection_interval() | collection_send_async() | collection_async_sample_rate()

collection_interval()

collection_interval() = {interval, pos_integer()}

collection_metrics()

collection_metrics() = {metrics, [metric()]}

collection_name()

collection_name() = {name, atom()}

collection_send_async()

collection_send_async() = {send_async, boolean()}

metric()

metric() = atom() | {iolist(), atom(), [any()]} | {iolist(), module(), atom(), [any()]}

Function Index

collect/1Collects the specified metrics and sends them to Riemann.
get_collection/1Returns a list of all collections registered under the given Name.
start/0Starts the Katja VM Stats application and all of its dependencies.
start_collection/2Registers a new collection under the given Name.
stop/0Stops the Katja VM Stats application and all of its dependencies.
stop_collection/1Stops all collections registered under the given Name.

Function Details

collect/1

collect(Metric::metric() | [metric()]) -> ok

Collects the specified metrics and sends them to Riemann. Delegates to katja_vmstats_collector:collect/1.

get_collection/1

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

Returns a list of all collections registered under the given Name. Delegates to katja_vmstats_collector:get_collection/1.

start/0

start() -> ok

Starts the Katja VM Stats application and all of its dependencies. This is really only meant for usage inside the console.

start_collection/2

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

Registers a new collection under the given Name. Delegates to katja_vmstats_collector:start_collection/2.

stop/0

stop() -> ok

Stops the Katja VM Stats application and all of its dependencies. This is really only meant for usage inside the console.

stop_collection/1

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

Stops all collections registered under the given Name. Delegates to katja_vmstats_collector:stop_collection/1.


Generated by EDoc