Skip to content

Repository files navigation

Prometheus Monitoring Mixin for Syncthing

A set of Grafana dashboards and Prometheus alerts for Syncthing using the metrics from Syncthing.

Dashboards

Grafana Dashboard

Generated dashboards are also in the ./dashboards_out directory.

How to use

This mixin is designed to be vendored into the repo with your infrastructure config. To do this, use jsonnet-bundler:

You then have three options for deploying your dashboards

  1. Generate the config files and deploy them yourself
  2. Use jsonnet to deploy this mixin along with Prometheus and Grafana
  3. Use prometheus-operator to deploy this mixin

Or import the dashboard using json in ./dashboards_out, alternatively import them from the Grafana.com dashboard page.

Generate config files

You can manually generate the alerts, dashboards and rules files, but first you must install some tools:

brew install jsonnet jsonnet-bundler

Then, grab the mixin and its dependencies:

git clone https://github.com/adinhodovic/syncthing-mixin
cd syncthing-mixin
jb install

Finally, build the mixin:

make prometheus_alerts.yaml
make dashboards_out

The prometheus_alerts.yaml file then need to passed to your Prometheus server, and the files in dashboards_out need to be imported into you Grafana server. The exact details will depending on how you deploy your monitoring stack.

Alerts

The mixin follows the monitoring-mixins guidelines for alerts.

About

Monitoring mixin for Syncthing. A set of Grafana dashboards and Prometheus rules for Syncthing.

Topics

Resources

Stars

6 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages