Viewing HSF Information as a .csv File

Restriction: This topic applies only when the Enterprise Server feature is enabled.

If you have enabled the collection and writing of HSF records to disk, details of individual transaction runs are written to comma-separated-values files, one HSF record per line.

These files are named cashsf-a.csv and cashsf-b.csv, and are located in the system directory. One of these file is the active file at any one time, and once the active file is full, or when you click the Switch button in the HSF Data section of the ESMAC Control page, records are written to the alternate file, until the maximum file size is reached or the Switch button is clicked again.

The .csv files produced in this version of the product have the following header, and contain the following fields:

#HSFVer=03;Custom=xx;CicsFiles=xx;TSQ=xx;TDQ=xx
Type,PID,Task,Date,Time,Tran/Job,User/DDName/CC,LU/Step,Prog/DSName,Latent/ReadCount,Resp/WriteCount,
API/RewriteCount,SQL/DeleteCount,IMS/DSDeleteCount,DSType,DSAccessType,Custom01,File01,Count01,Time01,TS01,Count01,Time01,TD01,Count1,Time1

The number of Custom, File, TS and TD fields correspond to the xx values in the header, which are set according to the ES_HSF_CFG environment variable.

When setting the variable, values must be set within a permissible range, otherwise the default value is used for that field. Also, if the field name is not explicitly set within the variable, its default value is used. The ranges and defaults are:

Field name	Range	Default
CUSTOM	0-5	0
CICSF	0-20	5
TSQ	0-20	5
TDQ	0-20	5

For example: ES_HSF_CFG=CUSTOM=2;CICSF=10;TSQ=32 generates 2 custom fields, 10 CICS file fields, 5 TSQ fields and 5 TDQ fields.

Important: HSF output from earlier versions of the product may either have no header, or start with:

#HSFVer=01 or 02

Some earlier .csv files (#HSFVer=01) do not have the DSType and DSAccessType fields, and either have this header:

#HSFVer=01
Type,PID,Task,Date,Time,Tran,User,LU,Prog,Latent,Resp,API,SQL,IMS,File1,Count1,Time1,File2,Count2,Time2,
File3,Count3,Time3,File4,Count4,Time4,File5,Count5,Time5,TS1,Count1,Time1,TS2,Count2,Time2,TS3,Count3,
Time3,TS4,Count4,Time4,TS5,Count5,Time5

or, without the IMS field:

Type,PID,Task,Date,Time,Tran,User,LU,Prog,Latent,Resp,API,SQL,File1,Count1,Time1,File2,Count2,
Time2,File3,Count3,Time3,File4,Count4,Time4,File5,Count5,Time5,TS1,Count1,Time1,TS2,Count2,Time2,TS3,
Count3,Time3,TS4,Count4,Time4,TS5,Count5,Time5

Field types

Type

The type of record. One of:

WEB - for Web services

PID

Process ID of the SEP which ran the task.

Task

A unique task number.

Date

The date the task started to run, in the format yyyymmdd.

Time

The time the task started to run, in the format hhmmssttt (where ttt denotes thousandths of a second).

Tran/Job

The name of task:

For Web services, the service name.

Latent/ReadCount

The time, in milliseconds (ms), between Enterprise Server receiving the request and the task beginning to run.

Resp/WriteCount

The time, in milliseconds (ms), that the task ran for (not including latency time).

SQL/DeleteCount

The time spent, in milliseconds (ms), in SQL API (EXEC SQL statements) for this task.

CPU Time

Amount of CPU time, in milliseconds (ms), the task used¹.

Mem Usage

Amount of memory usage, in kilobytes (kB)¹.

IO Read Size

Amount of data read, in kilobytes (kB)¹.

IO Write Size

Amount of data written, in kilobytes (kB)¹.

IO Read Count

Number of read system calls¹.

IO Write Count

Number of write system calls¹.

MQ Time

Time spent, in milliseconds (ms), making MQ API calls¹.

EZASOKET Time

Time spent, in milliseconds (ms), making EZASOKET API calls¹.

DSType

This field is blank for all records

DSAccessType

This field is blank for all records

Note: ¹ These fields will only contain values if the region is configured to output them. This can be controlled by setting the environment variable ES_HSF_RTS_MONITOR to ON or OFF.

On Windows, support for these fields is not enabled by default. To enable them, set ES_HSF_RTS_MONITOR=ON

Configurable Field Types

The following additional fields may be repeated based on the value of the ES_HSF_CFG environment variable:

Customxx

Custom data written to the record via a call to ES_WRITE_CUSTOM_HSF from the user application.

Filexx

The name of a file that the transaction accessed.

Countxx: The number of times the transaction accessed this filexx.
Timexx: The time, in milliseconds (ms), the transaction spent accessing filexx.

TSxx

The name of a temporary storage queue (TSQ) that the transaction accessed.

Countxx: The number of times the transaction accessed TSxx.
Timexx: The time, in milliseconds (ms), the transaction spent accessing TSxx.

Sample content viewed in Microsoft Excel

Sample HSF information shown in Microsoft Excel