Révision 09b88141
Improve documantion of many plugins
Specifically the configuration examples are now indented properly.
| plugins/syncthing/syncthing_ | ||
|---|---|---|
| 2 | 2 |
# -*- sh -*- |
| 3 | 3 |
: <<=cut |
| 4 | 4 |
=head1 NAME |
| 5 |
|
|
| 5 | 6 |
syncthing_ - Plugin to monitor Syncthing server |
| 6 | 7 |
|
| 8 |
|
|
| 7 | 9 |
=head1 DESCRIPTION |
| 10 |
|
|
| 8 | 11 |
This plugin gathers metrics from a Syncthing server. |
| 9 | 12 |
|
| 10 | 13 |
This plugin requires the jq utility : https://stedolan.github.io/jq/ |
| 11 | 14 |
This plugin requires the cURL utility : https://curl.haxx.se/ |
| 12 | 15 |
|
| 13 |
Available plugins : |
|
| 14 |
syncthing_cpu # |
|
| 15 |
syncthing_mem # |
|
| 16 |
syncthing_goroutine # |
|
| 17 |
syncthing_transfer # |
|
| 18 |
syncthing_uptime # |
|
| 16 |
Available wildcard plugin features: |
|
| 17 |
|
|
| 18 |
=over 4 |
|
| 19 |
|
|
| 20 |
=item syncthing_cpu |
|
| 21 |
|
|
| 22 |
=item syncthing_mem |
|
| 23 |
|
|
| 24 |
=item syncthing_goroutine |
|
| 25 |
|
|
| 26 |
=item syncthing_transfer |
|
| 27 |
|
|
| 28 |
=item syncthing_uptime |
|
| 29 |
|
|
| 30 |
=back |
|
| 31 |
|
|
| 19 | 32 |
|
| 20 | 33 |
=head1 CONFIGURATION |
| 21 | 34 |
To make the plugin connect to the Syncthing server one has to use this type of |
| 22 |
configuration |
|
| 23 |
[syncthing_*] |
|
| 35 |
configuration: |
|
| 36 |
|
|
| 37 |
[syncthing_*] |
|
| 38 |
env.syncthing_apikey myapikey0123456789 |
|
| 39 |
env.syncthing_host 127.0.0.1 |
|
| 40 |
env.syncthing_port 8384 |
|
| 41 |
env.syncthing_proto http |
|
| 24 | 42 |
|
| 25 |
env.syncthing_apikey myapikey0123456789 |
|
| 26 |
env.syncthing_host 127.0.0.1 |
|
| 27 |
env.syncthing_port 8384 |
|
| 28 |
env.syncthing_proto http |
|
| 29 | 43 |
|
| 30 | 44 |
=head1 AUTHOR |
| 45 |
|
|
| 31 | 46 |
Pierre-Alain TORET <pierre-alain.toret@protonmail.com> |
| 32 | 47 |
|
| 48 |
|
|
| 33 | 49 |
=head1 LICENSE |
| 50 |
|
|
| 34 | 51 |
MIT |
| 52 |
|
|
| 53 |
SPDX-License-Identifier: MIT |
|
| 54 |
|
|
| 35 | 55 |
=cut |
| 36 | 56 |
|
| 37 | 57 |
syncthing_apikey=${syncthing_apikey:-}
|
Formats disponibles : Unified diff