This topic applies only on the z/OS operating system.

SMF Subtype 9: Request Activity record

The purpose of the Request Activity SMF record is to record activity that is running inside the product. This record is produced whenever a server receives a request.

New feature: When you do capacity planning, you need to look at the costs that are involved in running requests and how many requests you process over a set period of time. You can use the SMF Subtype 9 record to monitor which requests are associated with which applications, how many requests you get, and how much resource each request uses. You can also use this record to identify the application involved, and the CPU time that the request consumes. Because a new record is created for each request, you can determine the number of requests that you get over a specific length of time. newfeat

After you collect these SMF records for awhile, you should be able to project your future system requirements. For example, you might look at the data that was collected for a specific application, and project what your CPU requirements will be as the number of users accessing that application increases. The data that was collected might also be useful if you are charging a third party to use this application, because the record indicates the resources that were used and who used them.

The default Subtype 9 record contains all of the information that you should need to properly monitor the performance of your Enterprise JavaBeans™ (EJB), and Web applications. You can specifically request other data, such as the formatted time stamp data, security data, or CPU usage data. However, collecting that data adds to the system overhead that is required to collect the data that populates these sections of the record.

You can activate this record through the administrative console by setting server_SMF_request_activity_enabled=1 (or server_SMF_request_activity_enabled=true).

If you do not want these records to be generated, you can set server_SMF_request_activity_enabled=0 (or server_SMF_request_activity_enabled=false), which turns off the creation of this SMF record type. This is the default value for this property.

Request activity record schema

The record header is the same for every Subtype 9 record that is created by the same controller. The following triplets section appears for every record that the controller generates.

The Request Activity record is divided into the following sections.

Platform neutral server information section

Table 1. Platform neutral server information section. This section contains information about the server that handled the request.
Offset (decimal) Offset (hexadecimal) Name Length Format Description
0 0 SM1209BG 4 binary The version of the Server information
4 4 SM1209BH 8 EBCDIC Cell short name
12 C SM1209BI 8 EBCDIC Node short name
20 14 SM1209BJ 8 EBCDIC Cluster short name
28 1C SM1209BK 8 EBCDIC Server short name
36 24 SM1209BL 4 EBCDIC Server or controller PID
40 28 SM1209BM 1 binary Product version level (the w in the format w.x.y.z)
41 29 SM1209BN 1 binary Product release level (the x in the format w.x.y.z)
42 2A SM1209BO 1 binary Part of the product modification level (the y in the format w.x.y.z)
43 2B SM1209BP 1 binary Part of the product modification level (the z in the format w.x.y.z)
44 2C * 32   Reserved

z/OS server information section

Table 2. z/OS server information section. This section contains information about the controller and servant where the request was dispatched. One of these sections in included in each record.
Offset (decimal) Offset (hexadecimal) Name Length Format Description
0 0 SM1209BQ 4 binary The version of the server information
4 4 SM1209BR 8 EBCDIC The name of the system on which the product is running (CVTSNAME)
12 C SM1209BS 8 EBCDIC The name of the sysplex on which the product is running
20 14 SM1209BT 8 EBCDIC The job name for the controller
28 1C SM1209BU 8 EBCDIC The job ID for the controller
36 24 SM1209BV 8 binary The STOKEN for the controller
44 2C SM1209BW 2 binary The ASID for the controller
46 2E * 2   Reserved for alignment
48 30 SM1209BX 20 binary The cluster UUID
68 44 SM1209BY 20 binary The server UUID
88 58 SM1209BZ 8 EBCDIC The daemon group name
96 60 SM1209CA 4 binary The hours portion of the LE GMT offset. The value is obtained from the CEEGMTO API if you are running in 31-bit mode. The field contains all zeros if the CEEGMTO API fails or is unavailable, or if you are running in 64-bit mode. The CEEGMTO API is not supported in 64-bit mode. In these situations, flag SM1209FJ is turned on to indicate that the zeros in this field are not valid GMT offsets.
100 64 SM1209CB 4 binary The minutes portion of the LE GMT offset. The value is obtained from the CEEGMTO API if you are running in 31-bit mode. The field contains all zeros if the CEEGMTO API fails or is unavailable, or if you are running in 64-bit mode. The CEEGMTO API is not supported in 64-bit mode. In these situations, flag SM1209FJ is turned on to indicate that the zeros in this field are not valid GMT offsets.
104 68 SM1209CC 8 binary The seconds portion of the LE GMT offset. The value is obtained from the CEEGMTO API if you are running in 31-bit mode. The field contains all zeros if the CEEGMTO API fails or is unavailable, or if you are running in 64-bit mode. The CEEGMTO API is not supported in 64-bit mode. In these situations, flag SM1209FJ is turned on to indicate that the zeros in this field are not valid GMT offsets.
112 70 SM1209CD 8 binary The system GMT offset. The value is obtained from the CVTLDTO API.
120 78 SM1209CE 8 EBCDIC The service level
128 80 * 28   Reserved

Platform neutral request information section

Table 3. Platform neutral request information section. This section provides request information that is not platform specific.
Offset (decimal) Offset (hexadecimal) Name Length Format Description
0 0 SM1209CF 4 binary The version of the request information
4 4 SM1209CG 4 binary The PID of the dispatch servant
8 8 SM1209CH 8 binary The ID of the dispatched task. This value is returned from pthread_self.
16 10 SM1209CI 8 binary The amount of CPU time, in microseconds, that is used by dispatch TCB
24 18 SM1209CJ 4 binary The completion minor code. A value of 0 indicates that the request successfully completed. If a value other than 0 is present, a problem occurred during processing of the request.
28 1C * 4   Reserved
32 20 SM1209CK 4 binary The type of request that was processed:

0 indicates that the request type is not known

1 indicates that the request was an IIOP request

2 indicates that the request was an HTTP request

3 indicates that the request was an HTTPS request

[sep2010] 4 indicates that the request was a MDB Plan "A" request. A Plan "A" request is an MDB request from a listener port that is listening in the controller. [sep2010]

sep2010

[sep2010] 5 indicates that the request was a MDB Plan "B" request. A Plan "B" request is an MDB request from a listener port that is listening in the servant. [sep2010]

sep2010

[sep2010] 6 indicates that the request was a MDB Plan "C" request. A Plan "C" request is an MDB request from an activation specification that is listening in the adjunct. [sep2010]

sep2010

7 indicates that the request was a SIP request

8 indicates that the request was a SIPS request

9 indicates that the request was an MBean request

10 indicates that the request was an OTS request

11 indicates that the request was an internal request

36 24 * 32   Reserved

z/OS request information section

Table 4. z/OS request information section. zIIP and zAAP enclaves are not supported on z/OS Version 1.7. Therefore, if you are running the product on z/OS Version 1.7, fields that normally contain zIIP and zAAP enclave information, contain a value of -1.
Offset (decimal) Offset (hexadecimal) Name Length Format Description
0 0 SM1209CL 4 binary The version of the request information
4 4 SM1209CM 16 S390STCKE The time that the request was received
20 14 SM1209CN 16 S390STCKE The time that the request was added to the queue
36 24 SM1209CO 16 S390STCKE The time that the request was dispatched
52 34 SM1209CP 16 S390STCKE The time that the dispatch completed
68 44 SM1209CQ 16 S390STCKE The time that the controller finished processing the request response
84 54 SM1209CR 8 EBCDIC The job name for the dispatch servant
92 5C SM1209CS 8 EBCDIC The job ID for the dispatch servant
100 64 SM1209CT 8 binary The STOKEN for the dispatch servant
108 6C SM1209CU 2 binary The ASID for the dispatch servant
110 6E * 2   Reserved for alignment
112 70 SM1209CV 4 binary The address of the dispatch TCB
116 74 SM1209CW 16 binary The TTOKEN for the dispatch TCB
132 84 SM1209CX 8 binary The amount of CPU time that was spent on non-standard CPs, such as the System z Application Assist Processor (zAAP) and z9 Integrated Information Processor (zIIP). This value is obtained from the TIMEUSED API. A value of -1 displays in this field if
  • A value cannot be obtained from the TIMEUSED service.
  • The level of z/OS on which you are running is not Version 1.9 with APAR OA20758 applied, or Version 1.10 or higher.
140 8C SM1209CY 8 binary The enclave token
148 94 SM1209CZ 32   Reserved
180 B4 SM1209DA 8 binary The enclave CPU time at the end of the dispatch of this request, as reported by the CPUTIME parameter of the IWMEQTME API. The units are in TOD format.
188 BC SM1209DB 8 binary The enclave zAAP CPU time at the end of the dispatch of this request, as reported by the ZAAPTIME parameter of the IWMEQTME API. The value is zero if the PTF for z/OS APAR OA22160 is not installed on your system.
196 C4 SM1209DC 8 binary The amount of CPU time at the end of the dispatch of this request that is spent on a regular CP that could have been run on a zAAP, but the zAAP was not available. This value is obtained from the ZAAPONCPTIME. field in the IWMEQTME macro. The value is zero if the PTF for z/OS APAR OA22160 is not installed on your system.
204 CC SM1209DD 8 binary The zIIP enclave that is on the CPU at the end of the dispatch of this request. This value is obtained from the ZIIPONCPTIME. field in the IWMEQTME macro. The value is zero if the PTF for z/OS APAR OA22160 is not installed on your system.
212 D4 SM1209DE 8 binary The zIIP Quality Time enclave that was on the CPU at the end of the dispatch of this request. This value is obtained from the ZIIPQUALTIME field in the IWMEQTME macro. The value is zero if the PTF for z/OS APAR OA22160 is not installed on your system.
220 DC SM1209DF 8 binary The eligible zIIP enclave that is on the CPU at the end of the dispatch of this request. This value is obtained from the ZIIPTIME field in the IWMEQTME macro. The value is zero if the PTF for z/OS APAR OA22160 is not installed on your system.
228 E4 SM1209DG 4 binary The zAAP normalization factor at the end of the dispatch of this request. This value is obtained from the ZAAPNFACTOR parameter of the IWMEQTME API. The value is zero if the PTF for z/OS APAR OA22160 is not installed on your system.
232 E8 SM1209DH 8 binary The amount of CPU time that was used by the enclave as reported by the CPUTIME parameter of the IWM4EDEL API
240 F0 SM1209DI 8 binary The delete zAAP CPU enclave. A value of 0 indicates that the enclave was not deleted or not normalized. This value is obtained from the ZAAPTIME field in the IWM4EDEL macro.
248 F8 SM1209DJ 4 binary The enclave delete zAAP normalization factor as reported by the ZAAPNFACTOR parameter of the IWM4EDEL API.
252 FC * 4   Reserved
256 100 SM1209DK 8 EBCDIC The enclave delete zIIP time accumulated by the enclave as reported by the ZIIPTIME parameter of the IWM4EDEL API. A value of 0 indicates that the enclave was not deleted.
264 108 SM1209DL 8 EBCDIC The enclave delete zIIP Service accumulated by the enclave as reported by the ZIIPSERVICE parameter of the IWM4EDEL API. A value of 0 indicates that the enclave was not deleted or not normalized.
272 110 SM1209DM 8 EBCDIC The enclave delete zAAP Service accumulated by the enclave as reported by the ZAAPSERVICE parameter of the IWM4EDEL API. A value of 0 indicates that the enclave was not deleted.
280 118 SM1209DN 8 EBCDIC The enclave delete CPU service accumulated by the enclave as reported by the CPUSERVICE parameter of the IWM4EDEL API. A value of 0 indicates that the enclave was not deleted.
288 120 SM1209DO 4 EBCDIC The enclave delete Response Time ratio as reported by the RESPTIME_RATIO parameter of the IWM4EDEL API. A value of 0 indicates that the enclave was not deleted.
292 124 SM1209DP 12   Reserved for alignment
304 130 SM1209DQ 73 binary The global transaction ID (GTID) value
377 179 * 3   Reserved for alignment
380 17C SM1209DR 4 binary The dispatch timeout value
384 180 SM1209DS 8 EBCDIC The transaction class, if one is being used
392 188 SM1209DT 4 binary Is either blank or contains the following flags:

SM1209DU (bit 1) - if turned on, an enclave was created by this server for this request

SM1209DV (bit 2) - if turned on, the timeout value was given to the product by an external source instead of being taken from the configuration for the server

SM1209DW (bit 3) - if turned on, the transaction class value was given to the product by an external source instead of being taken from the configuration for the server

SM1209DX (bit 4) - if turned on, this is a one way IIOP request, for which a response is not expected

SM1209DY (bit 5) - if turned on, the CPU usage section exceeded 30, which is the maximum number of sections that are allowed. Some of your data was lost.

SM1209DZ (bit 6) - if turned on, the request was queued to a specific servant region because the request had an affinity to that servant, possibly because of HTTP session affinity

SM1209FJ (bit 7) - if turned on, the GMT offsets failed to be retrieved from the CEEGMTO, API or the CEEGMTO API was not available

Bits 8 - 32 are reserved

396 18C * 32   Reserved

z/OS formatted timestamps section

This section contains the date and time information for specific events that occurred during the processing of the request. All of the times that are included in this section are expressed in the format yyyy/mm/dd hh:mm:ss.xxxxxx, where yyyy is the year, mm is the month, dd is the day, hh is the hour, mm is the minutes, ss is the seconds, and xxxxxx is the microseconds.

Including the timestamp section in the Subtype 9 record is optional. Collecting the data to update this section adds system overhead and can make these SMF records larger. Therefore, the collection of this data, by default, is turned off. When the collection of this data is turned off, the Number of records field in the triplets section, that is located at the beginning of the record contains, a zero.

Table 5. z/OS formatted timestamps section. To turn on the collection of this data, use the administrative console to specify either the server_SMF_request_activity_timestamps=1 or server_SMF_request_activity_timestamps=true SMF property.
Offset (decimal) Offset (hexadecimal) Name Length Format Description
0 0 SM1209EA 26 EBCDIC The time that the request was received
26 1A SM1209EB 26 EBCDIC The time that the request was added to the WLM queue
52 34 SM1209EC 26 EBCDIC The time that the request was dispatched in the servant
78 4E SM1209ED 26 EBCDIC The time that the dispatch completed in the servant
104 68 SM1209EE 26 EBCDIC The time that the controller finished processing the request
130 82 * 2   Reserved for alignment

Network data for HTTP, SIP, and IIOP transports section

Table 6. Network data for HTTP, SIP, and IIOP transports section. This section contains information about the origin of the request that this record describes. It is only present for protocols for which the product can obtain origin information. For example, this section does not exist for Message Driven Beans (MDBs) requests. A record contains only one instance of this section.
Offset (decimal) Offset (hexadecimal) Name Length Format Description
0 0 SM1209EF 4 binary The version of the network data
4 4 SM1209EG 8 binary The size of the request, in bytes, that was received from the client
12 C SM1209EH 8 binary The size of the response, in bytes, that is sent back to the client
20 14 SM1209EI 4 binary The target port for the request. A value of -1 indicates that local communications was used.
24 18 SM1209EJ 4 binary The length of the origin string
28 1C SM1209EK 128 EBCDIC The origin string. Following is an example of an origin string: ip addr=9.57.7.193 port=1344. The bytes that follow the string contain blank spaces.
156 9C * 32   Reserved

Classification data section

Table 7. Classification data section. This section contains the classification information for this request. If a transaction class was encountered earlier, this information might have been used to determine that transaction class name.
Offset (decimal) Offset (hexadecimal) Name Length Format Description
0 0 SM1209EL 4 binary The version of the classification data
4 4 SM1209EM 4 binary The data type. Not all of these data types apply to all requests. For example, only data types 6, 7, or 8 appear in this field for an HTTP request.

1 indicates that it is the name of an application

2 indicates that it is the name of a module

3 indicates that it is the name of a component

4 indicates that it is the name of a class

5 indicates that it is the name of a method

6 indicates that it is a URI

7 indicates that it is the name of the target host

8 indicates that it is the name of the target port

9 indicates that it is a message listener port

10 indicates that it is the name of a selector

8 8 SM1209EN 4 binary The length of the data
12 C SM1209EO 128 EBCDIC The data string

Security data section

This section contains the security information for each request. There is a separate security data section for each identity type. Depending on your security configuration, up to three identity types might exist. Therefore, there can be up to three instances of this section in a record, depending on which data is available for the request, for which the report is generated.

Including the security sections in the Subtype 9 record is optional. Collecting the data to update this section adds system overhead and can make these SMF records larger. Therefore, the collection of this data, by default, is turned off. When the collection of this data is turned off, the Number of records field in the triplets section at the top of the record contains a zero.

Table 8. Security data section. To turn on the collection of this data, use the administrative console to specify either the server_SMF_request_activity_security=1 or server_SMF_request_activity_security=true SMF property.
Offset (decimal) Offset (hexadecimal) Name Length Format Description
0 0 SM1209EP 4 binary The version of the security data
[sep2010] 4 [sep2010]
sep2010
[sep2010] 4 [sep2010]
sep2010
[sep2010] SM1209EQ [sep2010]
sep2010
[sep2010] 4 [sep2010]
sep2010
[sep2010] binary [sep2010]
sep2010
[sep2010] The data type:

1 indicates that it is the server identity

2 indicates that it is the received identity

3 indicates that it is the invocation identity

[sep2010]
sep2010
8 8 SM1209ER 4 binary The length of the identity
12 C SM1209ES 64 EBCDIC The identity string

CPU usage breakdown section

This section contains information about an item that was called and the CPU time that the task consumed, minus the time that the CPU spent waiting for tasks it initiated to complete. This calculation is different from the way CPU time is calculated in the container records.

There can be up to 30 instances of this section in a record; one for each item that is called. If your application calls more than 30 different items under the dispatch of a single request, only the first 30 items are included. Bit 5 of field SM1209DT indicates when such a truncation occurs.

Including the CPU usage section in the Subtype 9 record is optional. Collecting the data to update this section adds system overhead and can make these SMF records quite large. Therefore, the collection of this data, by default, is turned off. When the collection of this data is turned off or none were collected during a request, the field for the number of CPU usage break down sections (SM1209AB) in the triplet at the top of the record contains a zero.

Table 9. CPU usage breakdown section. To turn on the collection of this data, use the administrative console to specify either the server_SMF_request_activity_CPU_detail=1 or server_SMF_request_activity_CPU_detail=true SMF property.
Offset (decimal) Offset (hexadecimal) Name Length Format Description
0 0 SM1209ET 4 binary The version of the CPU usage data
4 4 SM1209EU 4 binary The data type:

1 indicates that the data comes from the EJB container

2 indicates that the data comes from the Web container

8 8 SM1209EV 8 binary The amount of CPU time, in microseconds, that the item, such as an EJB or a servlet, spent in dispatch
16 10 SM1209FI 8 binary The elapsed time, in microseconds, that is spent processing the item, such as an EJB or servlet
24 18 SM1209EW 4 binary How many times the item, such as an EJB or a servlet, was executed during the dispatch of this request
28 1C SM1209EX 4 binary The length of string 1
32 20 SM1209EY 256 EBCDIC String 1. String 1 has one of the following values:

AMC, which indicates that an EJB was processed

Web App, which indicates that a Servlet was processed

288 120 SM1209EZ 4 binary The length of string 2
292 124 SM1209FA 256 EBCDIC String 2 has one of the following values:

The method name or signature, if an EJB is accessing the data

The name of the servlet if a servlet is accessing the data

User data section

You can use the package com.ibm.websphere.smf API to add up to 5 User data sections to the end of this record. Each of these sections must be less than or equal to 2 KB in length. The data that is contained in these sections is not formatted and appears exactly as it is received from your application.

Table 10. User data section. The SMF 120 Subtype 9 record can be turned on and off dynamically. Use the SmfEventNotifier API, if you want to be notified when the product starts and stops writing this record.
Offset (decimal) Offset (hexadecimal) Name Length Format Description
0 0 SM1209FE 4 binary The version of the User data section
4 4 SM1209FF 4 binary The user data type. Types 65535 and lower are reserved for IBM® use.
8 8 SM1209FG 4 binary The length of the User data section
12 C SM1209FH 2048 binary The data that the application added



Related concepts
Messaging flow for ASF message-driven beans with WebSphere MQ as the messaging provider
Messaging flow for JCA message-driven beans with service integration as the messaging provider
Messaging flow for JCA message-driven beans with WebSphere MQ as the messaging provider
Related tasks
Collecting job-related information with the System Management Facility (SMF)
Related reference
Triplets
Header/self-defining section
SMF Subtype 1: Server activity record
SMF Subtype 3: Server interval record
SMF Subtype 5: J2EE container activity record (Version 2)
SMF Subtype 6: J2EE container interval record (Version 2)
SMF Subtype 7: WebContainer activity record (Version 2)
SMF Subtype 8: WebContainer interval record (Version 2)
Record environment and mapping
Related information
MVS System Management Facilities (SMF)
Reference topic    

Terms of Use | Feedback

Last updated: Oct 21, 2010 7:37:48 AM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=v701sca&product=was-nd-mp&topic=rtrb_SMFsubtype9
File name: rtrb_SMFsubtype9.html