Module fuse_stats_plugin

Description

The fuse_stats_plugin behaviour.

This module defines the fuse_stats_plugin behaviour.
Required callback functions: init/1, increment/2.

Description

The fuse_stats_plugin behaviour. All fuse stats plugins implement the callbacks defined in this behaviour.

As EDoc does not yet support @doc tags for the -callback method of behaviour specification, documentation on the callbacks is included here. See the source for the callback type annotations.

Note that since metrics export is very much a secondary function of fuse, plugins should consider their work "best effort" and as such not crash on e.g. a badmatch.

init/1

Handles plugin initialization.

Name is the fuse name.

The implementation must create counters and/or whatever is necessary to setup the plugin's statistics store.

increment/2

Increments a counter.

Name is the fuse name.
Counter is one of ok, blown or melt.

The implementation must update or notify counters, spirals or whatever the underlying implementation is.

Generated by EDoc