10.2 Predefined Custom Columns

The files “basecolumn.cdf“ and “extendedcolumns.cdf” provide predefined custom columns which are very useful for analyzing log files. The columns must be activated by setting the appropriate defines in the Defines dialog. The available predefined columns are described in table Predefined custom columns.

Predefined custom columns
Columns of file basecolumn.cdf Description
FULLROW

Defines: USE_FULLROW_COLUMN=1

Source file: “basecolumn.cdf”

Description: The FULLROW column contains a full log record by combining the content of the HEADER column and the TEXT column.

UID

Defines: USE_UID_COLUMN=1

Source file: “basecolumn.cdf”

The UID column contains a unique numerical identifier for each log record.

FMT_TEXT

Defines: USE_FMT_TEXT_COLUMN=1 and FMT_TEXT_COLUMN=1,

Source file: “extendedcolumns.cdf”

The FMT_TEXT column uses as input the TEXT column. It's purpose is to improve the readability for Enter/Exit logging (see 10.2.3) of functions by indenting the text between entering and exiting a function, e.g. the column TEXT displays:

Enter FunctionXYZ()

This is log statement 1.

This is log statement 2.

Exit FunctionXYZ()

whereas the column FMT_TEXT displays:

Enter FunctionXYZ()

This is log statement 1.

This is log statement 2.

Exit FunctionXYZ()

PROF_FUNC

Defines: USE_PROFILING_COLUMNS=1 and USE_ISO_TIMESTAMP_COLUMN=1

Source file: “extendedcolumns.cdf”

Time in milliseconds between entering and leaving a function based on the timestamps of the log records. This is useful for investigating the performance of a program.

PROF_LINE

Defines: USE_PROFILING_COLUMNS=1 and USE_ISO_TIMESTAMP_COLUMN=1

Source file: “extendedcolumns.cdf”

Time in milliseconds between two subsequent log records based on the timestamps of the log records. This is useful for investigating the performance of a program.

By setting the define FILE_SPECIFIC_LINE_PROFILING to 1 the column PROF_LINE will display the time between two subsequent log records originating from the same file. If you set this define to any other value than 1 the file origin is not considered.

PROF_FUNC_ENTER

Defines: USE_PROFILING_COLUMNS=1, USE_ISO_TIMESTAMP_COLUMN=1 and

USE_FUNCTION_ENTER_COLUMN=1

Source file: “extendedcolumns.cdf”

When in a log record (row) one of the “enter function”-keywords is detected this column will contain the name of the function in this row.

PROF_FUNC_EXIT

Defines: USE_PROFILING_COLUMNS=1,

USE_ISO_TIMESTAMP_COLUMN=1 and

USE_FUNCTION_EXIT_COLUMN=1

Source file: “extendedcolumns.cdf”

When in a log record (row) one of the “exit function”-keywords is detected this column will contain the name of the function in this row.

PROF_FUNC_ENTER_EXIT

Defines: USE_PROFILING_COLUMNS=1,

USE_ISO_TIMESTAMP_COLUMN=1 and

USE_FUNCTION_ENTER_EXIT_COLUMN=1

Source file: “extendedcolumns.cdf”

When in a log record (row) one of the “enter function” or “exit function”-keywords is detected this column will contain the name of the function in this row, e.g. FunctionXYZ in the example given for FMT_TEXT (see Table 10.2)

ISO_TIMESTAMP

Defines: USE_ISO_TIMESTAMP_COLUMN=1

Source file: “extendedcolumns.cdf”

A special timestamp format YYYY-MM-DD hh:mm:ss,mmm

is required for some features of Ascolog Insight (e.g. for creating graphs).

ISO stands for International Organization for Standardization.

If the timestamps of your log records have a different format you can convert them to this ISO timestamp. The converted timestamps will be provided in the ISO_TIMESTAMP column.

You must specify in the Options dialog in which column (category Columns, field TimestampColumn) the conversion command can find the timestamps that should be converted. You also have to specify the date format used by these timestamps (category Calculation, field SourceTimestampFormat) because Ascolog Insight cannot determine the order of year, month and day in a date (e.g. 12-09-11, is 11 or 12 the year?).