DunLUG Wiki | Meetings / Calamaris

Calamaris is written in perl5 and produces reports from log files for proxy servers.

Presumably its name is because its original design was to parse Squid proxy logs but it now does many more types as well: NetCache, Inktomi Traffic Server, Oops! proxy server, Novell Internet Caching System, Compaq Tasksmart and Netscape/iplanet Web Proxy Server.

There are many options to give you different reports, as well as doing other weird things such as saving the reports for later use as for a baseline or inclusion in later reports etc. but I’ll just give you the basics. If you want more, just look at the man pages.

The authors have helpfully provided an option that gives most of what anybody would need: -a which is supposed to extract all the reports (in actuality it leaves out a couple of them).

-a is the same as using the options –D 10 –d 20 –P 60 –r 20 –s –t 20 which gives you:

-D 10 = Distribution histogram showing how big the objects requested are.

-d 20 = Lists the top 20 root level (eg. *.com) and second level domains (eg. *.microsoft.com)

-P 60 = Performance report. Shows the throughput of TCP requests every hour (one line per hour).

-r 20 = Gives a number of reports (8 I think) to do with UDP and TCP requests and their status.

-s = Makes the reports more verbose

-t 20 = Lists the top 20 content-types (eg. image/jpeg) and file extensions(eg. .jpg)

This gives you a list of over a dozen reports but this isn’t all you can get.

Conspicuously absent from this is the –p option which will give you peak reports showing the peak usage per second, per minute and per hour for TCP, UDP and/or all protocols. There may be others that I didn’t see as well.

You can also use the –F option to format the output of the report ready for mail, as HTML tables (which can be used with the mail option to produce HTML mail), as embedded HTML tables (i.e. no HTML headers which is useful for server-side-includes) or as raw unformatted numbers separated by spaces (useful for re-using as the input to other scripts). In the beta of the new version you can also have graphs as .png pictures linked to within the HTML.

If the –F option is not used the standard output is simply 80 character plain ascii.

Some examples can be seen by scrolling down to the bottom of http://cord.de/tools/squid/calamaris/ and clicking on the appropriate link.