Module riak_sysmon_filter

Filtering/rate-limiting mechanism for the Erlang virtual machine's system_monitor events.

Behaviours: gen_server.

Description

Filtering/rate-limiting mechanism for the Erlang virtual machine's system_monitor events.

See the README.md file at the top of the source repository for details.

Function Index

add_custom_handler/2Add a custom handler module to the riak_sysmon.
call_custom_handler/2
call_custom_handler/3Make a synchronous call to a riak_sysmon specific custom event handler.
start_link/0 Starts the server.
start_link/1Start riak_sysmon filter process.
start_timer/0
stop_timer/0

Function Details

add_custom_handler/2

add_custom_handler(Module, Args) -> any()

Add a custom handler module to the riak_sysmon.

See the source code of the riak_sysmon_example_handler:add_handler/0 function for a usage example.

call_custom_handler/2

call_custom_handler(Module, Call) -> any()

call_custom_handler/3

call_custom_handler(Module, Call, Timeout) -> any()

Make a synchronous call to a riak_sysmon specific custom event handler.

See the source code of the riak_sysmon_example_handler:get_call_count/0 function for a usage example.

start_link/0

start_link() -> {ok, Pid} | ignore | {error, Error}

Starts the server

start_link/1

start_link(MonitorProps) -> any()

Start riak_sysmon filter process

The MonitorProps arg is a property list that may contain zero or more of the following atoms:

start_timer/0

start_timer() -> any()

stop_timer/0

stop_timer() -> any()


Generated by EDoc, Aug 2 2017, 22:48:11.