zabbix hook added

This commit is contained in:
2024-10-18 17:57:37 -04:00
parent 29d5b36a78
commit b874e7e66f
5 changed files with 228 additions and 0 deletions

View File

@@ -47,6 +47,7 @@ them as backups happen:
* [ntfy](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#ntfy-hook)
* [PagerDuty](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#pagerduty-hook)
* [Uptime Kuma](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#uptime-kuma-hook)
* [Zabbix](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#zabbix-hook)
The idea is that you'll receive an alert when something goes wrong or when the
service doesn't hear from borgmatic for a configured interval (if supported).
@@ -562,6 +563,55 @@ Heartbeat Retry = 360 # = 10 minutes
Resend Notification every X times = 1
```
## zabbix hook
<span class="minilink minilink-addedin">New in version 1.8.15</span>
[zabbix](https://www.zabbix.com/) is an open-source monitoring tool used for tracking and managing the performance and availability of networks, servers, and applications in real-time.
This hook does not do any notifications on it's own. Instead, it relies on
your zabbix instance to notify and perform escalations based on the zabbix
configuration. The `states` list will choose which states to trigger on.
Each state can have its own custom values configured. These values are
populated in the item data in zabbix. If none are provided, will use the
default.
An example configuration is shown here with all the available options.
```yaml
zabbix:
server: http://cloud.zabbix.com/zabbix/api_jsonrpc.php
username: myuser
password: secret
api_key: b2ecba64d8beb47fc161ae48b164cfd7104a79e8e48e6074ef5b141d8a0aeeca
host: "borg-server"
key: borg.status
itemid: 55105
start:
value: "STARTED"
finish:
value: "OK"
fail:
value: "ERROR"
states:
- start
- finish
- fail
```
<span class="minilink minilink-addedin">Authentication Methods</span>
Authentication can be accomplished via `api_key` or `username` and `password`.
If both are declared, `api_key` will be chosen.
<span class="minilink minilink-addedin">Items</span> The item
to be updated can be chosen by either declaring the `itemid` or
`host` and `key`. If both are declared, `itemid` will be chosen.
Keep in mind that `host` the Host name on the host and not the
Visual name.
## Scripting borgmatic