CaiCai -- A networked hosts' monitoring system
Copyright (c) 2005 Daniel Mealha Cabrita
Licensed under the GNU GPL - http://www.gnu.org/licenses/gpl.txt
author's email: dancab@gmx.net
(September 25th, 2005)
v. 0.4.0
---
== INDEX ==
- INTRODUCTION
- REQUIREMENTS
- INSTALLATION
- CONFIGURATION
- EXTRA INFORMATION ON CONFIGURATION
- AVAILABLE MODULES
1. INTRODUCTION
CaiCai is a system for monitoring whether certain hosts are dead or alive (or behaving in a strange way, sometimes). It examines different services/aspects (DHCP, Ping test, etc), gives some stats on those and has an (user-defined) sound alarm in case something goes wrong.
The CaiCai's modular architeture adds convenience since it makes possible to write new test modules easily.
2. REQUIREMENTS
- Basic tools such as:
bash date dhcpcd grep host (bind-utils) nmblookup (Samba) ping (iputils) sed >= 4 (<= 3.x won't work properly) sleep telnet wget
WARNING: Currently CaiCai assumes you're using the GNU/BSD versions of the above-listed tools, a different version may run or not (it depends on CaiCai's parser being able to interpret the output correctly).
3. INSTALLATION
To install from the source:
At CaiCai's source directory, type at the shell:
# ./configure
# make
# make install (or manual file copy)
4. CONFIGURATION
Configure the files inside /etc/caicai
Look at
/etc/caicai/*.EXAMPLE
/etc/caicai/modules/*.EXAMPLE
The configuration files do not have the ".EXAMPLE" suffix:
"caicai.conf.EXAMPLE" ---> "caicai.conf"
And so on.
Execute the init script
Example (may differ, depending on your OS):
# /etc/init.d/caicaid start
5. EXTRA INFORMATION ON CONFIGURATION
5.1 - Do NOT use hostnames in the *.hosts config files
Use IPs instead.
The reason to avoid hostnames is simple:
If your DNS goes down, all the other tests will fail, even if the hosts themselves are OK.
If you really think using a hostname is necessary, try adding manually the entries you need to your local
/etc/hosts
5.2 - Do not abuse the CaiCai's (limited) parser capabilities, thus do NOT:
5.2.1 - Use the "" (scratchy) character, unless as specified.
Does "<font color="112233">" ring a bell? Then DO NOT use it.
5.2.2 - In /etc/caicai.conf. Do NOT comment a line past a valid entry.
Yeah, it's a bug.
5.2.3 - Anything bizarre somehow (use your imagination).
5.3 - Do not change the config files on-the-fly (ie. while CaiCai's daemon running).
CaiCai is always reading the config files while running. It might work, or weird things may happen.
6. AVAILABLE MODULES
6.1 - DHCP
Tests whether the DHCP server is running and its sanity.
Checks only one server.
6.2 - DNS
Tests whether the DNS servers are able to resolve a test hostname.
6.3 - FTP
Tests whether the FTP servers are alive.
6.4 - HTTP
Tests whether the HTTP servers are alive.
6.5 - PING
Tests whether the specified IPs returns the ping or not.
6.6 - POP3
Tests whether the POP3 servers are alive.
6.7 - SMTP
Tests whether the SMTP (sendmail) servers are alive.
6.8 - IMAP
Tests whether the IMAP servers are alive.
6.9 - HTTPS
Tests whether the HTTPS servers are alive.
6.10 - SMB
Tests whether the SMB (W*ndows) servers are alive.
Currently it only checks for NMB responses. So if the NMB
is working, the module will assume everything is allright.
---
Havia uma barata na cozinha...
Eu olhei pra ela e ela olhou pra mim.
Ofereci a ela um pedaço de pudim...
O curioso foi que ela... Ela disse sim!
Vem ká f'cá comigo...
--- end of documentation ---