Caretaker Installation Tutorial¶
Setup Caretaker Server¶
The caretaker server should be placed on a secure place in your Intranet. It stores the public/private keypair which is used to communicate with the instances. If those keys are leaked attackers could use Caretaker to get Informations about the monitored Instances!
Step 1 : Get TYPO3 4.3 up and running¶
You are about to install a TYPO3 Monitoring System. I really hope you know how to setup TYPO3. The only thing you probably want to know is that caretaker does not run under php4. So go for php5. We require TYPO3 4.3 for the central server because of the included ExtJS.
Step 2 : Install the Prerequisites (tt_address and css_styled_content)¶
Before installing caretaker you have to install the TYPO3-Extensions css_styled_content (For content display) and tt_address for the management of notifications.
Step 3: Install Extension Caretaker (Checkout from SVN)¶
(Don't install caretaker_instance before caretaker as recommended, install it later to get all tests.)
Step 4: Create a Sysfolder for the caretaker Records¶
Step 5: Create some Records to configure Caretaker¶
- Instances: An Instance represents a monitored TYPO3-Installation. So you have to add an Instance Record for each Site you want to monitor. You have to fill in the url and the hostname of the instance. Optionaly you can manage your instances by grouping (instancegroups).
- Tests: Tests are the also created as TYPO3 Records. You first select the Type of Test you want to execute (Depends on the installed TestServices) and the desirec Test-Execution-Interval. After a reaload you will see a form with the configuration for your selected Testtype. Like Instances Tests can also be grouped by using Testgroup Records. A Test and a Testgroup can be assigned to n Instances. You can manage typical sets of tests by creating dedicated testgroups wich are assigned to all affected instances.
Step 6: Check out the caretaker Backend Module¶
You can select each node view the state and trigger an update. If you use the force update button the test will be executed even if the expiration time since the last run is'nt over yet.
Please notice that there is no update of parent nodes yet and the treeview will also stay the same. This will change in the future.
Step 7: Add some Tests¶
The caretaker system comes with Ping and HTTP tests included. You can define some tests now and start monitoring.
Step 8: Setup Cronjob¶
Add php -f [your caretaker installation path]/typo3/cli_dispatch.phpsh caretaker update -R to your crontab. Use an execution interval of 1 or 5 Minutes. Caretaker will decide on it's own which tests are due to execution this time.