Module fuse_stats_plugin

The fuse_stats_plugin behaviour.

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.

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

increment/2

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

Generated by EDoc, Apr 29 2016, 23:23:30.