Using the Profiler Utility

The Natural Profiler is used to monitor the internal process flow of a Natural application and to analyze the performance of the application. Profiling of Natural applications is activated by switching on the ACTIVE subparameter of the PROFILER profile parameter. The Natural Profiler writes the collected Profiler event data into a Profiler resource file. See PROFILER – Profile a Natural Session in the Parameter Reference documentation.

The Profiler utility runs in batch mode only. It provides functions to control the Profiler data collection and to process the Profiler event data.

1. With the Profiler data collection functions, the data collection can be paused and restarted (see also Starting and Pausing Data Collection).

2. The data processing functions read and process the event data from the Profiler resource file. Unconsolidated event data can be consolidated.

   You can output statistics, a program summary, a program trace and an event trace with the most important data and export the resulting data in text or CSV (comma-separated values) format.

The Profiler resource file can be read by NaturalONE which displays the full event trace and provides a performance analysis (hot spots) of the Natural batch application. The event data exported can be analyzed with the Natural Profiler MashApp which visualizes the Profiler event data on an interactive MashZone dashboard.

This section covers the following topics:

• Quick Start

• Prerequisites

• Invoking and Terminating the Profiler Utility

• Syntax and Keywords

• Events and Data Collected

• Starting and Pausing Data Collection

• Consolidating Event Data

• Evaluating Event Data

• Exporting Event Data for MashZone

• Maintaining Profiler Resource Files

• Event Trace

• Internal Trace

• Profiler Statistics

Quick Start

This section briefly describes the steps required for profiling Natural applications and viewing the results. The instructions provided here may serve as a guideline when starting to use the Natural Profiler. Detailed information regarding the steps is provided in the remainder of this chapter.

The steps to take depend on the evaluation you want to perform for your application as illustrated in the following graphic:

1. Check that the prerequisites are met.

2. Activate the profiling of the Natural session by switching on the ACTIVE subparameter of the PROFILER profile parameter in the NATPARM parameter file or dynamically when invoking Natural. Example for dynamic parameter specification:

   PROFILER=(ACTIVE=ON,RESNAME=ResName,RESLIB=RESLIB)

   In the example above, the Profiler event data is written to a resource file with the name ResNam.nprf in the library RESLIB. See PROFILER – Profile a Natural Session in the Parameter Reference documentation.

3. Open the NPRF resource in NaturalONE to view the hot spots and the event trace.

4. Submit a Natural batch job with the Profiler utility READ function to print an event trace, a program trace and the Profiler statistics. Example:

   FUNCTION=READ           /* Read Profiler data
     RESOURCE-LIB=RESLIB   /* Resource library
     RESOURCE-TYPE=NPRF    /* Use resource type NPRF
     EVENT=ON              /* Print event trace
     PROGRAM=ON            /* Print program trace
     STATISTICS=ON         /* Print statistics

   See also Profiler Utility READ Function.

5. Submit a Natural batch job with the Profiler utility CONSOLIDATE function to consolidate (aggregate) the event data. Example:

   FUNCTION=CONSOLIDATE    /* Consolidate Profiler data
     RESOURCE-LIB=RESLIB   /* Resource library
     REPLACE=YES           /* Replace resource

   The consolidated Profiler event data is written to the resource ResNam.nprc in the library RESLIB. See Consolidating Event Data.

6. Open the NPRC resource in NaturalONE to view the hot spots.

7. Submit a Natural batch job with the Profiler utility READ function to generate a program summary and the Profiler statistics. Example:

   FUNCTION=READ           /* Read Profiler Data
     RESOURCE-LIB=RESLIB   /* Resource library
     RESOURCE-TYPE=NPRC    /* Use resource type NPRC
     PROGRAM=ON            /* Print program summary
     STATISTICS=ON         /* Print statistics

   See also Profiler Utility READ Function.

8. Submit a Natural batch job with the Profiler utility MASHZONE function to write the data to Work File 7 in the format expected by the Natural Profiler MashApp. Use as Work File 7 a CSV (comma-separated values) file in the Natural Profiler data directory in the MashZone environment. Example:

   FUNCTION=MASHZONE       /* Write MashZone format to Work File 7
     RESOURCE-LIB=RESLIB   /* Resource library

   See also Exporting Event Data for MashZone.

9. Enter a reference to the new file in the Overview.csv file in the resources\Profiler directory.

   Open the Natural Profiler MashApp and select the corresponding input file to evaluate the event data.

Notes:

1. If the resource name is not explicitly specified in the READ, CONSOLIDATE or MASHZONE function of the Profiler utility, the last created NPRF or NPRC resource in the library is used.
2. If you plan to profile a long-running batch application, refer to the section Profiling Long-Running Applications. It covers strategies of how to minimize the number of events to be monitored.
3. The NaturalONE Profiler is described in the NaturalONE documentation.

Prerequisites

The following prerequisite must be met before you can use the Profiler utility:

• Activate Data Processing

Activate Data Processing

If NaturalONE is installed at your site, you can activate the Profiler utility data processing functions (CONSOLIDATE, READ, MASHZONE, LIST and DELETE) with the following steps:

1. Start NaturalONE.

2. In the Natural Server view, map to the environment where the Profiler resources reside.

3. Add the program ACTIVATE contained in the system library SYSPRFLR to a new or existing project in NaturalONE.

4. Profile the program ACTIVATE with the context menu function NaturalONE > Profile.

5. Verify that the user-defined event data on the Event Trace page of the NaturalONE Profiler contains the activation success message.

When the program ACTIVATE is profiled, a NaturalONE Profiler key is generated and written to the Natural resource NaturalONEProfilerKey.nprk in the system library SYSPRFLR. Each Profiler data processing function reads this resource and checks the key. If the key is valid, the function is performed. A newly generated key is valid for one year. It can always be regenerated.

The Profiler data processing function starts issuing a warning 9 days before the key expires, and returns an error message if no key is found or if the key is not valid.

Invoking and Terminating the Profiler Utility

This section provides instructions for invoking and terminating the Profiler utility in batch mode.

To invoke the Profiler utility

• Enter the following system commands into the primary command input data set CMSYNIN:

  LOGON SYSPRFLR
  PROFILER

  Note:
  After the PROFILER system command, the Profiler expects one or more lines with Profiler keyword entries.

To terminate the Profiler utility

• Enter the following Profiler keyword into the primary command input data set CMSYNIN:

  END-PROFILER

  Or:

  END

  Or:

  .

Syntax and Keywords

The Profiler utility in batch mode reads the Profiler keywords that control the profiling from the primary command input data set CMSYNIN. The Profiler reads the input lines until it reaches the END-PROFILER keyword (or END or .).

This section covers the following topics:

• Profiler Utility Syntax

• Profiler Utility Keywords

Profiler Utility Syntax

The symbols used in the syntax diagrams shown in this section are explained in System Command Syntax in the System Commands documentation.

A profiler input line is formally described by one of the following expressions:

Or:

Notes:

1. If a value is associated with a keyword but no equal sign is found, the Profiler expects the value in a separate input line without any other keyword (2nd expression).
2. The first expression expects input in delimiter mode (IM=D).
3. The second expression can be used if the Profiler is to be executed with the profile parameter STACK or if the data is entered in forms mode (IM=F).

The following rules apply:

• Empty lines and lines starting with an asterisk (*) are ignored.

• All characters in a line from /* to */ or to the end of the line are ignored.

• Some keywords have no associated value.

• Blanks can be added before or after the keyword or value.

• Multiple keywords in a line are separated by commas (applies to the 1st expression only).

• A value can be enclosed in apostrophes ('value').

• A value must not contain a comma.

• Keywords and values can be specified in upper or lower case.

• The maximum input line length is 78 characters.

The Profiler utility can be executed multiple times in one Natural session. For example, it is first executed with the START function, and then, after the execution of a user program, it is executed with the PAUSE function.

Example

The following Natural batch example runs the Profiler utility READ function:

natural BATCHMODE CMSYNIN=cmd.txt CMOBJIN=data.txt CMPRINT=out.txt CMWRK07=wrk07.txt

The content of the batch input file cmd.txt which contains the PROFILER command is shown below:

LOGON SYSPRFLR
PROFILER
FIN

The content of the input file data.txt which contains the input for the Profiler utility is shown below:

*********************************************************************
* Read Profiler NPRF Resource                                        
*********************************************************************
TRACE=3                  /* Set Profiler trace level
FUNCTION=READ            /* Read Profiler resource
  RESOURCE-NAME='Demo01' /* Resource name   
  RESOURCE-LIB=PRFDATA   /* Resource library
  RESOURCE-TYPE=NPRF     /* Resource type   
  EVENT=ON               /* List events     
  STATISTICS=ON          /* List properties and statistics
  PROGRAM=ON             /* Program trace           
  PRINT=ON               /* Write to standard output
  EXPORT=ON              /* Write to work file 7   
  FORMAT=TEXT            /* Use text format   
END-PROFILER             /* End profiler input

After execution, out.txt contains the Profiler utility output and the internal trace (TRACE=3). wrk07.txt contains the Profiler utility output in text format (FORMAT=TEXT).

The following Natural example demonstrates how the Profiler utility PAUSE function is to be executed with the STACK profile parameter:

natural PROFILER=(ACTIVE=ON,RESNAME=ResName,RESLIB=RESLIB)
STACK=(
LOGON SYSPRFLR;PROFILER FUNCTION:PAUSE:END-PROFILER;
LOGON PRFDEMO
)

After execution, profiling of the Natural session is activated but the data collection is paused. The data collection can be started later with the Profiler utility START function.

Profiler Utility Keywords

The main keywords used in the syntax of the Profiler utility in batch mode are described in the following table. Any additional (subordinate) keywords available for a main keyword are described in the sections referenced in the table. A subordinate keyword value must follow the main keyword value, for example:

FUNCTION=READ
  PRINT=ON

The following main keywords are available:

Events and Data Collected

This section describes the events and data processed by the Profiler utility.

• Events

• Data Collected

Events

During a Natural session, different types of events can occur (for example, a program start) where the Profiler collects data specific to the event in a trace record. Each event is associated with an event type, that is, a one or two letter code. Related event types are combined into an event group which is denoted by a one letter code.

The following events, event types and event groups are available:

With each collected event, a CPU and an event timestamp are recorded. In general, a timestamp is taken at the beginning of an event. The duration of an event therefore equals the time that elapses between the timestamp of the event and the timestamp of the event that follows.

Note:
The Natural Profiler for UNIX and Windows does not yet collect RPC-related events.

Data Collected

This section describes the data collected by the Natural Profiler:

General Data

The following data elements are collected at every event:

• Event counter

• Event type

• Event time in units of microseconds

• Session CPU time in units of microseconds

• Trace session ID

• Natural Security user group ID

• Natural user ID

• Natural application name

• Program library

• Program name

• Program level

• Copycode library

• Copycode name

• Statement line number

• Statement op-code

Event-Specific Data

The following data is only collected at the following events:

Event	Data Elements
Session Initialization	None
Session Termination	Termination return code Natural termination message code NAT99nn Name of back-end program Monitor CPU time in units of microseconds
Program Load	Name of program to be loaded Name of load library Invocation type
Program Resume	None
Program Start/Termination	Program type Database ID of program library File number of program library
Database Call	Database type Command code Command ID Database ID File number Response code (event type DA) Error subcode (event type DA) Adabas command time (event type DA)
Terminal I/O	Number of bytes sent Number of bytes read Total session storage allocated Compressed session storage length
External Program Call	Name of program called Calling mode such as dynamic or static mode Program link location Parameter type such as reference or value Response code (event type CA)
Runtime Error	Natural system error message code External abend code Name of error handling program
Natural Statement	None
Start of RPC Request Execution	Environment (C = client, S = server) Subprogram name Adabas user ID (ETID) Conversation status Logon indicator (Y = logon performed) Impersonation indicator of RPC request (Y = impersonation performed)
Outbound/Inbound RPC Message / RPC Wait for Client	Environment (C = client, S = server) Transport protocol RPC function Type of client user ID Length of message RPC return code External conversation ID Client user ID Server node (event types RO and RW) Server name (event types RO and RW)
User-Defined Event	Subtype of the user-defined event Up to 249 bytes of user-defined information
Monitor Pause	Type of monitor pause Possible values:
	R	Monitor pause requested. This value is also set when the session is initialized with the Pause option.
	F	Start of a block of filtered-out events. Block filters are: library, program, line, FNAT, event count, or time filter.
	W	Trace session waits because of a data pool full situation.

Starting and Pausing Data Collection

When a Natural session is profiled, all event data of the session is collected by default.

You can start and pause data collection with the following methods:

• Using Profiler Utility Functions

• Using Profiler Utility Programs

• Using the Application Programming Interface

Using Profiler Utility Functions

The Profiler utility START and PAUSE functions are used to start and pause data collection. The following syntax applies:

Syntax Description:

Using Profiler Utility Programs

The following Natural programs in the system library SYSPRFLR are supplied to perform Profiler utility functions:

To use Profiler utility programs

• Logon to the library SYSPRFLR or copy the programs to the library SYSTEM, to the appropriate steplib library, or to the required library.

  If PRFFCT is used, the application programming interface USR8210N has to be copied as well (see the following section).

  If PRFFCT is used in a client/server environment, copy PRFFCT to the client library and USR8210N to the server library.

  Note:
  PRFFCT expects as input the value START, PAUSE or STATE to perform the corresponding function.

To start the data collection

• Execute the following program:

  PRFSTART

  Or:

  PRFFCT
  START

To pause the data collection

• Execute the following program:

  PRFPAUSE

  Or:

  PRFFCT
  PAUSE

To retrieve the current state of the data collection

• Execute the following program:

  PRFSTATE

  Or:

  PRFFCT
  STATE

Using the Application Programming Interface

The data collection can be started and paused from the profiled Natural application by calling the application programming interface (API) USR8210N. The API can also be used to get the current state of the monitoring process. The API is delivered in the SYSEXT library. For more information, see SYSEXT Utility - Natural Application Programming Interfaces.

To use the API

• Copy the subprogram USR8210N to the library SYSTEM, to the appropriate steplib library, or to the required library.

  Note:
  USR8210N expects as the first parameter the value START, PAUSE or STATE to perform the corresponding function. The parameter values can be specified in uppercase or lowercase. On return, P-RETURN contains the return code and P-MESSAGE the success or error message.

To start the data collection

• Use the interface with the CALLNAT statement:

  CALLNAT 'USR8210N' 'START' P-RETURN P-MESSAGE /* Start Profiler

To pause the data collection

• Use the interface with the CALLNAT statement:

  CALLNAT 'USR8210N' 'PAUSE' P-RETURN P-MESSAGE /* Pause Profiler

To retrieve the current state of the data collection

• Use the interface with the CALLNAT statement:

  CALLNAT 'USR8210N' 'STATE' P-RETURN P-MESSAGE /* Get Profiler state

  The state is coded in the field P-RETURN:

  P-RETURN	Description
  0	Natural Profiler data collection is started.
  1	Natural Profiler data collection is paused.

Consolidating Event Data

The Profiler utility CONSOLIDATE function consolidates event data.

For general information regarding data consolidation, see Data Consolidation in the section Basic Concepts of the Profiler Utility.

Syntax of CONSOLIDATE:

Syntax Description:

Example of a Consolidation

The following example consolidates the Profiler resource Test.nprf in the library PRFDATA and writes the consolidated data to the Profiler resource Test.nprc. I/O and Natural RPC client times are included in the consolidated data.

In addition, the consolidated data is written in CSV (semicolon-separated values) format to Work File 7.

The event and consolidation traces are switched off.

FUNCTION=CONSOLIDATE    /* Consolidate Profiler data
  RESOURCE=ON           /* Write to resource
  RESOURCE-NAME='Test'  /* Resource name
  RESOURCE-LIB=PRFDATA  /* Resource library
  REPLACE=YES           /* Replace resource
  IO-TIME=ON            /* Include I/O and RPC client times
  EXPORT=ON             /* Write to Work File 7       
  FORMAT=S              /* CSV format with semicolon separator 
  TRACE-EVENT=OFF       /* No event trace
  TRACE-CONSOLIDATE=OFF /* No consolidation trace

Evaluating Event Data

When a Natural application is profiled, the Natural Profiler utility writes the event data to an NPRF resource file. Consolidated data is stored in an NPRC resource file. The Profiler utility READ function reads and evaluates the Profiler resource data and writes the results to standard output or to a Natural work file. The evaluations performed depend on the type of the resource file read as described in the following table:

This section covers the following topics:

• Profiler Utility READ Function

• Example of READ

• Event Trace

• Consolidation Trace

• Program Trace

• Program Summary

• Statistics

Profiler Utility READ Function

The Profiler utility READ function reads and evaluates the resource data.

Syntax of READ:

Syntax Description:

Example of READ

The following example reads the Natural Profiler resource Test.nprf in the library PRFDATA and writes the event trace, program trace and the Profiler statistics to standard output and to Work File 7 in text format.

FUNCTION=READ           /* Read Profiler Data
  RESOURCE-NAME='Test'  /* Resource name
  RESOURCE-LIB=PRFDATA  /* Resource library
  RESOURCE-TYPE=NPRF    /* Use resource type NPRF
  EVENT=ON              /* Print event trace
  PROGRAM=ON            /* Print program trace
  STATISTICS=ON         /* Print statistics
  PRINT=ON              /* Write to standard output
  EXPORT=ON             /* Write to Work File 7
  FORMAT=TEXT           /* Export in text format

Event Trace

If EVENT=ON is specified for an NPRF resource file, the Profiler event trace is generated.

The event trace shows the data of each Natural event which occurred while the application executed. The trace can be referenced if detailed information of an event is required. For example, if a Natural error occurred during application execution, the event trace shows the corresponding error number and message.

If the event trace is written to standard output (PRINT=ON) or exported in text format (EXPORT=ON, FORMAT=TEXT), it is similar to the event trace written by the Profiler monitor session while the application was profiled (see Event Trace. If the data is exported in CSV format, it contains all data fields provided by the Profiler (see Data Collected).

Example of an Event Trace

The following example shows an extract of an event trace:

Natural Profiler Event Trace ---------------------------- Count Time CPU-Time (ms) Ev Lev Library Program Line CC-Lib CC-Name Statement Local-Data 0 10:20:58.219911 63.318 MP 003 SYSPRFD PRBINIT 8350 Call Monitor pause requested 102 10:20:58.277586 76.106 PL 000 0000 Execute SYSEDMD/MENU 103 10:20:58.277591 76.139 PS 001 SYSEDMD MENU 0000 PgmStart 00010/02430 Type: P 103 10:20:58.277594 76.151 NS 001 SYSEDMD MENU 0250 Compute Assign/Compute/Move 103 10:20:58.277596 76.155 NS 001 SYSEDMD MENU 0270 Fetch Fetch 104 10:20:58.277598 76.169 DB 001 SYSEDMD MENU 0270 Fetch 00010/02430 S1 ...

Explanations:

• The Count column shows the number of the event.

• The Time and CPU-Time columns show the event time and the CPU timestamp of the event execution, respectively.

• The event with the number 104 is a Database Before (DB) event caused by an Adabas S1 command issued against the file 00010/02430 which was triggered by a FETCH statement in the line 0270 of the Natural object MENU.

For further explanations of the trace columns and event types, see the sections Event Trace and Events and Data Collected.

Consolidation Trace

If EVENT=ON is specified for an NPRC resource file, the Natural Profiler consolidation trace is generated. The consolidation trace is also generated if TRACE-CONSOLIDATE=ON is set for the Profiler utility CONSOLIDATE function.

The consolidation trace shows general event data, summarized values of the elapsed time and CPU time and the hit count of the consolidated record. If two trace entries show the same general event data, they have different event-specific data which is not displayed in the consolidation trace.

The consolidated records are used as the basis for further evaluations like the NaturalONE hot spots or the Natural Profiler MashApp. The consolidation trace can be used to validate the consolidated data.

If the consolidation trace is written to standard output (PRINT=ON), it is similar to the consolidation trace written by the Profiler data consolidation (see Consolidating Event Data. If the data is exported, it contains all consolidated data fields provided by the Profiler.

Example of a Consolidation Trace

The following example shows an extract of a consolidation trace:

Natural Profiler Consolidation Trace ------------------------------------ Count Ev User Lev Library Program Line CC-Lib CC-Name Statement Hit-Count Elapsed(ms) CPU(ms) 1 PL PRF 000 0000 1 0.751 0.752 2 PR PRF 000 0000 1 0.549 0.534 3 SI PRF 000 0000 1 30.916 25.599 4 ST PRF 000 0000 1 0.000 0.000 5 NS PRF 002 PRFDEMO XINT 0140 Reset 1 0.002 0.003 6 NS PRF 002 PRFDEMO XINT 0150 Assign/com 1 0.002 0.001 7 NS PRF 002 PRFDEMO XINT 0160 Assign/com 1 0.000 0.000 8 NS PRF 002 PRFDEMO XINT 0170 For 31 0.027 0.026 ...

Explanations:

• The Count column shows the number of the consolidated record.

• The consolidated record 8 shows that the FOR statement in the line 0170 of the Natural object XINT executed 31 times spending a total elapsed time of 0.027 milliseconds (ms) and a total CPU time of 0.026 ms.

For further explanations of the trace columns and event types, see the sections Event Trace and Events and Data Collected.

Program Trace

If PROGRAM=ON is specified for an NPRF resource file, the Profiler program trace is generated. The program trace shows the program flow of the profiled application. In general, the program trace exclusively shows program and session events (see Events and Data Collected for a list of possible event types).

If the program trace is written to standard output (PRINT=ON) or exported in text format (EXPORT=ON, FORMAT=TEXT), the program names are indented (see the example below) according to the program level to provide a quick overview of the application calling structure.

If the data is exported in CSV format, the program names are not intended. In addition to the output in text format, the exported data contains the CPU timestamp and the summarized Adabas time.

Example of a Program Trace

The following example shows an extract of a program trace and the totals of the application run:

Natural Profiler Program Trace ------------------------------ Time Ev Library CC-Name Line Lev Program Events 10:20:58.309812 PL 0000 000 10:20:58.309817 PS SYSEDMD 0000 001 .OPTTEST D=4 N=2 10:20:58.357694 PL SYSEDMD 5620 001 .OPTTEST 10:20:58.357704 PS SYSEDMD 0000 002 ..CALLMON3 N=3 10:20:58.385263 PL SYSEDMD 0980 002 ..CALLMON3 10:20:58.385274 PS SYSEDMD 0000 003 ...OP3DISC D=3 N=4 10:20:58.412207 PL SYSEDMD 1670 003 ...OP3DISC 10:20:58.412221 PS SYSEDMD 0000 004 ....OPTINFO N=57 10:20:58.443203 PL SYSEDMD 5830 004 ....OPTINFO 10:20:58.443210 PS SYSEDMD 0000 005 ....:OPTPARM1 D=3 N=19 10:20:58.449549 PL SYSEDMD 1960 005 ....:OPTPARM1 10:20:58.449555 PS SYSEDMD 0000 006 ....:.OPTPARM2 D=3 N=10 10:20:58.458286 PL SYSEDMD 0560 006 ....:.OPTPARM2 10:20:58.458300 PS SYSEDMD 0000 007 ....:..OPTPARM3 N=16 10:20:58.458390 PL SYSEDMD 1530 007 ....:..OPTPARM3 10:20:58.458408 PS SYSLIBS 0000 008 ....:...NAT41004 D=10 C=6 N=7345 10:20:58.471017 PT SYSLIBS 5235 008 ....:...NAT41004 10:20:58.471017 PR SYSEDMD 1530 007 ....:..OPTPARM3 N=2898 10:20:58.473293 PL SYSEDMD 1530 007 ....:..OPTPARM3 10:20:58.473297 PS SYSLIBS 0000 008 ....:...NAT41004 D=5 C=6 N=1416 10:20:58.475581 PT SYSLIBS 5235 008 ....:...NAT41004 10:20:58.475581 PR SYSEDMD 1530 007 ....:..OPTPARM3 N=466 10:20:58.475957 PT SYSEDMD 2190 007 ....:..OPTPARM3 10:20:58.475957 PR SYSEDMD 0560 006 ....:.OPTPARM2 N=283 10:20:58.476187 PT SYSEDMD 0860 006 ....:.OPTPARM2 10:20:58.476187 PR SYSEDMD 1960 005 ....:OPTPARM1 N=42 10:20:58.476222 PT SYSEDMD 7510 005 ....:OPTPARM1 10:20:58.476222 PR SYSEDMD 5830 004 ....OPTINFO D=3 N=10 10:20:58.497926 PL SYSEDMD 6080 004 ....OPTINFO 10:20:58.521954 PR SYSEDMD 1670 003 ...OP3DISC N=241 10:21:11.205102 PR SYSEDMD 0980 002 ..CALLMON3 D=7 N=6070 10:21:41.704996 PR SYSEDMD 5620 001 .OPTTEST D=8 I=3 N=26 10:21:41.731229 PT SYSEDMD 7370 001 .OPTTEST 10:21:41.731229 PR 0000 000 D=14 I=1 10:21:42.248348 ST 0000 000 Totals ------ Ev Event Count S Session ................ 1 P Program ................ 5297 D Database Call .......... 2140 I Terminal I/O ........... 12 C External Program Call .. 6510 E Runtime Error .......... 43 N Natural Statement ...... 857384 R RPC Request............. 0 U User-Defined Event ..... 0 M Monitor Pause .......... 2

Explanations:

• For each event listed, the time when the event occurred, the active library, program (Natural object), copycode, line number and program level is displayed.

• The program name is followed by the number of events that occurred from one program event to the next program event.

• Events which belong to one event group are combined into one count using the maximum count of the corresponding event types. Example: One Database Before (DB) and one Database After (DA) event are combined into one Database event (D=1).

• In the example above, the Natural object OPTTEST was started at the level 1. This program calls the subprogram CALLMON3 which calls further subprograms. The highest Level 8 is reached when the subprogram NAT41004 executes. During the first execution, this subprogram performs 10 database calls (D=10), 6 external program calls (C=6) and 7345 Natural statements (N=7345).

• The Totals section at the end of the program trace, shows the maximum count of each event group. For example: a total of 2140 database calls corresponds to 2140 Database Before (DB) and 2140 Database After (DA) events.

• The totals of the Session (S) and Program (P) event groups are only listed under Totals; they are not listed next to the program name.

For further explanations of the trace columns, see the section Event Trace.

For explanations of event types and associated event groups, see the section Events.

Program Summary

If PROGRAM=ON is specified for an NPRC resource file, the Profiler program summary is generated.

The program summary shows for each Natural object how many Natural events have occurred, the total CPU time (in units of milliseconds) and the percentage of the CPU time spent by the Natural object with respect to the total CPU time.

Monitor Pause events and events at Level 0 are not taken into account for the program summary. Events which belong to one event group are combined into one count: see Events.

Program starts and load requests are listed separately.

If the data is exported in CSV format, the count of each event type is listed. Additionally, the elapsed time and the Adabas times (absolute and percentage values) are displayed. The exported time values are indicated in units of µs (microseconds).

Example of a Program Summary

The following example shows an extract of a program summary:

Natural Profiler Program Summary -------------------------------- Library Program Start Load Database I/O External Error Statement User CPU-Time (ms) CPU % SYSEDMD ADA-CL 41 0 40 0 41 0 621 0 3.785 0.14 SYSEDMD ADA-RC 45 0 44 0 45 0 545 0 4.704 0.17 SYSEDMD AOS-CL 115 97 15 0 0 0 2507 0 42.890 1.63 SYSEDMD AOS-OP 169 154 22 0 0 0 6975 0 70.286 2.68 SYSEDMD BYTE 1 0 0 0 0 0 11 0 0.034 0.00 SYSEDMD CALLMON3 1 5 23 0 0 0 7089 0 20.001 0.76 SYSEDMD CALLNOM 6 6 19 0 0 0 18 0 1.342 0.05 SYSEDMD CALLNOPM 2 2 4 0 0 0 16 0 0.395 0.01 SYSEDMD CALLNOPN 1 1 4 0 0 0 8 0 0.244 0.00 SYSEDMD CALLNOPS 3 4 23 0 0 1 31 0 1.841 0.07 SYSEDMD DISNOP 1 7 6 0 0 0 515 0 2.260 0.08 SYSEDMD DISNO4I 1 47 3 0 1 0 8075 0 25.516 0.97 SYSEDMD DISNO4IS 57 0 0 0 624 0 36877 0 105.650 4.03 SYSEDMD DISNRS 1 0 0 0 44 0 511 0 3.343 0.12 SYSEDMD DISNSP 1 18 15 0 0 0 1850 0 6.074 0.23 SYSEDMD DISNTMZ 1 4 11 0 0 0 324 0 2.309 0.08 SYSEDMD MENU 1 1 3 0 0 0 2 0 0.235 0.00 SYSEDMD MONACSH 1 6 6 0 0 0 1217 0 3.470 0.13 SYSEDMD MONADA 1 3176 71 0 0 0 272180 0 680.214 25.98 SYSEDMD MONAREP 1 9 28 0 0 0 1964 0 6.378 0.24 ... Total 5294 5293 2122 7 6510 43 857384 0 2617.326 100.00

Explanations:

• The Natural object MONADA consumed the most CPU time: 680.214 ms which corresponds to 25.98 percent of the total CPU time.

• MONADA was started once, it loaded 3176 other Natural objects, performed 71 database calls and 272180 Natural statements. There was no I/O, no external call and no error in the program.

• At the end of the program summary, the Total counts of the profiling are listed.

Statistics

If STATISTICS=ON is specified, the Profiler statistics are listed.

If the data is exported in CSV format, the properties and values of the Profiler statistics are added as separate columns to the event or consolidation trace.

Example of Statistics

The following example shows an extract of the statistics of an NPRC resource file:

*************************************************************************** * 17:35:59 ***** NATURAL PROFILER UTILITY ***** 2016-01-11 * User SAGTEST1 - Statistics - RESDATA ... * * Profiler Resource File * Resource name ...................... EDM-MONITOR.nprc * Resource type ...................... Natural Profiler Resource Consolidated * Resource allocation date ........... 2015-07-27 10:36:19.6 * Resource size (bytes) .............. 565160 ... * * Data Processing * Number of events ................... 895936 ... * * Data Consolidation * Consolidation ...................... ON * Consolidation records .............. 21624 * Consolidation elapsed time (sec) ... 15.643516 * Consolidation factor ............... 41.4 * Consolidation records/block ........ 191.3 * Bytes/consolidation record ......... 25.8 * ***************************************************************************

Explanations:

• The EDM-MONITOR.nprc resource was allocated on 2015-07-27 at 10:36:19 a.m. and has a size of 565160 bytes.

• The profiled application generated a total of 895936 Natural events. The data consolidation took 15.6 seconds and reduced the number of records to 21624 which corresponds to a consolidation factor of 41.4.

All statistics information provided is explained in the section Profiler Statistics.

Note:
The Natural Profiler for UNIX and Windows does not collect statistical data. The statistics provided are values determined by the Profiler utility.

Exporting Event Data for MashZone

You can visualize Profiler event data on an interactive MashZone dashboard by using the Natural Profiler MashApp.

The Profiler utility MASHZONE function reads the consolidated data of an NPRC resource file and writes the data to Work File 7 in the format expected by the Natural Profiler MashApp. Use as Work File 7 a CSV (comma-separated values) file in the Natural Profiler data directory in the MashZone environment which can be accessed by the Natural Profiler MashApp.

Syntax of MASHZONE:

Syntax Description:

Alternative Function Specifications

READ

The following Profiler utility READ function is equivalent to the MASHZONE function and generates the same export data:

FUNCTION=READ
  RESOURCE-NAME=resource-name
  RESOURCE-LIB=library-name
  RESOURCE-TYPE=NPRC
  EVENT=ON
  PROGRAM=OFF
  STATISTICS=ON
  PRINT=OFF
  EXPORT=ON
  FORMAT=SEMICOLON

CONSOLIDATE

The Natural Profiler MashApp can also process data exported with the Profiler utility CONSOLIDATE function if you specify the following keywords:

FUNCTION=CONSOLIDATE    /* Consolidate Profiler data
  EXPORT=ON             /* Write to Work File 7       
  FORMAT=SEMICOLON      /* CVS format with semicolon separator 
  ...

Example of MASHZONE

The following example reads the consolidated Profiler resource Test.nprc in the library PRFDATA. The data is written in CSV (comma-separated values) format to Work File 7 which can be accessed by MashZone.

FUNCTION=MASHZONE       /* Export Profiler data for MashZone
  RESOURCE-NAME='Test'  /* Resource name
  RESOURCE-LIB=PRFDATA  /* Resource library

Maintaining Profiler Resource Files

In general, Profiler resources are listed as NPRF or NPRC files by using the Natural SYSMAIN utility, NaturalONE or Natural Studio. These tools also provide functions to copy, rename and delete resource files.

In addition, you can use Profiler utility functions to list Profiler resource files.

This section covers the following topic:

• Listing Profiler Resource Files

Listing Profiler Resource Files

The Profiler utility LIST function lists the Profiler resource files of a given Natural library and the date and time when the resource files were allocated.

Syntax of LIST:

Syntax Description:

Example of LIST

The following example lists the NPRF Profiler resource files of library PRFDATA. The list is written to standard output and to Work File 7 in text format.

FUNCTION=LIST           /* List Profiler resource files
  RESOURCE-LIB=PRFDATA  /* Resource library
  RESOURCE-TYPE=NPRF    /* List NPRF resource files
  PRINT=ON              /* Write to standard output
  EXPORT=ON             /* Write to Work File 7
  FORMAT=TEXT           /* Export in text format

Output:

Natural Profiler Resources
--------------------------
Library: PRFDATA
Resource type: nprf
 
Count Date       Time     Name
    1 2015-06-15 14:32:18 Hello1.nprf
    2 2015-06-26 18:39:57 QDTest1.nprf
    3 2015-06-24 22:00:35 QETest1.nprf
    4 2015-06-30 14:32:42 Studio.nprf
    5 2015-07-02 15:02:32 Test.nprf
 
Number of nprf resources in library PRFDATA: 5

Event Trace

The Natural Profiler collects detailed information of each Natural event that occurs while a Natural application executes. This data can be viewed in the event trace.

The Profiler utility provides the following options to write a Profiler event trace:

• Write the trace to standard output while the data is consolidated. In this case, the event trace shows the delta values of the elapsed time and the CPU time instead of event-specific data.

• Write the trace when reading a Profiler NPRF resource file with the Profiler utility READ function.

Note:
The event trace can also be listed in NaturalONE.

To enable the event trace

• Enter the following subordinate keyword of the Profiler utility CONSOLIDATE function:

  TRACE-EVENT=ON

  Enter the following subordinate keyword of the Profiler utility READ function:

  EVENT=ON

The Profiler event trace contains the following columns:

Example of an Event Trace

In the following example, the Profiler utility READ function prints the event trace:

FUNCTION=READ               /* Read event data
  EVENT=ON                  /* Write event trace

The event trace is written to standard output:

Count Time              CPU-Time (ms) Ev Lev Library  Program  Line CC-Lib   CC-Name  Statement  Local-Data
    0 17:38:17.200951          42.324 MP 003 SYSPRFLR PRBINIT  8370                   Call       Monitor pause requested
    0 17:38:17.204508          43.471 MP 003 SYSPRFLR PRBSTART 1760                   Call       Start of block filter
   11 17:38:17.218379          48.874 DB 000                   0000                              00010/00032 S1
   12 17:38:17.218941          48.897 DA 000                   0000                              00010/00032 S1   Rsp: 0
   13 17:38:17.218944          48.910 PL 000                   0000                              Execute PRFDEMO/XPROF
   14 17:38:17.218945          48.916 PS 001 PRFDEMO  XPROF    0000                   PgmStart   00010/00032 Type: P
   15 17:38:17.218956          48.979 IB 001 PRFDEMO  XPROF    0300                   Input      Out: 133 In: 0
   16 17:38:17.219235          49.046 IA 001 PRFDEMO  XPROF    0300                   Input      Out: 133 In: 80
   17 17:38:17.219258          49.182 DB 001 PRFDEMO  XPROF    0370                   Callnat    00010/00032 S1
   18 17:38:17.220426          49.211 DA 001 PRFDEMO  XPROF    0370                   Callnat    00010/00032 S1   Rsp: 0
   19 17:38:17.220427          49.216 DB 001 PRFDEMO  XPROF    0370                   Callnat    00010/00032 S1
   ...

Internal Trace

The Profiler internal trace writes Profiler messages such as errors or warnings.

The internal trace can be activated for the following:

• The Profiler data processing functions. The data is written to standard output.

To activate the internal trace for the Profiler data processing functions

• Enter the following Profiler keyword:

  TRACE=n

  where n is the trace level (see Trace Levels).

  Notes:

  1. By default (if TRACE is not specified), Trace Level 2 (warnings) is used.
  2. The trace is activated as soon as the TRACE keyword is specified. It is therefore recommended to specify the TRACE keyword as soon as possible.
  3. If you execute the Profiler utility multiple times in the job, you need to specify the TRACE keyword with each execution.

Trace Levels

The trace levels used by the Profiler trace and monitor sessions and by the Profiler data processing functions are listed in the following table. In general, a higher trace level also contains the information of the lower trace levels. For example, if you select Trace Level 3 (statistics), error messages and warnings are also logged.

We recommend that you use at least Trace Level 2 (warnings) so that error messages and warnings are logged.

Example

In the following example, the Profiler internal trace is set to 4 (function):

* Set Profiler internal trace
TRACE=4                     /* Trace level

Profiler Statistics

In addition to event data, the Profiler collects statistical data which is written to the Profiler resource file.

The Profiler utility provides the following options to write and view Profiler statistics:

• Write the statistics to standard output while the data is consolidated.

• Write the statistics when reading a Profiler NPRF or NPRC resource file with the Profiler utility READ function.

• View the statistics with the Natural Profiler MashApp.

To write Profiler statistics, perform one of the following

• Enter the following keyword before you start the Profiler utility CONSOLIDATE function:

  TRACE=3

  or a higher trace level (see Trace Levels).

• Enter the following subordinate keyword of the Profiler utility READ function:

  STATISTICS=ON

The Profiler statistical data is displayed in categories combining properties of a similar type. The following categories are available:

• General Info

• Profiler Resource File

• Monitor Session

• Trace Session

• Data Processing

• Event Type Statistics

• Monitor Pause Statistics

• Data Consolidation

Note:
The properties listed in the following section are the properties provided by the Profiler in all environments. The Profiler Statistics contains only the properties that are relevant for the current run. Therefore, not all of the properties listed in the section are displayed in every case.

General Info

Display environment and Natural Profiler related information.

Profiler Resource File

Display Profiler resource file related information.

Monitor Session

Display statistics of the Profiler monitor session.

Trace Session

Display statistics of the Profiler trace session. The Profiler trace session includes also the application execution.

Data Processing

Display statistics of the data processing, compression and transfer.

The compression rate is calculated by the following formula:

Event Type Statistics

Display statistics of the event types.

Monitor Pause Statistics

Display statistics of the types of Monitor Pause events.

Data Consolidation

Display statistics of the data consolidation.

ConsolidationFactor := NumberOfEvents / ConsolidationRecords