= Introduction =

Czartool is a collection of Perl scripts designed to assist when monitoring the IPP system. Czartool began as a simple script to quickly display the current status of each label in the system, i.e. how many images pending, how many faults. A webpage followed on ippMonitor, then a database was implemented in combination with a polling program (czarpoll) which updates the database every few minutes with the current status of the IPP.

= User notes =

Most users will use czartool via the web page in ippMonitor. This gives a snapshot of processing at the current time, with plots starting from around 6:30am in the morning, since this is when (currently) burntool is scheduled to begin processing the previous night's data.

There are, however, other useful Perl scripts available in {{{trunk/tools}}} that enable the user to go back further in time and create plots or metrics of particular labels, stages or date ranges. The main tool of interest is czarplot.

== czarplot ==

Czarplot may be used to plot the contents of the czar database, which holds a history of IPP processing dating back to around mid-July 2010.

* All plots (where relevant) can be given a date range, but will default to today from 6:30 if not is provided. Note that all times are in HST. When necessary (i.e. when querying rawExp in gpc1, HST is converted to UTC internally).
* where relevant a stage can be chosen, else defaulting to 'all stages'
* were relevant a label can be chosen, else defaulting to 'all_stdscience_labels'

The available plots are as follows:

=== Processing time-series ===

This either plots the

* the number of processed exposures for '''all''' stages (burntool, chip, cam etc) 
* the number of processed, pending and faults for '''one''' stage 

=== Magic mask fraction ===

Both a histogram and cumulative distribution of the magic mask fraction can be plotted for a data range. '''Warning''' these plots can take some time to complete due to multiple JOINS necessary in the query to the gpc1 database.

It is also possible to view the magic mask for a particular exposure as a color gradient.


{{{
./czarplot.pl -m -x 241460 -o .
}}}

[[Image(czarplot_single_exp_magic_mask_fraction.png )]]

== Metrics ==

Since czartool has a database containing a history of IPP processing since July, it is therefore useful for deriving metrics.

= Developer Notes =