diff options
Diffstat (limited to 'plugins/plugin_avg/README.md')
| -rw-r--r-- | plugins/plugin_avg/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/plugins/plugin_avg/README.md b/plugins/plugin_avg/README.md new file mode 100644 index 00000000..fa7027fe --- /dev/null +++ b/plugins/plugin_avg/README.md @@ -0,0 +1,34 @@ +# plugin_avg + +This showcases a rather simplistic "avg" plugin, that collects incoming +measuremens (messages of kind `Measurement`) and periodically sends out an +average of the collected values of the last timeframe. + +## Note + +Currently, only integer measurements are supported. + + +## Configuration + +The configuration of the plugin can have the following fields + +* `timeframe`: How long to collect messages before sending them out. + E.G.: "1min" +* `target`: Whom to send the average to +* `report_on_zero_elements`: If there have not been any incoming measurements in + the `timeframe`, whether to send out a zero, or not send anything + + +Example configuration: + +```toml +# For a reference what format is supported here, please see +# https://docs.rs/humantime/latest/humantime/ +timeframe = "1min" + +target = "my_other_plugin" + +report_on_zero_elements = false +``` + |