summaryrefslogtreecommitdiffstats
path: root/plugins/plugin_max/README.md
blob: 414759d9390e9e661e020b8ee31949f4c1f3d8d0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# plugin_max

This showcases a rather simplistic "max" plugin, that collects incoming
measuremens (messages of kind `Measurement`) and periodically sends out the
maximum 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


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"
```