From de6c066ceb780cc76cda9f04885378808b4d5985 Mon Sep 17 00:00:00 2001 From: Eric Renfro Date: Fri, 28 Jun 2013 12:55:28 -0400 Subject: [PATCH] Added documentation to README --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 7e9a2fa..8b3adbf 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,28 @@ Documention for Zabbix Scripts Work-in-Progress +The agents provided in this bundle are intended to be used for Zabbix Trapper +agents, run on the server and batched together and sent as bulk. Documentation +covering how these work will be provided further in this documentation. + +Suggestion installation path is to place the scripts/ directory into: + /etc/zabbix/scripts/ + +And then create a directory: + /etc/zabbix/trap.d/ + +If you need more granularity, you can make a trap.d/daily, trap.d/hourly, etc +as needed and adjust your crons to run the runtrap with the path accordingly. + +Inside your trap.d path should be either symlinks directly back to the +scripts/trappername or a script that runs the trapper agent with neccessary +arguments as needed. You can number the links/scripts in the trap.d so they +execute in a specific order. + +One thing to note, it's best to make sure everything in your trap.d is uniquely +named. The runtrap script is designed to prevent stalling trappers by killing +them after a number of execution attempts (default of 3). Also, when executing +runtrap from cron, it's best to always insure it's run by the full pathname so +it can kill itself accordingly when deadlocks are detected. This will allow +the next run to attempt running the trappers again. +