README.md

munin-plugins-syncthing

Munin plugins to monitor Syncthing and Syncthing relay.

Requirements

• jq
• Munin already setup and running
• Syncthing already setup and running
• Syncthing relay setup and running

Available plugins

# Syncthing
syncthing_transfer      # graph the total in/out bits 
syncthing_cpu           # graph the cpu percentage used
syncthing_goroutine     # graph the number of go routines used
syncthing_mem           # graph the amount of memory allocated and obtained from the system
syncthing_uptime        # graph the uptime

# Syncthing relay server
strelaysrv_goroutine    # graph the number of go routines used
strelaysrv_num          # graph the stats provided by the relay
strelaysrv_proxied      # graph the relay total proxied bits
strelaysrv_transfer     # graph the relay transfer rate of the last 5 mins
strelaysrv_uptime       # graph the relay uptime

Installation

Like all munin plugins, you have to create a symbolic link in your Munin plugin directory (usually it is /etc/munin/plugins). For example suppose you have downloaded the plugins in /usr/share/munin/plugins (with the default ones provided by Munin) you should run the following commands.

# installation of the uptime plugin
# cd /usr/share/munin/plugins && git clone https://github.com/daftaupe/munin-plugins-syncthing.git
# cd /etc/munin/plugins && ln -s /usr/share/munin/plugins/munin-plugins-syncthing/syncthing_ syncthing_uptime

Configuration

Create /etc/munin/plugin-conf.d/syncthing. Modify the following to fit your Syncthing instance.

# Syncthing
[syncthing_*]

env.ST_APIKEY abcdefgh12345678
env.ST_HOST 127.0.0.1
env.ST_PORT 8384
env.ST_PROTO http

The APKIKEY is found in the configuration panel of Syncthing web interface.

Create /etc/munin/plugin-conf.d/strelaysrv. Adapt it to your own case.

#Syncthing relay
[strelaysrv_*]

env.STR_HOST 1.2.3.4
env.STR_PORT 22070

The APIKEY is not needed for the Syncthing relay monitoring, the /status is publicly available. You can enable it with the -status-srv flag when starting strelaysrv.

Preview