Custom Data Recording and Reporting

Introduction

The mechanism for including custom recording/reporting code into collectl is very similar to that for exporting custom data. One uses the switch --import followed by one or more file names, separated by colons. Following each file name are one or more file-specfic arguments which if specified are comma separated as shown below:

collectl --import file1,d:file2
In this example collectl will look for the files file1.ph and file2.ph, noting that the first has the single argument 'd'. Collectl will execute a perl require on each file (in the order they're specified) and subsequently call functions in them from various locations within collectl. Looking for strings in both collectl and formatit.ph that begin with &{$imp will identify the locations where collectl calls the functions named in the API and may help during the development/testing process to better understand what collectl is doing.

As a reference, a simple module has been included in the same main directory as collectl itself, which is named hello.ph as collectl's version of Hello World. Since it can't read anything from /proc it is hardcoded to generate 3 lines of data with increasing data values. Beyond that bit a hand-waving, everything else it does is fully functional. You can mix its output with any standard collectl data, record to raw or plot files, play back the data and even send its output over a socket.

It should be noted that although collectl itself does not use strict, which is a long story, it is recommended these routines do. This will help ensure that they do not accidentally reuse a variable of the same name that collectl does and accidentally step on it.

A couple of words about performance

One of the key design objectives for collectl is efficiency and it is indeed very lightweight, typically using less than 0.2% of the CPU when sampling once every 10 seconds. Another way to look at this is it often uses less than 192 CPU seconds in the course of an entire day. If you care about overhead, and your should, be sure to be as efficient as you can in your own code. If you have to run a command to get your data instead of reading it from /proc, that will be more expensive. If that command has to do a lot of work, it will be even more expensive.

It is recommended your take advantage of collectl's built-in mechanism for measuring its own performance. For example, measuring the performance of the hello.ph example, which does almost nothing since it doesn't even look at /proc data, uses less than 1 second on an older 2GHz system. Monitoring CPU performance data take about 3-1/2 seconds and memory counters take about 7 seconds, just to give a few examples of the more efficient types of data it collects.

Access to collectl internal functions, variable and constants

Collectl is relatively big, at least for a perl script, consisting of over 100 internal subroutines, most of which are simply for internal housekeeping, but some of which are of a more general purpose. It also keeps most of its statistical data in single variables and one dimentional arrays. Clearly hashes could make it more convenient for passing data around but it was felt that the use of more complex data structures would generate more overhead and so their use has been minimized.

While it is literally impossible to enumerate them all, there are a relatively small number of functions, variables and constants that should be considered when writing your routines to insure a more seamless integration with collectl. The following table is really only a means to get started. If you need more details of what a function actually does or how a variable is used, read the code.

FunctionDefinition
cvt()Convert a string to a fixed number of columns, appending 'K', 'M', etc as appropriate. Can also be instructed to divide counters by 1000 and sizes by 1024.
error()Report error on terminal and if logging to a message file write a type 'E' message. Then exit
fix()When a counter turns negative, it has wrapped. This function will convert to a positive number by adding back the size of a 32-bit word OR a user specified data width.
getexec()Execute a command and record its output prepended with the supplied string
getproc()Read data from /proc, prepending a string as with getexec except in this case you can also instruct it to skip lines at the beginning or end. See the function itself for details
record()Only needed if not using getproc which will call it for you, records a single line of data
VariableDefinition
$datetimeThe date/time stamp associated with the current set of data, in the user requested format, based on the use of -o. See the constant $miniFiller which is a string of spaces of the same width.
$intSecsThe number of seconds in the current interval. This is not an integer.
ConstantsDefinition
$miniFillerA string of spaces, the same number of characters as in the $datetime variable
$rateA text string that is set to /secs and appended to most of the verbose format headers, indicating rates are being displayed. However, if the user specifies -on with the collectl command to indicate non-normalized data, it is set to /int to indicate per-interval data is being reported.
$SEPThis is the current plot format separator character, set to a space by default, but can be changed with --sep so never hard code spaces into your plot format output.

The API

The API between collectl and user written code is actually a fixed number of callbacks. In other words, when you tell collectl to import a piece of code, it not only uses that name to identify the code it also uses that name as a qualifier on the name of the functions it calls. If you load a module called mymodule, collectl will then make calls to mymoduleInit(), mymoduleGetData() and several others as enumerated in the table below. You must include all these function call backs in your code or prevent them from being called by restricting which switches the user is allow to specify in the collectl command line. For example if your module doesn't want to support plot data and you generate an error if the user specified -P (which can be checked by examing $plotFlag in your init routine), you can safely leave off the PrintPlot callback.

FunctionDefinition
AnalyzeExamine performance counters and generate values for current interval
GetDataRead performance data from /proc or any other mechanism of choice
InitOne time initializations are performed here
InitIntervalInitializations required for each processing cycle
PrintBriefBuild output strings for brief format
PrintExportBuild output strings for formatting by gexpr, lexpr and sexpr, which are 3 standard collectl --export modules
PrintPlotBuild output string in plot format
PrintVerboseBuild output string in verbose format
UpdateHeaderAdd custom line(s) to all file headers

There are also several constants that must be passed back to collectl during intialization. See Init() for more details.

Analyze($type, \$data)

This function is called for each line of recorded data that begins with the qualifier string that has been set in Init. Any lines that don't begin with that string will never be seen by this routine. You should also be sure that string is unque enough that you aren't passed data you don't expect.

GetData()

This function takes no arguments and is responsible for reading in the data to be recorded and processed by collectl and as such you should strive to make it as efficient as possible. If reading data from /proc, you can probably use the getproc() function, using 0 as the first parameter for doing generic reads. If you wish to execute a command, you can call getexec() and pass it a 3 which is its generic argument for capturing the entire contents of whatever command is being executed.

If you want to do your own thing you can basically do anything you want, but be sure to call record() to actually write the data to the raw file and optionally pass it to the analysis routine later on.

In any case, each record must use the same discriminator that Analyze is expecting so collectl can identify that data as coming from this module. You may also want to look at the data gathering loop inside of collectl to get a better feel for how data collection works in general.

To make sure you're collecting data correctly, run collectl with -d4 as shown below for reading socket data, which uses the string sock as its own discriminator.

collectl -ss -d4
>>> 1238001124.002 <<<
sock sockets: used 405
sock TCP: inuse 10 orphan 0 tw 0 alloc 12 mem 0
sock UDP: inuse 8 mem 0
sock RAW: inuse 0
sock FRAG: inuse 0 memory 0

Init(\$options, \$key)

This function is called once by collectl, before any data collection begins. If there are any one-time intializations of variables to do, this is the place to do them. For example, when processing incrementing variables one often subtracts the previous value from the current one and this is the ideal place to initialize their previous values to 0. Naturally that will lead to erroneous results for the first interval, which is why collectl never includes those stats in its output. However, if you don't initialize them to something you will get uninitialized variable warnings the first time they're used.

InitInterval()

During each data collection interval, collectl may need to reset some counters. For example, when processing disk data, collectl adds together all the disk stats for each interval which are then reported as summary data. At the beginning of each interval these counters must be reset to 0 and it's at that point in the processing that this routine is called.

PrintBrief($type, \$line)

The trick with brief mode is that that multiple types of data are displayed together on the same line. That means each imported module must append its own unique data to the current line of output as it is being constructed without any carriage returns. Further, since there are 2 header lines and brief format supports the ability to print running totals when one enters return during processing, there are a number of places one needs to have their code called from.

PrintExport($type, \$ref1, \$ref2, \$ref3, \$ref4)

What about custom export modules and how this effects them? The good news is that at least for the standard 3, sexpr, lexpr and the newest gexpr all support --import. In other words they too have callbacks that you must repond to if your code is being run at the same time as one of these.

Again, see hello.ph for an example, but suffice it to say you need to do something when called, even if only a null function is supplied.

Since both lexpr and sexpr can write their output to the terminal, the easiest way to test these is to just run collect and have it display on the terminal. However, the output of gexpr is binary and so the easiest way to test this code is to tell it not to open a socket (though you must supply and address/port) and report the 3 data elements it is about to encode by running with a debug value of 9 noting this is gexpr's own internal debug switch and not collectl's.

collectl --import hello --export gexpr,192.168.1.1:1234,d=9
Name: hwtotals.hw          Units: num/sec               Val: 140
Name: hwtotals.hw          Units: num/sec               Val: 230
Name: hwtotals.hw          Units: num/sec               Val: 320

PrintPlot($type, \$line)

This type of output is formatted for plotting, which while it can get quite complicated based on whether you're writing to a terminal, multiple files or a socket, all that headache is handled by collectl. All you need to do is append your summary or detail data to the current line being constructed, similarly to the way brief data is handled. Since it has to handle both headers as well as data, there are 4 types included in the call.

PrintVerbose($printHeader, $homeFlag, \$line)

Like PrintBrief, this routine is in charge of printing verbose data but is much simpler since it doesn't have to insert code into the middle of running strings.

UpdateHeader(\$line)

Examples

Example 1 - Hello World

Included with collectl is the example file hello.ph which is a collectlized version of hello world. It simulates a hw subsystem consisting of 3 hw instances, which in turn report a single counter. Here is an example of its simulated /proc data, which is shown by using -d4. Also notice in this case the discriminator is hw but -n is also included in the calls to record() to further identify individual devices:
collectl --imp hello -d4
>>> 1238167880.003 <<<
hw-0 HelloWorld 0
hw-1 HelloWorld 10
hw-2 HelloWorld 40
You can use this example module with virtually any combinations of switches and any other collectl subsystems as well as exporting the output over a socket, writing to a raw file or playing it back. As you shoudl realize by now the combinations are far too extensive to list so below is only the simplest one, showing this data combined with cpu stats in brief format with timestamps in msecs.
collectl --imp hello -sc -oTm
#             <--------CPU--------><-Hello->
#Time         cpu sys inter  ctxsw   Total
11:40:29.002    0   0  1027    126     140
11:40:30.002    0   0  1012    138     230
For further information on using this capability see hello.ph which has been heavily annotated and should make a good staring template for developing your own custom modules.

Example 2 - Misc

This custom module reports on several variable that are not collectled as part of collectl's core metrics, partly because some of them don't exactly fit into collectl's main stats, but some users still find useful. There are also a few instructive techniques used in this simple module that are worth calling out:

The following example shows one importing both hello.ph and misc.ph while displaying cpu data and running all at the same interval:

[root@cag-dl585-02 collectl]# collectl -sc --import hello:misc
#<--------CPU--------><-Hello-><------CMU Extras----->
#cpu sys inter  ctxsw   Total   UTim  MHz MT Huge Log
   0   0  1034    149     140      94 2197  1    0   4
   0   0  1010    138     230      94 2197  1    0   4
In this example we're just doing the 2 imports, setting the misc monitoring interval to 2 and exporting the data with lexpr. As you can see, the hello data is reported every intereval but the cmu data only every other one:
[root@cag-dl585-02 collectl]# collectl --import hello:misc,i=2 --export lexpr
sample.time 1239625280.001
hwtotals.val 140
cmu.uptime 93
cmu.cpuMHz 2197
cmu.mounts 1
cmu.hugepg 0
cmu.logins 4
sample.time 1239625281.001
hwtotals.val 230
sample.time 1239625282.002
hwtotals.val 319
cmu.uptime 93
cmu.cpuMHz 2197
cmu.mounts 1
cmu.hugepg 0
cmu.logins 4
sample.time 1239625283.002
hwtotals.val 410
sample.time 1239625284.002
hwtotals.val 500
cmu.uptime 93
cmu.cpuMHz 2197
cmu.mounts 1
cmu.hugepg 0
cmu.logins 4
sample.time 1239625285.002
hwtotals.val 590