syno_exporter

README

syno_exporter

• Master :
• Develop :

This Prometheus exporter check the health of your Synology NAS:

• System status (Power, Fans)
• Disks status
• RAID status
• DSM update status
• Temperature Warning and Critical
• UPS information
• Storage percentage of use

Tested with DSM 6.0 Based on Synology Diskstation MIB Guide

Installation

You can download the binaries :

• Architecture i386 [ linux / darwin / freebsd / netbsd / openbsd / windows ]
• Architecture amd64 [ linux / darwin / freebsd / netbsd / openbsd / windows ]
• Architecture arm [ linux / freebsd / netbsd ]

Usage

Launch the Prometheus exporter :

$ syno_exporter -log.level=debug -diskstation 192.168.1.11

Check SNMP informations from your Diskstation (Change your community name):

# System load
$ snmpget -v 1 -c "public" 192.168.1.11 .1.3.6.1.4.1.2021.10.1.3.1

# Get available disk space for /
$ snmpget -v 1 -c "public" 192.168.1.11 .1.3.6.1.4.1.2021.9.1.7.1

Monitoring

Use [docker-compose.yml][] (or [docker-compose-rpi.yml] for RaspberryPI) to launch [Prometheus][] and [Grafana][] containers.

Development

• Initialize environment

    $ make init
  

• Build tool :

    $ make build
  

• Launch unit tests :

    $ make test
  

Local Deployment

• Launch Prometheus using the configuration file in this repository:

    $ prometheus -config.file=prometheus.yml
  

• Launch exporter:

    $ syno_exporter -log.level=debug -diskstation 192.168.1.11
  

• Check that Prometheus find the exporter on http://localhost:9090/targets

Contributing

See CONTRIBUTING.

License

See LICENSE for the complete license.

Changelog

A changelog is available

Contact

Nicolas Lamirault nicolas.lamirault@gmail.com