ibm performance management transaction tracking for ... · ibm performance management transaction...

IBM Performance ManagementTransaction Tracking for DataPowerVersion 8.1.2.1for AIX, Linux

Administrator's Guide

IBMBeta

NoteBefore using this information and the product it supports, read the information in “Notices” on page 51.

This edition applies to V8.1.2 Fix Pack 1 of Transaction Monitoring and to all subsequent releases and modificationsuntil otherwise indicated in new editions.

© Copyright IBM Corporation 2015, 2015.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Beta

Contents

About this publication . . . . . . .. v

Chapter 1. Updating your installation toV8.1.2 Fix Pack 1 . . . . . . . . . .. 1

Chapter 2. Scenario: Monitoring the IBMintegration stack . . . . . . . . . .. 3Monitoring the IBM integration stack . . . . .. 3Adding middleware applications to the ApplicationPerformance Dashboard . . . . . . . . .. 4Viewing results of IBM integration stack monitoring 5

Aggregate Transaction Topology . . . . . .. 6Middleware transaction details . . . . . .. 7Analyzing errors and instances . . . . . .. 8Events . . . . . . . . . . . . . .. 11

Diagnosing problems in your environment . . .. 12

Chapter 3. Configuring the DataPoweragent . . . . . . . . . . . . . .. 13Configuring transaction tracking for the DataPoweragent . . . . . . . . . . . . . . .. 18

Chapter 4. Configuring DataPowerAppliances . . . . . . . . . . . .. 19Configuring SOAP settings . . . . . . . .. 19Configuring trap event subscriptions . . . . .. 20Configuring trap and notification targets . . .. 20Setting up syslog . . . . . . . . . . .. 21Defining an SSL profile . . . . . . . . .. 22Enabling syslog . . . . . . . . . . . .. 22

Chapter 5. Dashboards . . . . . . .. 25Dashboards - Middleware . . . . . . . .. 25

Middleware Transactions Summary dashboard . 25Transactions Details dashboard . . . . . .. 26Error Analysis dashboard. . . . . . . .. 27Instance Analysis dashboard. . . . . . .. 28

Dashboards - Transaction Instance Topology . .. 28Transaction Instance Topology dashboard . .. 29

Chapter 6. Event thresholds forTransaction Monitoring. . . . . . .. 33Creating thresholds to generate events fortransaction monitoring. . . . . . . . . .. 35

Chapter 7. Time periods . . . . . .. 37

Appendix A. Attributes . . . . . . .. 39Transactions Aggregate Data. . . . . . . .. 39WRT Application Status . . . . . . . . .. 40WRT Transaction Status . . . . . . . . .. 40WRT User Sessions . . . . . . . . . . .. 42

Appendix B. Dashboard metricsreference. . . . . . . . . . . . .. 45

Appendix C. Accessibility . . . . .. 49

Notices . . . . . . . . . . . . .. 51Privacy policy considerations . . . . . . .. 52

Index . . . . . . . . . . . . . .. 55

© Copyright IBM Corp. 2015, 2015 iii

Beta

iv IBM Performance Management Transaction Tracking for DataPower: Administrator's Guide

Beta

About this publication

This guide provides information about using the DataPower® agent andTransaction Tracking in IBM Performance Management V8.1.2 Fix Pack 1 tomonitor DataPower appliances as middleware components. It describes how youinstall the fix pack, configure the DataPower agent and appliances and enable theagent for Transaction Tracking. It describes the middleware dashboards andwidgets and what they can be used for.

Intended audience

This guide is for administrators who install IBM Performance Management (OnPremises) V8.1.2 Fix Pack 1 to monitor DataPower appliances.

Use this guide together with IBM Performance Management V8.1.2 IBMKnowledge Center (http://www-03preprod.ibm.com/support/knowledgecenter/SSHLNR_8.1.2/com.ibm.pm.doc/welcome.htm) for a complete understanding ofthe following dashboard groups:v Middlewarev Transaction Instance Topology

© Copyright IBM Corp. 2015, 2015 v

Beta

http://www.ibm.com/support/knowledgecenter/SSHLNR_8.1.2/com.ibm.pm.doc/welcome.htm

http://www.ibm.com/support/knowledgecenter/SSHLNR_8.1.2/com.ibm.pm.doc/welcome.htm

vi IBM Performance Management Transaction Tracking for DataPower: Administrator's Guide

Beta

Chapter 1. Updating your installation to V8.1.2 Fix Pack 1

Update your IBM Application Performance Management V8.1.2 installation toV8.1.2 Fix Pack 1 on AIX and Linux systems so that you can monitor DataPowerappliances as middleware components.

Before you begin

The monitoring infrastructure must be installed and running before applying thepatches to update your V8.1.2 installation.

Procedure

To update your V8.1.2 installation:1. Update the Performance Server:

a. Download the IPM_DataPower_ServerPatch_8.1.2-fp1.tar package from FixCentral.

b. Extract the package.c. Ensure the Performance Server is running, and run the

IPM_DataPower_ServerPatch_8.1.2-fp1/apmpatch.sh script.d. Restart all Application Performance Management services.

2. Update the DataPower agent:a. Download and extract the appropriate package for your environment:v For AIX systems, ipm_apm_datapower_agents_aix_8.1.2-fp1.tarv For Linux systems, ipm_apm_datapower_agents_xlinux_8.1.2-fp1.tar

b. Stop all instances of the DataPower agent that you want to update.c. Run the installer and step through the installation.d. Configure the DataPower agent. For more information, see Chapter 3,

“Configuring the DataPower agent,” on page 13.e. Restart the agents.

3. Reconfigure the affected DataPower appliances. For more information, seeChapter 4, “Configuring DataPower Appliances,” on page 19.

© Copyright IBM Corp. 2015, 2015 1

Beta

2 IBM Performance Management Transaction Tracking for DataPower: Administrator's Guide

Beta

Chapter 2. Scenario: Monitoring the IBM integration stack

You can monitor the IBM integration stack to see transaction tracking informationfor the middleware products and the services they expose and troubleshoot if anyproblems arise. The IBM integration stack includes IBM MQ, IBM Integration Bus,and DataPower appliance.

Monitoring the IBM integration stackTo monitor the IBM integration stack, install the agents that are listed for eachcomponent in the order given.

Optionally, if you also want to monitor a system, install OS agents on that system.

For IBM MQ, complete the following steps:1. Install the Monitoring Agent for WebSphere MQ.

For more information, see Installing your agents.2. Configure the WebSphere® MQ agent to connect to the queue manager.

For more information, see Configuring the WebSphere MQ agent.3. Enable MQ Application Activity Trace in the queue manager.

For more information, see Configuring transaction tracking for the WebSphereMQ agent.

For IBM Integration Bus, complete the following steps:1. Install the Monitoring Agent for IBM Integration Bus.

For more information, see Installing your agents.2. Enable IBM Integration Bus for transaction tracking.

For more information, see Configuring IBM® Integration Bus for transactiontracking.

3. Configure transaction tracking for the required IBM Integration Bus agentinstances.


Beta

For more information, see Configuring transaction tracking for the IBMIntegration Bus agent.

For DataPower appliance, complete the following steps:1. Install the Monitoring Agent for DataPower.

For more information, see Installing your agents.2. Configure the DataPower agent to connect to the DataPower appliance.

For more information, see Chapter 3, “Configuring the DataPower agent,” onpage 13.

3. Enable monitoring for SOAP in the DataPower appliance.For more information, see “Configuring SOAP settings” on page 19.

4. Ensure that transaction tracking is enabled for the required DataPower agentinstances.For more information, see “Configuring transaction tracking for the DataPoweragent” on page 18.

Adding middleware applications to the Application PerformanceDashboard

Create an IBM integration stack application and add the IBM MQ, IBM IntegrationBus, and DataPower appliance instances that you want to monitor to it.

Procedure

To display the components in the IBM integration stack, complete the followingsteps in the Application Performance Dashboard:1. In the Application Performance Dashboard, click Add Application.

2. In the Edit Application window, add an application name and click Addcomponents .

3. In the Select Component window, select IBM Integration Bus.4. In the Component Editor, select the required component instances and click

Add.Any detected IBM Integration Bus instances are automatically added to this list.

5. Click Back and repeat steps 3 - 4 for WebSphere MQ and DataPowerAppliance. Continue adding IBM Integration Bus, IBM MQ, and DataPowerappliance instances until the IBM integration stack is complete.


Beta

6. Click Close, then Save to return to the Application Performance Dashboard.

Results

Tip: If the Aggregate Transaction Topology does not initially show the topologythat you expect, wait for it to refresh and check again in a few minutes. If thetopology is still not what you expect, there might be a problem with yourapplication not communicating with the expected components. Check yourenvironment.

Viewing results of IBM integration stack monitoringYou can view the results of IBM integration stack monitoring in the topologies andmiddleware pages. You can also view events generated when a transaction violatesa defined threshold.

About this task

In the topologies, you can see interactions between middleware components. Thefollowing middleware nodes are displayed in the Aggregate Transaction Topologyand Transaction Instance Topology:v IBM Integration Busv IBM MQv DataPower appliance

Hover your mouse over a node to display a Properties window which shows youinformation to explain why a node has a particular status. The status is determinedby situations; the situations that have determined a bad status are displayed.

Procedure

You can link from nodes in the topology to more details about that node:1. Right-click a node.

Chapter 2. Scenario: Monitoring the IBM integration stack 5

Beta

2. Optional: Select Go to Component page to display information about thecomponent.

3. Optional: Select Go to Transaction Summary page to display information aboutthe middleware transactions.

Tip: Select Groups > Components > middleware component in the navigatorand select a request period in the volume widget to go to the same dashboard.

Aggregate Transaction TopologyThe Aggregate Transaction Topology is displayed in the Application summarydashboard.

Aggregate Transaction topologies display IBM MQ, IBM Integration Bus andDataPower appliancenodes. Drill down from these nodes to more informationabout the middleware integration stack.


Beta

To drill down, right-click a middleware node in the Aggregate TransactionTopology and select Go to Transaction Summary page. Alternatively, selectGroups > Components > middleware component in the navigator and select arequest period in the volume widget to access the same information.

Middleware transaction detailsFrom the middleware Transactions Summary page, you can drill down tomiddleware transaction details.

To drill down to middleware transaction details:


Beta

1. In the middleware Transactions Summary page, select a monitoring interval inthe Message or Volume chart.

2. On the Middleware Transaction Summary, in the Queues, Brokers, orAppliances widget, select a queue or broker.

Analyzing errors and instancesFrom the middleware Transactions Details page, you can drill down further toinformation which helps you to analyze errors and instances and access theTransaction Instance topology.

To drill down to errors and instances for middleware components and then to theTransaction Instance Topology, on the Transaction Details page complete one of thefollowing steps:v Click Analyze Errors to display the Error Analysis page, then select an error.


Beta

v Click Analyze Requests to display the Instance Analysis page, then select aninstance.


Beta

Alternatively, in the Transaction Details page, select an error or an instance to godirectly to the Transaction Instance Topology.

Transaction instance topologies display the following middleware nodes:v Message queue managersv IBM Integration Bus brokers


Beta

v DataPower Appliances

Select a node to display its properties which explain why a node has a particularstatus.

A Transaction Gantt Chart is displayed for the selected queue or broker. The Ganttchart helps you isolate the most significant contributors to the overall responsetime of the transaction.

EventsEvents are generated for the IBM integration stack by the default TransactionTracking thresholds.

For example, the default Transaction_Time_Critical threshold has generated anevent, which is shown on the Events tab.

For more information about default events, see Chapter 6, “Event thresholds forTransaction Monitoring,” on page 33.

You can add thresholds to create more events, for example for transaction ratesslowing or falling below a certain threshold.

For more information about adding events, see “Creating thresholds to generateevents for transaction monitoring” on page 35.


Beta

Diagnosing problems in your environmentIf transaction instances for one of the components in your environment are slow orfailing, the affected component is assigned an appropriate status.

The status could be:

v Warning, the node has a yellow background and an exclamation pointsurrounded by a yellow triangle in the upper right corner

v Critical, the node has a red background and a cross that is encircledwith red in the upper right corner

To identify the cause of the problems for these components, right-click the nodeand drill down to see more information about what might be causing the failures.


Beta

Chapter 3. Configuring the DataPower agent

The DataPower agent provides a central point of monitoring for the DataPowerAppliances in your enterprise environment. You can identify and receivenotifications about common problems with the appliances. Performance, resource,and workload information about the appliances is provided.

Before you begin

Before you use the Monitoring Agent for DataPower to monitor your DataPowerappliances, you must complete some configuration steps.

If the XML Management Interface of the DataPower Appliance has the SSL ProxyProfile enabled, before you configure the DataPower agent, you must export thepublic certificate that is used by the XML Management Interface of the DataPowerAppliance. You must export the certificate to the temporary directory on theappliance, and then download it to the machine that runs the DataPower agent.

To export the public certificate from the DataPower appliances, complete thefollowing steps:1. To download the crypto certificate that is used by the XML Management

Interface of the DataPower Appliance, for example, pubcert:///mycert.pem,click Administration > Main > File Management and save the certificate to themachine that runs the DataPower agent.

2. When you configure the DataPower agent, there is an option to specify the SSLProxy Profile field. Enter the absolute path of the public certificate.

About this task

The DataPower agent is a multiple instance agent; you must create the firstinstance and start the agent manually. The Managed System Name includes theinstance name that you specify, for example, instance_name:host_name:pc, wherepc is your two character product code. The Managed System Name is limited to 32characters.

The instance name that you specify is limited to 28 characters, minus the length ofyour host name. For example, if you specify DataPower as your instance name,your managed system name is DataPower:hostname:BN.

Important: If you specify a long instance name, the Managed System name istruncated and the agent code does not display correctly.

You can configure one instance to monitor all DataPower appliances in yoursystem. You can run the configuration script to create an instance and change anyconfiguration settings. You can edit the agent silent response file before you runthe script to bypass the prompts and responses that are required.

Procedure

To configure the DataPower agent, complete one of the following procedures:v To configure the agent by responding to prompts, complete the following steps:


Beta

1. Open the install_dir directory, where install_dir is the installationdirectory for the DataPower agent.

2. To check the names and settings of the configured agent instances, run the./cinfo -s bn command.

3. To configure the DataPower monitoring agent, run the ./datapower-agent.shconfig instance_name command.Choose an instance_name that is unique on the server.

4. To edit the Monitoring Agent for DataPower settings, select one of thefollowing options:– 1=Yes

– 2=No

5. Enabling SNMP Event monitoring:

Do you want to enable SNMP Event monitoring? [ 1=Yes, 2=No ] (default is: 2):

Note: Select Yes if you want to receive SNMP events from the DataPowerappliance. For more information about configuring the trap eventsubscription and notification on the appliance, see “Configuring trap eventsubscriptions” on page 20.

6. Setting the SNMP properties for the receiving events:

Port NumberEnter the destination UDP port for SNMP Traps and Notificationsthat are generated by the local SNMP agent or engine. By default,SNMP Traps and Notifications are sent to port 162. This port must beunique across all instances of this agent. For example,KQZ_SNMPEVENT_PORT= 162.

Security LevelFrom the Security Level list, select the security level for notificationsto this recipient. The valid values include authPriv, noAuthNoPriv orauthNoPriv. For example, KQZ_SNMPEVENT_SECURITY_LEVEL= authPriv.

SNMP User NameFor SNMP User Name, enter the user name for connecting to the SNMPagent. The default is admin. For example, KQZ_SNMPEVENT_USER_NAME=admin.

SNMP authentication protocolFrom the SNMP Authentication Protocol list, select the SNMPauthentication protocol that is used to connect to the SNMP agent.The default is SHA. The valid values include SHA or MD5. Forexample, KQZ_SNMPEVENT_AUTH_PROTOCOL=SHA.

SNMP Authentication SecretFor SNMP Authentication Secret, enter the authentication passphrase for connecting to the SNMP agent. For example,KQZ_SNMPEVENT_AUTH_PASSWORD= password.

SNMP Privacy ProtocolFor SNMP Privacy Protocol, enter the privacy protocol that is used toconnect to the SNMP agent. The default is DES. For example,KQZ_SNMPEVENT_PRIV_PROTOCOL= DES.

a. If you select Authentication or Privacy as the SNMP security level, in theSNMP Privacy Secret field, enter the privacy pass phrase to connect tothe SNMP agent.


Beta

b. If you enter the privacy pass phrase as the SNMP Privacy Protocol, reenter the same privacy pass phrase in the Confirm SNMP Privacy Secretfield.

c. Press Enter.7. Enter the properties for the DataPower Appliance:

Managed System DetailsTo edit Managed System Details, enter one of the following options:– 1=Add

– 2=Edit

– 3=Del

– 4=Next

– 5=Exit

Note: The default is option 5=Exit.

Managed System Name For Managed System Name, enter the managed system name of theagent.

Choose a Managed System Name that is unique among all instances ofthe agent and that can be used to easily identify an appliance. Thename should contain only alphanumeric characters.

Device HostFor Device Host, enter the IP address of the monitored DataPowerAppliance. The default IP address is 9.123.109.139.

XML Management Interface PortFor XML Management Interface Port, enter the port number for theXML Management Interface. The default number is 5550. Forexample, DP_PORT.ManageSystemName= 5550.

User IDFor User ID, enter the User ID to log in to the monitored DataPowerAppliance. The default value is admin. For example,DP_UID.ManageSystemName= admin.

PasswordFor Password, enter the password to log in to the monitoredDataPower Appliance and then confirm the password. For example,DP_PASSWORD.ManageSystemName= password.

System LogFor System Log, type the system log file name, that is the fullyqualified file name of the monitored system log on the agentmachine.

Note: You can only use single byte characters. The system logs mustbe enabled on the DataPower appliance for this option to work. Formore information, see “Enabling syslog” on page 22.

SSL Proxy ProfileFor SSL Proxy Profile, enter the absolute path of the publiccertificate for your SSL proxy profile, if the XML managementinterface of the device is configured to use the profile. For example,DP_SSL_PROFILE.ManageSystemName= the location of the .pem file exportedfrom datapower appliances >/mycert.pem.

Chapter 3. Configuring the DataPower agent 15

Beta

SSL Proxy OptionFor SSL Proxy Option, set to Yes if the XML management interface ofthe monitored device is configured to use a custom SSL proxyprofile. Otherwise, set it to No. For example,DP_SSL_OPTION.ManageSystemName1= Yes.

8. To add the multiple DataPower appliances that you want to monitor, repeatstep 6. Otherwise, type 5 and press Enter to complete the configuration.

v Silent configuration1. To configure the agent by editing the silent response file and running the

script with no interaction, complete the following steps:– Open install_dir/samples/datapower_silent_config.txt in a text

editor.– Open install_dir/samples/datapower_silent_config.txt in a text

editor.2. To configure SNMP Events for the DataPower agent, enter the following

properties:

Port NumberEnter the Destination UDP port for SNMP Traps and Notificationsthat are generated by the local SNMP agent or engine. By default,SNMP Traps and Notifications are sent to port 162. This port must bedifferent across all instances of this agent. For example,KQZ_SNMPEVENT_PORT=162.

Security LevelEnter the name of the local SNMPv3 user to use for Notifications tothis recipient. This value determines the authentication and privacy(encryption) or protocols and keys that are used. The valid valuesinclude Authentication Privacy, No Authentication No Privacy, andAuthentication No Privacy. For example,KQZ_SNMPEVENT_SECURITY_LEVEL= authPriv.

SNMP User NameEnter the user name for connecting to the SNMP agent. The defaultvalue is admin. For example, KQZ_SNMPEVENT_USER_NAME= admin.

SNMP Authentication ProtocolEnter the authorization protocol that is used to connect to the SNMPagent. The valid values include SHA, and MD5. For example,KQZ_SNMPEVENT_AUTH_PROTOCOL=SHA.

SNMP Authentication SecretEnter the authentication pass phrase for connecting to the SNMPagent. For example, KQZ_SNMPEVENT_AUTH_PASSWORD= DES.

SNMP Privacy ProtocolEnter the privacy protocol that is used to connect to the SNMP agent.The default value is DES. For example,KQZ_SNMPEVENT_PRIV_PROTOCOL= DES.

SNMP Privacy SecretEnter the privacy pass phrase for connecting to the SNMP agent. Forexample, KQZ_SNMPEVENT_PRIV_PASSWORD= password.

3. To configure the DataPower agent to monitor an appliance, enter thefollowing properties:


Beta

Device HostEnter the host name or IP address of the device. For example,SOAP_HOST.ManageSystemName= datapower01.

XML Management Interface PortEnter the port number for the XML Management Interface. Thedefault value is 5550. For example, DP_PORT.ManageSystemName= 5550.

User IDEnter the User ID that is used to connect to the device. The defaultvalue is admin. For example, DP_UID.ManageSystemName= admin.

PasswordEnter the password of the User ID. For example,DP_PASSWORD.ManageSystemName= password.

System LogEnter the system log file name. For example,KBN_LOG_FILE.ManageSystemName= logtemp:/test_la/default-log. The filename must be fully qualified. You can also use a dynamic file name.For more information about dynamic file names, see Dynamic filename support.

SSL Proxy ProfileEnter the absolute path of the public certificate for your SSL proxyprofile, if the XML management interface of the device is configuredto use the profile. For example, DP_SSL_PROFILE.ManageSystemName=install_dir/config/mycert.pub.

SSL Proxy OptionFor SSL Proxy Option, set to Yes if the XML management interface ofthe monitored device is configured to use a custom SSL proxyprofile. Otherwise, set it to No. For example,DP_SSL_OPTION.ManageSystemName1= Yes.

Important: ManageSystemName is unique. You must replace it with your ownsystem name in all entries. If you want to monitor multiple appliances, copyand repeat the steps that are shown to monitor an appliance. Remember toset the appropriate ManageSystemName and DataPower Appliance parameters.

What to do next

To collect transaction-related data from the DataPower appliance, enabletransaction statistics for the DataPower appliance. If you don't enable transactionstatistics, the HTTP transaction and throughput widgets will show a data providererror. To enable transaction statistics:1. Log onto the monitored DataPower appliance administrative console.2. Select Status > Connection > Transaction Rate.3. Click Show all domains and ensure all domains show tables and data.4. If any domains display Statistics is currently disabled, click disabled, set the

Administrative state to enabled and click Apply.

To complete the configuration steps on the DataPower appliances, see Chapter 4,“Configuring DataPower Appliances,” on page 19.

Chapter 3. Configuring the DataPower agent 17

Beta

https://www-01.ibm.com/support/knowledgecenter/SSTFXA_6.3.0.2/com.ibm.itm.doc_6.3/builder/ab_dynamicfilename.htm

https://www-01.ibm.com/support/knowledgecenter/SSTFXA_6.3.0.2/com.ibm.itm.doc_6.3/builder/ab_dynamicfilename.htm

Configuring transaction tracking for the DataPower agentTo display transaction tracking data for DataPower appliances in the middlewareand topology dashboards, you must enable data collection for the DataPoweragent.

Before you beginv Install the DataPower agent and configure it to connect to the DataPower

appliance.v Enable monitoring for SOAP in the DataPower appliance.

Procedure

To enable Transaction tracking for the DataPower agent, complete the followingsteps:1. In the navigation bar, click System Configuration > Agent Configuration.2. On the DataPower tab, select the agent instances for which you want to enable

transaction tracking.3. Select Actions > Set Transaction Tracking > Enabled to enable transaction

tracking. The status of the agent in the Transaction Tracking column is updatedto Enabled.

Results

You have configured transaction tracking for the selected agent instances.Transaction tracking data is displayed in the middleware and topology dashboardsafter you enable the data collection. For further information, see “Addingmiddleware applications to the Application Performance Dashboard” on page 4.


Beta

Chapter 4. Configuring DataPower Appliances

Before you can use the Monitoring Agent for DataPower to monitor yourappliances, you must complete some configuration tasks on your appliances.

Table 1 contains a list of the DataPower Appliances that are supported.

Table 1. Supported DataPower Appliances

Type Name Version

B2B XB60 V3.8 and later

B2B XB62 V4.0.1

Edge XE82 V1.0

Integration XI50 V4.0 and later

Integration XI52 V4.0 and later

Low Latency XM70 V3.8 and later

XML Accelerator XA35 V3.8.2 or V4.0.1

XML Security Gateway XS40 3.8.1 and later

Important: The DataPower XC10 Appliance is not supported in PerformanceManagement on Cloud.

DataPower Virtual Appliance is supported in Performance Management V8.1.2 FixPack 1 and later.

Configuring SOAP settingsIf you want the DataPower agent to collect data from DataPower Appliances, youmust ensure that the SOAP settings are enabled.

Procedure1. Log on to the WebGUI for the DataPower Appliance that you want to monitor.2. Click Objects > Device Management > XML Management Interface.

Note: Ensure that the Administrative state is enabled.3. For Port Number, enter the port number on which the DataPower agent listens

for notification reports. The port number is 5550 by default.4. For Enabled Services, ensure that SOAP Management is selected.


Beta

Configuring trap event subscriptionsIf you want traps to be sent to the DataPower Appliance, you must complete stepsto specify which traps are sent to the agent.

Procedure1. Log on to the WebGUI for the DataPower Appliance that you want to monitor.2. Click Administration > Access > SNMP Settings.3. Click Trap Event Subscriptions.4. For Minimum Priority, select the minimum trap event priority.

Note: The priorities are hierarchical and the lowest priority is at the end of thelist. The trap events that relate to the selected priority and beyond are sent tothe agent. For example, if you select alert, trap events that relate to alert andemergency are sent to the agent. If you select debug, which is the lowestpriority, all trap events are sent to the agent.

5. For Event Subscriptions, click Add if you want to add event codes that triggertraps that are sent to the configured trap targets.

6. Click Apply.7. Click Save Config.

Configuring trap and notification targetsIf you want traps to be sent to the DataPower Appliance, you must specify trapsand notification targets.

Procedure1. Log on to the WebGUI of the DataPower Appliance that you want to monitor.2. Click Administration > Access > SNMP Settings.3. Click Trap and Notification Targets.4. Click Add.5. For Remote Host Address, enter the host name or IP address of the computer

that hosts the DataPower agent Appliance.6. For Remote Port, enter the port number on which the DataPower agent listens

for trap information.7. For Version, select the SNMP version that you want to use for trap

monitoring on the agent side.8. If you select version 1 or version 2 in step 7, for Community Name enter the

community name and then click Apply. If you select version 3 in step 7, forSecurity Name enter an SNMP V3 user ID, for Security Level select thesecurity level, and then click Apply.

9. Click Apply.10. Click Save Config.


Beta

Setting up syslogYou can set up the DataPower agent to monitor the system logs of the DataPowerAppliance.

Before you begin

If the DataPower agent is installed on a Windows operating system, you must firstinstall a system log daemon on the computer. The system log daemon collects thesystem logs or system logs files on a shared disk and ensures that the agent hasthe authority to read the system log files on that disk.

Procedure1. Log on to the WebGUI of the DataPower Appliance that you want to monitor.2. Click Administration > Miscellaneous > Manage Log Targets.3. Click Add.

a. For Name, enter the name of the log target.b. Select Enabled.c. From the Target Type list, select syslog or syslog-ng.d. In step c, if you selected syslog-ng for SSL Proxy Profile you can specify

the name of the SSL proxy profile object that defines the configuration forsecure communication. The default option is none. For more informationabout configuring SSL proxy profiles on a DataPower Appliance, see theDefining an SSL profile procedure.

e. For Local Identifier, enter a local identifier. A local identifier is a descriptivestring that identifies the log target to remote recipients.

f. For Remote Host, enter the host name or IP address of the computer thathosts the DataPower agent Appliance.

g. For Remote Port, enter a port number. The port number that is reserved forsyslog is 514. Syslog-ng has no reserved port number. You can use anyunused UDP or TCP port number.

h. From the Syslog Facility list, select the appropriate syslog facility. Syslogfacility is included in messages that are sent to the syslog log target.

4. Click Event Subscriptions.5. On the Event Subscriptions page, complete the following steps:

a. Click Add.b. From the Event Category list, select the event category that you want to

monitor.c. From the Minimum Event Priority list, select the minimum event priority.d. Click Apply.

Chapter 4. Configuring DataPower Appliances 21

Beta

Defining an SSL profileYou must define an SSL profile to describe SSL behavior. You can define the modein which the SSL Proxy functions, for example, forward, reverse, or two-way mode.

Procedure1. Select OBJECTS > Crypto > SSL Proxy Profile.2. On the Configure SSL Proxy Profile page, enter the following information:

a. For Direction, select one of the following options:v Forward specifies a mode in which the SSL Proxy functions as an SSL

client. In client mode, SSL is used over the device-to-server connection.v Reverse specifies a mode in which the SSL Proxy functions as an SSL

server. In server mode, SSL is used over the device-to-client connection.v Two-way specifies a mode in which the SSL proxy functions both as an

SSL client and as an SSL server. In two-way mode, SSL is used over boththe device-to-server connection and over the device-to-client connection.

b. For Reverse (Server) Crypto Profile, from the list, select the crypto profilethat defines the SSL service level between the device that acts as an SSLserver and the front-end SSL clients. This setting is relevant when the SSLProxy Profile operational mode is either reverse or two-way. Select thecrypto profile that defines the SSL service to front-end clients. Retain thedefault value (none) if the operational mode is forward. You can use + and... to create a new crypto profile or to edit a crypto profile.

c. For Server-side Session Caching, select On to enable server-side caching orOff to disable server-side caching. By default, SSL server implementationscache SSL session-specific state data, such as the session ID, the peercertificate, compression method, and crypto specs and secrets.

d. For Client Authentication is Optional, this property is meaningful whenthe SSL client authentication is enabled in the server cryptographic profile.When both properties are enabled, SSL client authentication is optional (asetting of yes). The request does not fail when there is no client certificate.When disabled (the default setting of no), SSL client authentication isrequired by the application server.

Enabling syslogIf you want the DataPower agent to monitor the system logs of the DataPowerAppliance, in addition to setting up the syslog on the appliance, you must alsoenable syslog on the computer that hosts the DataPower agent.

Before you begin

If the DataPower agent is installed on a Windows operating system, you must firstinstall a system log daemon on the computer to collect the system logs.Alternatively, you can save the system log files on a shared disk and ensure thatthe agent has the authority to read the system log files on that disk.

Procedure

To enable syslog, depending on the operating system that hosts the DataPoweragent, complete one of the following procedures:v On Red Hat Enterprise Linux 6, to open the syslog.conf file, run the vi

/etc/syslog.conf command.


Beta

1. Append the Syslog_fac.* /var/log/filename command to the end of thesyslog.conf file and save it. Syslog_fac is the syslog facility and file name isthe name of the file where you save the syslog.

2. To open the syslog.conf file, run the vi /etc/syslog.conf command.3. Change the value of the SYSLOGD_OPTIONS parameter to the following value:

SYSLOGD_OPTIONS = "-m 0 -r"

Note: Depending on the Linux distribution, this variable might also benamed SYSLOGD_PARAMS.

4. To restart the syslog server, run the service syslog restart command.v On SUSE Linux Enterprise Server 11, to enable syslog-ng, complete the following

steps:1. To open the syslog file, run the vi /etc/sysconfig/syslog command.2. Verify that the value of the SYSLOG_DAEMON parameter is syslog-ng.3. In the syslog-ng.conf file, append the following line to the definition of the

src source:tcp(ip("ip_address") port(port_number) keep-alive(yes));

Where ip_address is the IP address of the computer that hosts the DataPoweragent and port_number is the port number that is used for receiving syslog-ngmessages.

4. To filter messages from the DataPower appliances, in the syslog-ng.conffile, create a filter. For example, thefilter f_dp {level(debug..emerg) and facility(user);};

filter statement defines a filter that accepts messages from the debug level tothe emergency level that specify the user as the syslog facility.

5. In the syslog-ng.conf file, use a destination statement to define where themessages are written as shown in the following example:dplog {file("/var/log/dpsyslog.log");};

This destination statement specifies that messages are written to thedpsyslog.log file in the /var/log directory.

6. In the syslog-ng.conf file, use a log statement to connect sources anddestinations. For example, the{source(src);filter(f_dp);destination(dplog);};

log statement connects the src source and the dplog destination.7. Save the syslog-ng.conf file.8. To restart the syslog server, run the /etc/init.d/syslog restart command.

Chapter 4. Configuring DataPower Appliances 23

Beta


Beta

Chapter 5. Dashboards

Use the Transaction Tracking-related dashboards to understand the performanceand availability of transaction requests, applications, servers, and appliances, andwhere time is spent during a transaction instance in your environment.

Dashboards - MiddlewareThe IBM integration stack middleware dashboards may be available in yourinstallation. Use these dashboards to see transaction tracking information for themiddleware products and the services they expose and troubleshoot if anyproblems arise. The IBM integration stack includes IBM MQ, IBM Integration Bus,and DataPower appliance.

To display the middleware dashboards, select Components > middlewarecomponent in the navigator. In the Volume widget, select a monitoring interval todisplay the first of the middleware dashboards.

Middleware Transactions Summary dashboardUse the Middleware Transactions Summary dashboard to view information aboutall transactions running across all instances of the selected middleware component,either IBM MQ, IBM Integration Bus, or DataPower appliance.

Using the dashboard

View the message or transaction volume.Look at the Message or Transaction Volume chart. The number oftransactions or messages across all middleware instances are plotted foreach period, together with the number of good, or failed transactions ormessages.

View the worst performing middleware instances.The middleware instances are listed in the Queues or Transactions table.Click a middleware instance to display details of the transactions ormessage queues for that instance.

Group widgets

The Middleware Transactions Summary dashboard shows the following groupwidgets:v Message or Transaction Volumev Queues or Transactions

Metrics

Group widgetTable from which data isderived Metrics

Message or TransactionVolume

TRANSACTION AGG DATA Good requests

Slow requests

Failed requests


Beta


Queues or Transactions TRANSACTION AGG DATA Transaction

Average Response Time

Transaction Volume

Failed

Slow

Transactions Details dashboardUse the Transactions Details dashboard to view information about a specifictransaction for the selected middleware component, either IBM MQ, IBMIntegration Bus, or DataPower appliance.

Using the dashboard

View the transaction or message volume and compare the execution time withthe wait time.

Look at the transaction or message volume chart (first chart in the Messageor Transaction Request and Response Time widget). The total number ofrequests for the selected transaction or message are plotted for each period,and the failed requests are shown in red.

Look at the response time chart (second chart in the Message orTransaction Request and Response Time widget). The time taken for therequests to execute (Execution Time) is plotted against the time spentwaiting on service dependencies (Wait Time).

View details of the transaction or message and the status of the server or queue.Look at the first table in the Details widget. The average response time forthe transaction or message requests and the percentage of requests thatfailed are shown. If these values are high, investigate any errors.

Look at the second table in the Details widget. The servers or queuesinvolved in the request are listed with the percentage of failed requests.

Troubleshoot transaction or message request errorsLook at the Latest Errors table. The most recent errors for the transactionsor messages on the selected middleware instance are listed. Click AnalyzeErrors to troubleshoot the errors.

Troubleshoot latest transaction requests or messagesLook at the Latest Requests table. The most recent requests for thetransactions or messages on the selected middleware instance are listed.Select a request to display a transaction instance topology and Gantt chartfor that request. Click Analyze Requests to troubleshoot failed requests.

Group widgets

The Transactions Details dashboard shows the following group widgets:v Message or Transaction Request and Response Timev Detailsv Latest Errorsv Latest Requests


Beta

Metrics


Message or TransactionRequest and Response Time

TRANSACTION AGG DATA Good requests

Slow requests

Failed requests

Execution Time

Wait Time

Details TRANSACTION AGG DATA Response Time

Volume

Failed

Slow

Component Name

Latest Errors TransactionInstances Error Code

Error Description

Latest Requests TransactionInstances Component Name

Status

Response Time

Error Analysis dashboardUse the Error Analysis dashboard to view details about specific errors for theselected middleware component, either IBM MQ, IBM Integration Bus, orDataPower appliance as they occur over time.

Using the dashboard

View the error rate over time.Look at the Error Rate chart. If you have been experiencing problems,isolate the time period, or notice any increases in errors.

View error codes and descriptions.Look at the Error Details widget. The most recent errors in the middlewaretransaction requests are listed together with an error message and the timeat which the error occurred.

Group widgets

The Error Analysis dashboard shows the following group widgets:v Error Ratev Error Details

Metrics


Error Rate TRANSACTION AGG DATA Total

Error Details TransactionInstances Error Code

Error Message

Chapter 5. Dashboards 27

Beta

Instance Analysis dashboardUse the Instance Analysis dashboard to view details about errors in specifictransaction instances for the selected middleware transaction request, either IBMMQ, or IBM Integration Bus, as they occur over time.

Using the dashboard

View the error rate over time.Look at the Transaction Volume chart. If you have been experiencingproblems, isolate the time period, or notice any increases in errors.

View error codes and response times.Look at the Instance Details widget. The most recent errors in themiddleware transaction request are listed together with time at which theerror occurred and the impact to the response time.

Tip: Select an instance to display the Transaction Instance topology.

Group widgets

The Instance Analysis dashboard shows the following group widgets:v Transaction Volumev Instance Details

Metrics


Transaction Volume TRANSACTION AGG DATA Failed requests

Instance Details TRANSACTION AGG DATA Status

Response Time

Dashboards - Transaction Instance TopologyThe Transaction Instance Topology dashboard may be available in your installation.Use this dashboard to visualize where time is spent during a transaction instance.

Use the Transaction Instance Topology to view summary information about, and atopology for the selected transaction instance.

You can drill down to the Transaction Instance Topology through End UserTransactions, or middleware dashboards. For example, in the navigator, selectGroups > Transactions > End User Transactions. In the Transaction Summarypage, select a transaction in the Transactions - Top 10 table, and then a transactioninstance in the Transaction Instances table.


Beta

Transaction Instance Topology dashboardUse the Transaction Instance Topology dashboard to analyze a transaction instance.

Using the dashboard

View summary information for the transaction instance. Look at the Transaction Instances summary table for details about thetransaction instance.

View where time is spent during a transaction instance.Look at the Transaction Instance Topology. The topology shows eachnetwork hop and subtransaction node in the transaction instance. The timetaken for each hop is shown on the link between nodes.

View the status of each subtransaction.Look at the Transaction Instance Topology. The status for eachsubtransaction node is shown in the icon. Where a request has failed, thenode is highlighted in red, and the status shows the failure with a cross.

View information about each node.Select a node in the Transaction Instance Topology. Details about that nodeare displayed in the Node Properties, Server Status, or Transaction GanttChart widgets.

Identify the root cause of a problem for nodes that have a status of warning orfailed. In the Node properties widget, click Diagnose:

v If deep-dive diagnostics are available, and there is a matching instance,further information is displayed

v If a deep-dive does not have a matching instance, choose an instancefrom a list of other instances for the same transaction, on the sameserver instance, at a sampled time within a few minutes of the requestedinstance. Further information is displayed for this alternative instance.

v For IBM Java application stack monitoring, depending on the node youcan drill down further to application resource pages or database resourcestatus, and SQL statement diagnostic information.

Group widgets

The Transaction Instance Topology dashboard shows the following group widgets:v Transaction Instancesv Transaction Instances Topologyv Node Propertiesv Server Statusv Transaction Gantt Chart

To view group widget help, click the help icon ( ) on the group widget.

Limitations of the topology

For transactions with URLs longer than 254 characters (excluding query strings),the transaction topology will not show a node for the back-end application server,such as WebSphere Portal Server, when you drill-down from the TransactionInstances table.


Beta

Metrics


Transaction Instances Transaction Instance Status

Response Time

Source

User Agent

User Name

Node Properties Transaction Instance Transaction

Response Time

Component Name

Host Name

Server Status

Transaction Gantt Chart TXINSGANTT_STATUS Transaction

Status

Timeline

Icons and values for nodes in topologiesThe icons and values displayed for each node in the Aggregate TransactionTopology and the Transaction Instance Topology are determined by the source ofthe data for each node.

Table 2. Icons and values for nodes in topologies

Node type Value on the node Description Icon

HTTP Client BROWSER, IPAddress,or client name

Source node for browser-based clients,displayed only when automaticJavaScript injection is measuring datafrom the browser. For example, BROWSERor /daytrader/app

HTTP Server Transaction Name Nodes for HTTP based applications. Forexample,/PlantsByWebSphereAjax/index.html/

WebSphereApplicationServer node

Application name Nodes for WebSphere Application Serverbased applications. For example,/daytrader/app

Server node Servername:instance or IPaddress:port

Nodes for database servers. For example,JDBC:jdbc/Trader or 172.21.6.15:50 000


Beta

Table 2. Icons and values for nodes in topologies (continued)

Node type Value on the node Description Icon

IBM MQqueue

Message queue name Nodes for IBM MQ based middlewaretransactions

IBMIntegrationBus broker

Integration broker name Nodes for IBM Integration Bus basedmiddleware transactions

DataPowerappliance

Appliance name Nodes for DataPower Appliance basedmiddleware transactions

ServiceEndpoint

Service name Generic icon used when the node cannotbe classified.


Beta


Beta

Chapter 6. Event thresholds for Transaction Monitoring

You can use event thresholds to immediately monitor your environment. You canalso create customized event thresholds that test for certain conditions and raise anevent when key performance indicators exceed the threshold.

Response Time Monitoring events

Response Time events are created when web transactions exceed a Response Timethreshold.

After you click

System Configuration > Threshold Manager, select ResponseTime as the Data Source Type. All event thresholds for the Response TimeMonitoring environment are applied to all managed systems of the same type.

The following predefined thresholds are available for the Response TimeMonitoring Agent.

Table 3. Response Time Monitoring thresholds

Threshold Description Formula

Response_Time_Availability_Crit A high percentage of the webtransactions failed.

If WRT TransactionStatus.Percent_Failed is greater than10 and WRT TransactionStatus.Transaction_Definition_Nameis not equal to 'Ignore Resources'then Response_Time_Availability_Critis true

Response_Time_Availability_Warn A moderate percentage of the webtransactions failed.

If WRT TransactionStatus.Percent_Failed is greater than 0and WRT TransactionStatus.Percent_Failed is less than 10and WRT TransactionStatus.Transaction_Definition_Nameis not equal to 'Ignore Resources'thenResponse_Time_Availability_Warn istrue

Response_Time_Critical The percentage of the webtransactions with a slow responsetime is high.

If WRT TransactionStatus.Percent_Slow is greater than 5and WRT TransactionStatus.Percent_Available is equal to100 and WRT TransactionStatus.Transaction_Definition_Nameis not equal to 'Ignore Resources'then Response_Time_Critical is true


Beta

Table 3. Response Time Monitoring thresholds (continued)


Response_Time_Warning The percentage of the webtransactions with a slow responsetime is moderate.

If WRT TransactionStatus.Percent_Slow is greater than 1and WRT TransactionStatus.Percent_Slow is less than 5 andWRT TransactionStatus.Percent_Available is equal to100 and WRT TransactionStatus.Transaction_Definition_Nameis not equal to 'Ignore Resources'then Response_Time_Warning is true

Transaction Tracking events

Transaction Tracking events are created when middleware transactions exceed aTransaction Tracking threshold.

To view the default Transaction Tracking thresholds, click

SystemConfiguration > Threshold Manager, and select Transaction Tracking as the DataSource Type.

Tip: You can create your own Transaction Tracking thresholds if required.

The following predefined thresholds are available for middleware transactions.

Table 4. Transaction Tracking thresholds


Transaction_Avail_Critical A high percentage of the middlewaretransactions failed.

If KTE TRANSACTIONAGGREGATEDATA.PERCENTAGE_FAILED isgreater than 10, thenTransaction_Avail_Critical is true

Transaction_Avail_Warning A moderate percentage of themiddleware transactions failed.

If KTE TRANSACTIONAGGREGATEDATA.PERCENTAGE_FAILED isgreater than 0 and KTETRANSACTION AGGREGATEDATA.PERCENTAGE_FAILED is lessthan or equal to 10, thenTransaction_Avail_Warning is true

Transaction_Time_Critical The percentage of the middlewaretransactions with a slow total time ishigh.

If KTE TRANSACTIONAGGREGATEDATA.PERCENTAGE_SLOW isgreater than or equal to 5 and KTETRANSACTION AGGREGATEDATA.PERCENTAGE_FAILED isequal to 0, thenTransaction_Time_Critical is true


Beta

Table 4. Transaction Tracking thresholds (continued)


Transaction_Time_Warning The percentage of the middlewaretransactions with a slow total time ismoderate.

If KTE TRANSACTIONAGGREGATEDATA.PERCENTAGE_SLOW isgreater than 1 and KTETRANSACTION AGGREGATEDATA.PERCENTAGE_SLOW is lessthan 5 and KTE TRANSACTIONAGGREGATEDATA.PERCENTAGE_FAILED isequal to 0 thenTransaction_Time_Warning is true

Creating thresholds to generate events for transaction monitoringUse the Threshold Manager to create thresholds for transactions. Thresholds areused to compare the sampled value of an attribute with the value set in thethreshold. If the sampled value satisfies the comparison, a transaction event isgenerated.

About this task

Thresholds allow you to monitor when applications report specific conditions. Formore information about the default thresholds for Transaction Monitoring, seeChapter 6, “Event thresholds for Transaction Monitoring,” on page 33.

You can create additional thresholds to monitor other aspects of a transaction. Forexample, you can create a threshold to monitor if the middleware transaction eventrate falls. Then, if the transaction event rate falls below that specified by yourthreshold, an event is generated.

Procedure

To create a threshold and associate it with one or more transactions, complete thefollowing tasks:1. On the Navigation Bar, click System Configuration > Threshold Manager.

Set the Data Source type as Transaction Tracking.2. Click Add to create a new threshold.3. Set a severity for the event that exceeds this threshold.4. To associate the threshold with a transaction, set the following values:v Data set - KTE TRANSACTION AGGREGATE DATAv Display item - Resource_Valuev Logical operator - And (&)

5. Click Add to add a condition. In the Add Condition box, select an attributeand an operator, then enter a threshold value.For example, to add a threshold condition that will generate a transaction eventwhen the number of transactions per minute falls below 100, set the followingvalues and click OK:v Attribute - Transaction_Ratev Operator - Less thanv Value - 100

Chapter 6. Event thresholds for Transaction Monitoring 35

Beta

Repeat this step to add more conditions to your threshold if required.6. In the Group assignment section, select Transaction Tracking to assign your

threshold to that resource group.7. Click Save.

Results

You have created a threshold and associated it with a transaction. When thethreshold conditions are met, an event is generated. You can monitor events in theEvents tab of the Application Performance Dashboard.

Example

To create thresholds for the Response Time Monitoring agent to monitor otheraspects of a web transaction in addition to the defaults:1. In the Threshold Manager, set the Data Source type as Response Time.2. When you add the threshold, use the following settings:v Data set - WRT Transaction Statusv Display item - Applicationv Logical operator - And (&)v Group assignment - Web Response Time


Beta

Chapter 7. Time periods

Historical data collection is configured out-of-the-box on the set of attribute groupsthat are used by the group widgets that display history data. Different widgets candisplay different amounts of information depending on the time span you select.

You can select one of the following periods over which to display data:v Last 4 hours

v Last 12 hours

v Last 1 day

v Last 1 week

For Requests and Response Time widgets, the table expands to the selectedperiod where there is data available. For example, if you select the time span asLast 1 week, and there is data available only for 2 days, only 2 days are shown inthe table.

For Top n tables, such as Transactions - Top 10 and Subtransactions, the worstperforming transactions over the selected time period are displayed.

For the Runs On widget, the score is calculated over the entire selected timeperiod.


Beta


Beta

Appendix A. Attributes

A variety of key performance indicators (KPIs) are supported by the TransactionMonitoring dashboards.

The attributes used in End User Transactions, Mobile Devices Users, andAuthenticated Users dashboards by the Response Time Monitoring agent, are asubset of those used in the attribute groups for the Web Response Time agent.These attributes are listed in the WRT attribute topics.

The attributes used in the middleware dashboards and Transactions Event Agentthresholds are listed in the Transactions Aggregate Data topic.

Transactions Aggregate DataThe KTETRANSAC attribute group provides transactions tracking data formiddleware applications.

The attributes used to calculate the KPIs that are displayed in the TransactionTracking dashboards are listed in the following table:

Attribute Column Data Type Description

Node ORIGINNODE S,32 The managed system name of theagent.

Timestamp TIMESTAMP T Indicates the beginning of theaggregate time for the record.

Transaction_Full_Time TRANSACTIO T,16 The start time of data aggregation forthe resource in the relevant period.

Resource_Value RESOURCE_V S,256 The name of the resource.

Server_Name SERVER_NAM S,256 The name of the server.

Transaction_Name TRANSACTI1 S, 256 The name of the Transaction.

Document_Type DOCUMENT_T S,256 The document type.

Period PERIOD I,4 The period of time from which theaggregated data is collected.

Total_Request_Count TOTAL_REQU I,4 The total number of transactions for theperiod.

Good_Request_Count GOOD_REQUE I,4 The number of good transactions forthe period.

Slow_Request_Count SLOW_REQUE I,4 The number of slow transactions forthe period.

Failed_Request_Count FAILED_REQ I,4 The number of failed transactions forthe period.

Response_Time_Average RESPONSE_T I,8 The average response time, in seconds,for all transactions in the period.

Execution_Time_Average EXEC_TIME_ I,8 The average execution time, in seconds,for all transactions in the period.

Wait_Time_Average WAIT_TIME_ I,8 The average wait time, in seconds, forall transactions in the period.


Beta


Percentage_Slow PERCENT_SL I,4 Percentage of slow transactions.

Percentage_Failed PERCENT_FA I,4 Percentage of failed transactions.

Transaction_Rate TRANSACTI0 I,4 Number of transactions per minute.

WRT Application StatusThe T5APPCS attribute group provides information about the current status of amonitored application.

The attributes used to calculate some of the KPIs that are displayed in theAuthenticated Users dashboards are listed in the following table:



User Logins USERLOGINS I, 4 The number of user logins. The validformat is an integer.

WRT Transaction StatusThe T5TXCS attribute group provides information about a monitored transactionand applies to data gathered in the currently configured collection interval.

Tip: Configure the collection interval in the Manage Tivoli Enterprise MonitoringServices for Response Time Monitoring. In the Manage Tivoli EnterpriseMonitoring Services, select ITCAM for Web Response Time > Reconfigure andstep through the configuration windows to the Data Analysis window. SetNumber of minutes to aggregate data before writing out a data point to therequired value.

The attributes used to calculate the KPIs that are displayed in the End UserTransactions dashboards are listed in the following table:


Average Render Time RENDERTIME I, 4 The total time taken, in seconds, todownload, parse, and render the pagefrom the user perspective.

Average Response Time OATIME I, 4 The average amount of time, inseconds, required to resolve the domainname of the URL. The resolve time is apart of the overall network time. Forinstance data, this field is an absolutevalue, not an average.


Beta


Failed Requests FAILREQ I, 4 The number of recorded transactionsthat either did not complete correctly,or reported an error during themonitoring interval, or whose responsetime was greater than or equal to theMaximum Response Time Threshold.Failed status is indicated by atransaction Status Code with a valuegreater than 0. This value is added tothe values of the Slow Requests andGood Requests attributes to obtain thevalue of the Total Requests attribute.

Good Requests SUCCREQ I, 4 The number of recorded transactionsthat completed successfully, and whoseresponse time was less than theMinimum Response Time Threshold.This value is added to the values of theSlow Requests and Failed Requestsattributes to obtain the value of theTotal Requests attribute.

Maximum Response TimeThreshold

MAXRTTHRSH I, 4 The maximum acceptable responsetime, in seconds, for a transaction tocomplete before it is marked as Failed.

Minimum Response TimeThreshold

MRTTHRES I, 4 The maximum acceptable responsetime, in seconds, for a transaction tocomplete before it is marked as Slow. Ifthe response time is also greater thanthe Maximum Response TimeThreshold, it is marked as Failed.

Percent Failed PCFAIL I, 4 The percentage of transactions whoserequests were marked as Failed.

Percent Available PCAVAIL I, 4 The percentage of transactions whoserequests were marked as Available. Thevalue of this attribute is equal to 100percent minus the percentage oftransactions whose requests weremarked as Failed.

Percent Slow PCSLOW I, 4 The percentage of transactions whoserequests were marked as Slow.

Server SERVER S, 128 The name of the server that processedthe transaction. This could be thehostname of the physical machine, theIP, or the Sysplex.

Slow Requests SLOWREQ I, 4 The number of recorded transactionsthat completed successfully, but whoseresponse time was greater than orequal to the Minimum Response TimeThreshold. This value is added to thevalues of the Good Requests and FailedRequests attributes to obtain the valueof the Total Requests attribute.

Appendix A. Attributes 41

Beta


Total Requests TOTREQ I, 4 The total number of recordedtransactions observed during themonitoring interval. The value for thisattribute is the sum of the GoodRequests, Slow Requests, and FailedRequests attributes.

Transaction TRANSACTN S, 128 The name of the monitored transaction.

Transaction Definition Name TRANSDEFNM S, 128 The type of transaction, either Web,Client Time, or AJAX.


WRT User SessionsThe T5USRSS attribute group provides information about user sessions.

The attributes used to calculate the KPIs that are displayed in the AuthenticatedUsers and Mobile Devices Users dashboards are listed in the following table:


Average Response Time OATIME I, 4 The average response time, inseconds, for a singletransaction instance that wasobserved during themonitoring interval. Duringeach monitoring interval,minimum, maximum, andaverage response times for theaggregate records are recorded.Use these attributes to analyzethe range of response times forthe transaction.

Device OS DEVICEOS S, 32 The operating system fromwhich the transactionoriginates

Failed Requests FAILREQ 4 The number of recordedtransactions that either did notcomplete correctly, or reportedan error during the monitoringinterval, or whose responsetime was greater than or equalto the Maximum ResponseTime Threshold. Failed statusis indicated by a transactionStatus Code with a valuegreater than 0. This value isadded to the values of theSlow Requests and GoodRequests attributes to obtainthe value of the Total Requestsattribute.


Beta


Good Requests SUCCREQ I, 4 The number of recordedtransactions that completedsuccessfully, and whoseresponse time was less thanthe Minimum Response TimeThreshold. This value is addedto the values of the SlowRequests and Failed Requestsattributes to obtain the value ofthe Total Requests attribute.

Maximum Response Time MAXRTT I, 4 The maximum response time,in seconds, for a singletransaction instance that wasobserved during themonitoring interval. Duringeach monitoring interval,minimum, maximum, andaverage response times for theaggregate records are recorded.Use these attributes to analyzethe range of response times forthe transaction.

Maximum Response TimeThreshold

MAXRTTHRSH I, 4 The maximum acceptableresponse time, in seconds, for atransaction to complete beforeit is marked as Failed.

Minimum Response Time MINRTT I, 4 The minimum response time,in seconds, for a singletransaction instance that wasobserved during themonitoring interval.

Minimum Response TimeThreshold

MRTTHRES I, 4 The maximum acceptableresponse time, in seconds, for atransaction to complete beforeit is marked as Slow. If theresponse time is also greaterthan the Maximum ResponseTime Threshold, it is markedas Failed.

Number Of Sessions NUMSESSION I, 4 The number of user sessions.

Percent Failed PCFAIL I, 4 The percentage of transactionswhose requests were markedas Failed. This value iscalculated by dividing FailedRequests by Total Requests andconverting to a percentage. Thesum of this attribute value andthe value of the PercentAvailable attribute should total100%.

Appendix A. Attributes 43

Beta


Percent Good PCGOOD I, 4 The percentage of transactionswhose requests were markedas Good. This value iscalculated by dividing GoodRequests by Total Requests andmultiplying by 100%. The sumof this attribute value and thevalue of the Percent Slowattribute should equal thevalue of the Percent Availableattribute.

Percent Slow PCSLOW I, 4 The percentage of transactionswhose requests were markedas Slow. This value iscalculated by dividing SlowRequests by Total Requests andmultiplying by 100%.

Session Duration SESSDURATN I, 4 The duration for the usersession, in seconds.

Slow Requests SLOWREQ I, 4 The number of recordedtransactions that completedsuccessfully, but whoseresponse time was greater thanor equal to the MinimumResponse Time Threshold. Thisvalue is added to the values ofthe Good Requests and FailedRequests attributes to obtainthe value of the Total Requestsattribute.

Timestamp TIMESTAMP T A timestamp that indicates thebeginning of the aggregatetime for the record.

Total Requests TOTREQ I, 4 The total number of recordedtransactions observed duringthe monitoring interval. Thevalue for this attribute is thesum of the Good Requests,Slow Requests, and FailedRequests attributes.

User USER S, 64 Specifies the user name for theuser session. The valid formatis an alphanumeric string witha maximum of 64 characters.


Beta

Appendix B. Dashboard metrics reference

KPIs for Authenticated Users, End User Transactions, Mobile Devices Users, andTransaction Instance Topology dashboards

Active sessions

The number of open sessions serving mobile devices. Depending on thecontext, this could be for each mobile operating system or user.

All sessions marked as active are counted. Sessions where the user is nolonger using the application, but has not logged out and the session hasnot yet timed out, are included in the count.

Average Response TimeAverage response time, in milliseconds, of the transactions in the currentperiod.

Browser LoadThe time taken, in seconds, to present the final elements of a page such asimages and subframes (loadEventStart - loadEventEnd). Timing points aredescribed by the W3C Navigation Timing specification.

Client Total TimeThe total time taken to download, parse, and render the page from theuser perspective, represented by a blue line. This line shows the realexperience of the user and includes JavaScript transactions, measured byJavaScript monitoring, in the client-side response time.

Component NameThe type of server that originated the page request.

Content LoadingThe time taken, in seconds, to download all imbedded content, includingimages (domLoading - domComplete) within the web page. Timing points aredescribed by the W3C Navigation Timing specification.

DurationThe time a user was logged into an application, in seconds.

Error CodeFor the selected middleware component, the error codes most recentlyreturned by slow or failed transaction requests.

Error DescriptionFor the selected middleware component, error descriptions for the mostrecently returned errors for slow or failed transaction requests.

Execution TimeThe time taken to process the middleware transaction requests.

Failed Percentage of failed transactions in the current period.

Host NameThe name of the server, displayed in the topology, that originated the pagerequest.

Maximum response timeThe response time for the request that was processed slowest.


Beta

https://dvcs.w3.org/hg/webperf/raw-file/tip/specs/NavigationTiming/Overview.html


Minimum response timeThe response time for the request that was processed fastest.

Number of requestsThe number of requests processed during the last period for the differentmobile operating systems, users,

Number of usersThe number of users who are logged in.

Overall Volume or Requests

The number of good (green), slow (yellow), and failed (red) transactionsper period, or a simple count of the number of requests.

The status of the transaction is determined by the Response TimeThreshold:v Good Requests The number of recorded transactions that completed

successfully, and whose response time was less than the MinimumResponse Time Threshold (10 seconds).

v Slow Requests The number of recorded transactions that completedsuccessfully, but whose response time was greater than or equal to theMinimum Response Time Threshold (10 seconds).

v Failed Requests The number of recorded transactions that did notcomplete correctly, or reported an error during the monitoring interval.

Page TransferThe time taken, in seconds, to download the original page and transferHTTP and TCP data (connectStart - responseEnd) within the web page.Timing points are described by the W3C Navigation Timing specification.

Request status

The number of good (green), slow (yellow), and failed (red) requests atvarious time points, for each mobile device, operating system, and user.

The status of the request is determined by the Response Time Threshold:v Good Requests The number of requests that completed successfully, and

whose response time was less than the Minimum Response TimeThreshold (10 seconds).

v Slow Requests The number of requests that completed successfully, butwhose response time was greater than or equal to the MinimumResponse Time Threshold (10 seconds).

v Failed Requests The number of requests that either did not completecorrectly or reported an error during the monitoring interval.

The proportion of good, slow, or failed requests may also be expressed as apercentage.

ResolveThe time taken, in seconds, for the DNS lookup and any page redirections(navigationStart - domainLookupEnd) within the web page to complete.Timing points are described by the W3C Navigation Timing specification.

Response TimeAverage response time, in seconds, of the requests in the current period.

SatisfactionUser satisfaction for the transaction, based on the number of good andslow requests. The transactions are sorted according to their score, which isa user experience KPI based on the number of requests that fail or exceed a


Beta



predetermined slow threshold. The score has a value of 0-1, where the moreslow or failed requests, the lower the score. Transactions have one of thefollowing scores:v Unsatisfactory (red), score less than 0.5v Warning (yellow), score of 0.5-0.84v Satisfactory (green), score of 0.85-1.0

Server Servers or message queues involved in the transaction request.

Server Response timeThe average response time of the page from the server perspective,represented by a light brown line. This line shows the average responsetime, in seconds, of all transactions.

Server StatusThe status of the server that originated the page request: good (tick withgreen background), warning (exclamation mark with yellow background),or failed (cross with red background.

Session durationAverage session duration in seconds, that is, how long a session is running.

Slow Percentage of slow transactions in the current period

SourceIP address of the client that originated the page request.

Start TimeThe time at which the user logged into the application.

Status Overall status for the transaction instance, based on the HTTP, ormiddleware return code. The status displayed is green for successfulrequests, yellow for slow requests, red for failed requests, or gray forunknown requests. Any request returning an HTTP code of 400 or more isshown as failed.

Status CodeThe HTTP status code returned by the page the request was attempting toaccess. Any request returning a code of 400 or greater is considered to havefailed.

Subtransactions

A list of AJAX requests made by the page selected in the End UserTransactions Summary.

TimelineTime taken by each instance, expressed as a proportion of the total timetaken by the selected transaction request.

Total TimeThe time required for the transaction to complete.

TransactionThe name of the transaction.

Transaction Instances

A list of transaction instances for the selected transaction.

Transaction volume

Appendix B. Dashboard metrics reference 47

Beta

The number of good (green), slow (yellow), and failed (red)subtransactions for the selected transaction, over the last period,summarized from all Response Time Monitoring agents.

The status of the subtransaction is determined by the Response TimeThreshold:v Good Requests The number of recorded subtransactions that completed

successfully, and whose response time was less than the MinimumResponse Time Threshold (10 seconds).

v Failed Requests The number of recorded subtransactions that either didnot complete correctly, or reported an error during the monitoringinterval.

Transaction Volume

For the Enterprise Service Bus, the number of good (green) and failed (red)transactions running across all instances for the selected middlewarecomponent.

The transactions have a status of one of the following:v Good Requests The number of transactions that completed successfullyv Failed Requests The number of transactions that either did not complete

correctly, or reported an error during the monitoring interval

Type One of the following types of transaction:v Web Transactions, the total time taken to reply to the page request from

the server perspective. The data is collected by analyzing network traffic.v Client Time, the total time taken to request and present the page in the

browser from the client perspective. The data is collected by analyzingnetwork traffic.

v AJAX Transactions, the total time taken to reply to asynchronous pageupdates from the server perspective. The data is collected from withinthe browser using JavaScript loaded in the page.

User AgentThe client device which is the source of the transaction instance. The typeof device is extracted from the User-Agent field in the HTML header of theinstance.

User NameThe user name for the session.

Wait TimeThe time spent waiting for service dependencies, such as database, webservice, and so on, during a middleware transaction request. The WaitTime for asynchronous requests is 0.


Beta

Appendix C. Accessibility

Accessibility features help users with physical disabilities, such as restrictedmobility or limited vision, to use software products successfully.

The major accessibility features in this product enable users to do the following:v Use assistive technologies, such as screen-reader software and digital speech

synthesizer, to hear what is displayed on the screen. Consult the productdocumentation of the assistive technology for details on using those technologieswith this product.

v Perform tasks with the software using only the keyboard.

Navigating the interface using the keyboard

Standard shortcut and accelerator keys are used by the product and aredocumented by the operating system. See the documentation provided by youroperating system for more information.

Magnifying what is displayed on the screen

You can enlarge information on the product windows using facilities provided bythe operating systems on which the product is run. For example, in a MicrosoftWindows environment, you can lower the resolution of the screen to enlarge thefont sizes of the text on the screen. See the documentation provided by youroperating system for more information.


Beta


Beta

Notices

This information was developed for products and services offered in the U.S.A.IBM may not offer the products, services, or features discussed in this document inother countries. Consult your local IBM representative for information on theproducts and services currently available in your area. Any reference to an IBMproduct, program, or service is not intended to state or imply that only that IBMproduct, program, or service may be used. Any functionally equivalent product,program, or service that does not infringe any IBM intellectual property right maybe used instead. However, it is the user's responsibility to evaluate and verify theoperation of any non-IBM product, program, or service.

IBM may have patents or pending patent applications covering subject matterdescribed in this document. The furnishing of this document does not grant youany license to these patents. You can send license inquiries, in writing, to:

IBM Director of LicensingIBM CorporationNorth Castle DriveArmonk, NY 10504-1785 U.S.A.

For license inquiries regarding double-byte (DBCS) information, contact the IBMIntellectual Property Department in your country or send inquiries, in writing, to:

IBM World Trade Asia CorporationLicensing2-31 Roppongi 3-chome, Minato-kuTokyo 106, Japan

The following paragraph does not apply to the United Kingdom or any othercountry where such provisions are inconsistent with local law:

INTERNATIONAL BUSINESS MACHINES CORPORATION PROVIDES THISPUBLICATION “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHEREXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIEDWARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESSFOR A PARTICULAR PURPOSE.

Some states do not allow disclaimer of express or implied warranties in certaintransactions, therefore, this statement may not apply to you.

This information could include technical inaccuracies or typographical errors.Changes are periodically made to the information herein; these changes will beincorporated in new editions of the publication. IBM may make improvementsand/or changes in the product(s) and/or the program(s) described in thispublication at any time without notice.

Any references in this information to non-IBM websites are provided forconvenience only and do not in any manner serve as an endorsement of thosewebsites. The materials at those websites are not part of the materials for this IBMproduct and use of those websites is at your own risk.


Beta

IBM may use or distribute any of the information you supply in any way itbelieves appropriate without incurring any obligation to you.

Licensees of this program who want to have information about it for the purposeof enabling: (i) the exchange of information between independently createdprograms and other programs (including this one) and (ii) the mutual use of theinformation which has been exchanged, should contact:

IBM Corporation2Z4A/10111400 Burnet RoadAustin, TX 78758 U.S.A.

Such information may be available, subject to appropriate terms and conditions,including in some cases payment of a fee.

The licensed program described in this information and all licensed materialavailable for it are provided by IBM under terms of the IBM Customer Agreement,IBM International Program License Agreement, or any equivalent agreementbetween us.

This information contains examples of data and reports used in daily businessoperations. To illustrate them as completely as possible, the examples include thenames of individuals, companies, brands, and products. All of these names arefictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

COPYRIGHT LICENSE:

This information contains sample application programs in source language, whichillustrate programming techniques on various operating systems. You may copy,modify, and distribute these sample programs in any form without payment toIBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operatingsystem for which the sample programs are written. These examples have not beenthoroughly tested under all conditions. IBM, therefore, cannot guarantee or implyreliability, serviceability, or function of these programs. You may copy, modify, anddistribute these sample programs in any form without payment to IBM for thepurposes of developing, using, marketing, or distributing application programsconforming to IBM's application programming interfaces.

If you are viewing this information softcopy, the photographs and colorillustrations may not appear.

Privacy policy considerationsIBM Software products, including software as a service solutions, (“SoftwareOfferings”) may use cookies or other technologies to collect product usageinformation, to help improve the end user experience, to tailor interactions withthe end user or for other purposes. In many cases no personally identifiableinformation is collected by the Software Offerings. Some of our Software Offeringscan help enable you to collect personally identifiable information. If this SoftwareOffering uses cookies to collect personally identifiable information, specificinformation about this offering’s use of cookies is set forth below.


Beta

Depending upon the configurations deployed, this Software Offering may usesession cookies that collect each user’s user name for purposes of sessionmanagement, authentication, and single sign-on configuration. These cookies canbe disabled, but disabling them will also likely eliminate the functionality theyenable.

If the configurations deployed for this Software Offering provide you as customerthe ability to collect personally identifiable information from end users via cookiesand other technologies, you should seek your own legal advice about any lawsapplicable to such data collection, including any requirements for notice andconsent.

For more information about the use of various technologies, including cookies, forthese purposes, See IBM’s Privacy Policy at http://www.ibm.com/privacy andIBM’s Online Privacy Statement at http://www.ibm.com/privacy/details thesection entitled “Cookies, Web Beacons and Other Technologies” and the “IBMSoftware Products and Software-as-a-Service Privacy Statement” athttp://www.ibm.com/software/info/product-privacy.

Notices 53

Beta

http://www.ibm.com/privacy

http://www.ibm.com/privacy/details

http://www.ibm.com/software/info/product-privacy


Beta

Index

Aaccessibility 49adding

IBM integration stack components 4attributes

Authenticated Users 39End User Transactions 39Mobile Devices Users 39Transactions Aggregate Data 39WRT Application Status 40WRT Transaction Status 40WRT User Sessions 42

Authenticated Usersattributes 39metrics 45

Cconfigure 19, 20configuring 19, 20

IBM integration stack 6thresholds, Transaction

Monitoring 35

Ddashboard

Error Analysis 27Instance Analysis 28middleware 25Middleware Transactions

Summary 25Transaction Instance Topology 28, 29Transactions Details 26

dashboardsResponse Time Monitoring 25Transaction Tracking 25

DataPower agent 19DataPower appliance

monitoring 3define 22

Eenabling 22End User Transactions

attributes 39metrics 45time periods 37

Error Analysis dashboard 27event 20events

IBM integration stack 11

IIBM Integration Bus

monitoring 3IBM integration stack 3, 4, 5, 6, 7, 8

IBM Java application stack 12IBM MQ

monitoring 3icons

in topologies 30installing

IBM integration stack 6Instance Analysis dashboard 28

Mmiddleware

topology values 30middleware dashboards 25Middleware Transactions Summary

dashboard 25Mobile Devices Users

attributes 39metrics 45

monitoringIBM integration stack 3, 4, 5, 6, 7, 8IBM Java application stack 12

Pprofile 22

RResponse Time Monitoring

attributesWRT Application Status 40WRT Transaction Status 40WRT User Sessions 42

thresholds 33topology values 30

Ssetting 21settings 19SOAP 19SSL 22syslog 21, 22

Ttargets 20thresholds

Response Time Monitoring 33Transaction Monitoring 35

topologyvalues on nodes 30

Transaction Instance Topology 28metrics 45

Transaction Instance Topologydashboard 29

Transaction trackingconfiguring for DataPower 18

Transactions Aggregate Data 39attributes 39

Transactions Details dashboard 26trap 20

Uupdating

to V8.1.2 Fix Pack 1 1


Beta


Beta

IBM®

Printed in USA

Beta

ibm performance management transaction tracking for ... · ibm performance management transaction...

Documents