2
0
Эх сурвалжийг харах

Clarify Zabbix monitoring hook documentation about creating items (#936).

Dan Helfman 3 сар өмнө
parent
commit
ddfd3c6ca1

+ 3 - 0
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.

+ 13 - 5
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.
-
-Keep in mind that `host` is referring to the "Host name" on the Zabbix server
-and not the "Visual name".
+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.
+
+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

+ 1 - 1
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" },
 ]