From ddfd3c6ca1538662f4f46db79d209f398c5357d6 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Mon, 3 Mar 2025 16:02:22 -0800 Subject: [PATCH] Clarify Zabbix monitoring hook documentation about creating items (#936). --- NEWS | 3 +++ docs/how-to/monitor-your-backups.md | 16 ++++++++++++---- pyproject.toml | 2 +- 3 files changed, 16 insertions(+), 5 deletions(-) diff --git a/NEWS b/NEWS index 25fdc460..e77e1003 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,6 @@ +1.9.14.dev0 + * #936: Clarify Zabbix monitoring hook documentation about creating items. + 1.9.13 * #975: Add a "compression" option to the PostgreSQL database hook. * #1001: Fix a ZFS error during snapshot cleanup. diff --git a/docs/how-to/monitor-your-backups.md b/docs/how-to/monitor-your-backups.md index 01649315..1f0c959e 100644 --- a/docs/how-to/monitor-your-backups.md +++ b/docs/how-to/monitor-your-backups.md @@ -724,11 +724,19 @@ Authentication can be accomplished via `api_key` or both `username` and ### Items -The item to be updated can be chosen by either declaring the `itemid` or both -`host` and `key`. If all three are declared, only `itemid` is used. +borgmatic writes its monitoring updates to a particular Zabbix item, which +you'll need to create in advance. In the Zabbix web UI, [make a new item with a +Type of "Zabbix +trapper"](https://www.zabbix.com/documentation/current/en/manual/config/items/itemtypes/trapper) +and a named Key. The "Type of information" for the item should be "Text", and +"History" designates how much data you want to retain. -Keep in mind that `host` is referring to the "Host name" on the Zabbix server -and not the "Visual name". +When configuring borgmatic with this item to be updated, you can either declare +the `itemid` or both `host` and `key`. If all three are declared, only `itemid` +is used. + +Keep in mind that `host` refers to the "Host name" on the Zabbix server and not +the "Visual name". ## Scripting borgmatic diff --git a/pyproject.toml b/pyproject.toml index 54031a9c..cd1ce7a3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "borgmatic" -version = "1.9.13" +version = "1.9.14.dev0" authors = [ { name="Dan Helfman", email="witten@torsion.org" }, ]