Overview
Urchin 4 ships with a number of utility programs that are used for diagnostic and configuration purposes. These utilities are located in the "util" directory of the Urchin 4 distribution. This document is intended as an introductory overview of these utilities. It is not a comprehensive guide to their usage. Please consult the specific Knowledgebase article for each utility at http://help.urchin.com for detailed information on the capabilities and usage of each of these programs.
All utilities support -h and -v options. Invoking a utility with - h will give a summary of available options for that tool. Invoking with -v prints the Urchin 4 version of the utility.
u3importer
This utility is used to migrate existing Urchin 3 config file information and report databases into Urchin 4. It runs interactively and prompts the user for the location of the Urchin 3 config file. The process then imports the Urchin 3 data without disturbing the existing Urchin 3 installation. The u3importer cannot import all configuration data specified by Urchin 3 config file directives. Some Urchin 3 directives, such as subreport mode, are not supported in Urchin 4, and have no equivalent. Others such as filters, are organized significantly different in Urchin 4, so cannot be imported exactly as they were specified in Urchin 3. The main objective of this tool is to get all your Urchin 3 report blocks and data imported in a basic fashion so that you have Urchin 4 reporting operational for all your sites, and past report data is available.
inspector
This utility performs basic sanity checks on your installed Urchin 4 distribution, ensuring that the overall structure of the distribution is intact, that all the binaries shipped with the product are the proper version, and that the underlying permissions are correct (on UNIX- type platforms). The utility also reports on the operational status of the Urchin Scheduler (urchind) and the bundled Apache web server (urchinwebd).
uconf-export/uconf-import
These utilities use a text format of their own to represent the contents of the Urchin 4 configuration database in a human readable intermediate form. An Urchin configuration can therefore be exported and saved, or imported to restore the state of an Urchin configuration. Saved configurations can also be modified with an editor, or configuration files can constructed from scratch, before being imported back into the Urchin configuration database. You can therefore mimic the config file functionality that existed with Urchin 3 if desired. It is recommended that you use uconf-export on a regular basis to save your current configuration state as a backup.
uconf-driver
This utility provides a command line interface for administering the Urchin 4 configuration. All functionality present in the Urchin 4 administration interface is available in this utility, thus it can completely replace the use of the administration interface as far as managing all aspects of Urchin 4. uconf-driver is intended for use in situations where scriptable actions for automating the Urchin configuration are desired. This makes it ideal for environments such as large shared hosting operations, where the amount of data that must be managed makes it impractical to manage Urchin via a point and click graphical interface.
uconf-schedule
This is a global task scheduler utility. You can schedule tasks for all your Profiles simultaneously with this tool. This saves a great deal of manual labor if you have many Profiles. Executing uconf-schedule with the -r (i.e. run-now) option will cause all Profiles to be processed immediately. When executed without options, uconf-schedule goes into interactive mode and prompts for input to set the time for all scheduled tasks to run. The Urchin task scheduler must be running for uconf-schedule to work.
udb-sanitizer
The udb-sanitizer program is used to effect repairs on your report databases when there is a problem that leads to database inconsistency or corruption. Urchin routinely does database consistency checks while processing logs. When it detects a database that needs repair it will report the need for udb-sanitizer to be run. In addition, this utility allows removal of a single day or a month's worth of data in the event that logs need to be reprocessed.
urchin4_daemons
On Unix machines Urchin runs a scheduler daemon (urchind) and a webserver daemon (urchinwebd). These programs should be started at boot time. The urchin4_daemons script can be added to the system initialization scripts in the location appropriate for your Unix-type OS, and it will cause the Urchin service daemons to be launched properly.