raph2i / synology_backup_exporter Goto Github PK

View Code? Open in Web Editor NEW

4.0 2.0 4.0 34 KB

Prometheus Exporter for Synology Backup Suite (Active Backup, Hyper Backup, Hyper Backup Vault)

License: MIT License

Python 99.15% Dockerfile 0.85%

prometheus prometheus-exporter synology metrics exporter hyper-backup hyper-backup-vault backup

synology_backup_exporter's Introduction

Synology Backup Exporter

Install

Docker

docker-image available Docker Hub

Synology Docker

create config.json in /volume1/docker/synology_backup_exporter (or elsewhere)
Search for "synology_backup_exporter" in Docker Registry
select tag "dsm7"
wait for image download to finish
launch image
set config.json as filevolume to /app/config.json
add port settings (The default exporter-port is 9771)
???
scrape metrics :)

Configure

Configure with just a config file

Copy config.json.dist to config.json then change the settings in config.json to your needs

Configure with just Environment Variables

Look in the config.json.dist file, then simply uppercase the keys and provide the values, for example:

DSMAddress becomes DSMADDRESS
Cert_Verify becomes CERT_VERIFY
etc

Configure with both the config file and Environment Variables

Copy config.json.dist to config.json then change the settings in config.json to your needs. Remove any lines that are not wanted in the config file, for example if having a password in the config file is not desired, remove that line, then provide the environment variable PASSWORD. If a value is provided in the config file and as an environment variable, the config file will take precedence. Note: JSON files should not have a , on the last configuration line, if the last line has a comma this exporter will not work

Metrics

Active Backup for Business

Active Backup for Business metrics have these labels: hostname,vmname,vmos,vmuuid

metrics:

synology_active_backup_lastbackup_timestamp
synology_active_backup_lastbackup_duration
synology_active_backup_lastbackup_transfered_bytes
synology_active_backup_lastbackup_result

Hyper Backup

Hyper Backup metrics have these labels: task_id,task_name,target_type

synology_hyper_backup_lastbackup_successful_timestamp
synology_hyper_backup_lastbackup_timestamp
synology_hyper_backup_lastbackup_duration

Note: For the first time a Hyper Backup is run, the exporter will report the backup job as being successful with a duration of 0 seconds, and completion timestamps of whenever the exporter scraped the Synology.

Hyper Backup Vault

Hyper Backup Vault metrics have these labels: target_name,target_id,target_status

synology_hyper_backup_vault_last_backup_duration_seconds
synology_hyper_backup_vault_last_backup_start_timestamp
synology_hyper_backup_vault_target_used_size_bytes

Alert rules:

Last Backup not successful:

Active Backup

name: Synology Active Backup Last Backup not successful
expr: synology_active_backup_lastbackup_result != 2
for: 1m

Hyper Backup

name: Synology Hyper Backup Last Backup not successful
expr: synology_hyper_backup_lastbackup_timestamp != synology_hyper_backup_lastbackup_successful_timestamp
for: 1m

Last Backup older than 72 hours:

Active Backup

name: Synology Active Backup Last Backup older than 72 hours
expr: ((synology_active_backup_lastbackup_timestamp - time()) / 3600) < -72
for: 1m

Hyper Backup

name: Synology Hyper Backup Last Backup older than 72 hours
expr: ((synology_hyper_backup_lastbackup_successful_timestamp - time()) / 3600) < -72
for: 1m

License

MIT // 2021 - Raphael Pertl

Special thanks to synology-api

synology_backup_exporter's People

Contributors

Stargazers

Watchers

Forkers

zxjinn uriyacovy aritas1 heil

synology_backup_exporter's Issues

[Permissions] Use exporter with Synology non-admin user

Hello,

I have tried to setup a DSM Synology user with delegated access for Hyper Backup only - rather than giving full Administrator group access. I specify the user + password as ENV variables to the exporter container.

The issue is: with a DSM non-admin user the Exporter won't start. The Synology DSM account itself works - if I login I can see only Hyper Backup and access all its jobs.

The delegation how-to is described here:
https://community.synology.com/enu/forum/8/post/147857

Is it possible to get this to work?

compile for arm64

for usage on rpi4

catch exeption if hyper backup task was not run yet

Exporter very high %CPU

Hello,

I have ~20 containers running on my 8core physical host (misc applications, Prometheus exporters etc), including the Synology Backup Exporter, latest image.

The issue I have is this application / exporter is using 10x the CPU compared to all the rest. I think it's a bit odd. I have visualized it with Grafana here:

And with Linux Cockpit here:

Is there anything that can be done about the heavy utilization, or is it expected behavior?

Exporter "lastbackup" timestamp unit for visualization

Hi @raph2i ,

Thanks for the excellent exporter. I'm visualizing the metrics in Grafana, and wonder if you know what unit (in the Grafana Dashboard options - Standard options - Unit) to use for those two metrics?

synology_hyper_backup_lastbackup_successful_timestamp
synology_hyper_backup_lastbackup_timestamp

Datetime doesn't seem to be correct ones. It shows 1970-01-20 on all metrics.

Take configuration from environment variables

Hey @raph2i this is a wonderful tool, thank you for writing it.

I wanted to extend it a little bit, but would like your opinion on how you would like it extended first. I am planning on running this in a container (but not on the synology itself), and would rather configure the script with environment variables instead of the config.json file.

There are three basic paths forward that I see:

If the config.json doesn't exist, start reading in the values from an environment variable. This is an all or nothing, either use the config file or use env vars.
Detect what values are missing from the config.json and then reach to an env var to fill that value
Detect what env vars are missing, and reach to the config.json to fill that value

Which of these three do you prefer? or something else perhaps.

The last question is, should the script fail and exit if one of the config values doesn't exist, or should it be filled with some kind of default value (like you have in the config.json.dist file)?

raph2i / synology_backup_exporter Goto Github PK

synology_backup_exporter's Introduction

Synology Backup Exporter

Install

Docker

Synology Docker

Configure

Configure with just a config file

Configure with just Environment Variables

Configure with both the config file and Environment Variables

Metrics

Active Backup for Business

Hyper Backup

Hyper Backup Vault

Alert rules:

Last Backup not successful:

Active Backup

Hyper Backup

Last Backup older than 72 hours:

Active Backup

Hyper Backup

License

Special thanks to synology-api

synology_backup_exporter's People

Contributors

Stargazers

Watchers

Forkers

synology_backup_exporter's Issues

Recommend Projects

Recommend Topics

Recommend Org