apm_9.5--apm for soa implementation guide

for SOA Implementation Guide Release 9.5

CA Application Performance Management

This Documentation, which includes embedded help systems and electronically distributed materials, (hereinafter referred to as the Documentation) is for your informational purposes only and is subject to change or withdrawal by CA at any time.

This Documentation may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This Documentation is confidential and proprietary information of CA and may not be disclosed by you or used for any purpose other than as may be permitted in (i) a separate agreement between you and CA governing your use of the CA software to which the Documentation relates; or (ii) a separate confidentiality agreement between you and CA.

Notwithstanding the foregoing, if you are a licensed user of the software product(s) addressed in the Documentation, you may print or otherwise make available a reasonable number of copies of the Documentation for internal use by you and your employees in connection with that software, provided that all CA copyright notices and legends are affixed to each reproduced copy.

The right to print or otherwise make available copies of the Documentation is limited to the period during which the applicable license for such software remains in full force and effect. Should the license terminate for any reason, it is your responsibility to certify in writing to CA that all copies and partial copies of the Documentation have been returned to CA or destroyed.

TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS DOCUMENTATION AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE.

The use of any software product referenced in the Documentation is governed by the applicable license agreement and such license agreement is not modified in any way by the terms of this notice.

The manufacturer of this Documentation is CA.

Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections 12.212, 52.227-14, and 52.227-19(c)(1) - (2) and DFARS Section 252.227-7014(b)(3), as applicable, or their successors.

Copyright 2013 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies.

CA Technologies Product References

This document references the following CA Technologies products and features:

CA Application Performance Management (CA APM)

CA Application Performance Management ChangeDetector (CA APM ChangeDetector)

CA Application Performance Management ErrorDetector (CA APM ErrorDetector)

CA Application Performance Management for CA Database Performance (CA APM for CA Database Performance)

CA Application Performance Management for CA SiteMinder (CA APM for CA SiteMinder)

CA Application Performance Management for CA SiteMinder Application Server Agents (CA APM for CA SiteMinder ASA)

CA Application Performance Management for IBM CICS Transaction Gateway (CA APM for IBM CICS Transaction Gateway)

CA Application Performance Management for IBM WebSphere Application Server (CA APM for IBM WebSphere Application Server)

CA Application Performance Management for IBM WebSphere Distributed Environments (CA APM for IBM WebSphere Distributed Environments)

CA Application Performance Management for IBM WebSphere MQ (CA APM for IBM WebSphere MQ)

CA Application Performance Management for IBM WebSphere Portal (CA APM for IBM WebSphere Portal)

CA Application Performance Management for IBM WebSphere Process Server (CA APM for IBM WebSphere Process Server)

CA Application Performance Management for IBM z/OS (CA APM for IBM z/OS)

CA Application Performance Management for Microsoft SharePoint (CA APM for Microsoft SharePoint)

CA Application Performance Management for Oracle Databases (CA APM for Oracle Databases)

CA Application Performance Management for Oracle Service Bus (CA APM for Oracle Service Bus)

CA Application Performance Management for Oracle WebLogic Portal (CA APM for Oracle WebLogic Portal)

CA Application Performance Management for Oracle WebLogic Server (CA APM for Oracle WebLogic Server)

CA Application Performance Management for SOA (CA APM for SOA)

CA Application Performance Management for TIBCO BusinessWorks (CA APM for TIBCO BusinessWorks)

CA Application Performance Management for TIBCO Enterprise Message Service (CA APM for TIBCO Enterprise Message Service)

CA Application Performance Management for Web Servers (CA APM for Web Servers)

CA Application Performance Management for webMethods Broker (CA APM for webMethods Broker)

CA Application Performance Management for webMethods Integration Server (CA APM for webMethods Integration Server)

CA Application Performance Management Integration for CA CMDB (CA APM Integration for CA CMDB)

CA Application Performance Management Integration for CA NSM (CA APM Integration for CA NSM)

CA Application Performance Management LeakHunter (CA APM LeakHunter)

CA Application Performance Management Transaction Generator (CA APM TG)

CA Cross-Enterprise Application Performance Management

CA Customer Experience Manager (CA CEM)

CA Embedded Entitlements Manager (CA EEM)

CA eHealth Performance Manager (CA eHealth)

CA Insight Database Performance Monitor for DB2 for z/OS

CA Introscope

CA SiteMinder

CA Spectrum Infrastructure Manager (CA Spectrum)

CA SYSVIEW Performance Management (CA SYSVIEW)

Contact CA Technologies

Contact CA Support

For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At http://ca.com/support, you can access the following resources:

Online and telephone contact information for technical assistance and customer services

Information about user communities and forums

Product and documentation downloads

CA Support policies and guidelines

Other helpful resources appropriate for your product

Providing Feedback About Product Documentation

If you have comments or questions about CA Technologies product documentation, you can send a message to [email protected].

To provide feedback about CA Technologies product documentation, complete our short customer survey which is available on the CA Support website at http://ca.com/docs.

Contents 7

Contents

Chapter 1: About CA Application Performance Management for SOA 17

What is a Service-Oriented Architecture? .................................................................................................................. 17

Common components of the SOA infrastructure ...................................................................................................... 18

How to Monitor SOA Performance Using CA Introscope ......................................................................................... 19

Monitoring Web Service Clients and Servers ...................................................................................................... 20

Using SOA-Specific Dashboards for Proactive Management .............................................................................. 21

Viewing Dependencies and Using Metrics for Triage and Diagnosis .................................................................. 21

Tracing transactions that involve SOA components ........................................................................................... 21

Monitoring Across Multiple Platforms and Transports ....................................................................................... 22

Understanding the Architecture for Monitoring SOA ................................................................................................ 23

Additional SOA Platform Support ............................................................................................................................... 25

Chapter 2: Installing and Configuring CA APM for SOA 27

Installation and Configuration .................................................................................................................................... 27

CA Introscope Components and Versions ................................................................................................................ 28

Basic system requirements for agents ................................................................................................................ 28

SOAP and Application Server Requirements for Agents ..................................................................................... 28

Understanding Directory and File Naming Conventions ..................................................................................... 29

Backing Up Before Upgrading From a Previous Version ..................................................................................... 30

How to Add CA APM for SOA to an Agent .................................................................................................................. 31

Selecting CA APM for SOA in the Standalone Agent Installer ............................................................................. 31

Use Silent Mode to Enable CA APM for SOA for the Agent ................................................................................ 32

Adding CA APM for SOA Manually to an Agent .................................................................................................. 33

Agent Properties Configuration After Installation .............................................................................................. 35

How to Enable SOA Platform Extensions ............................................................................................................ 35

Enable Extensions on the Enterprise Manager .......................................................................................................... 37

Verify the CA APM for SOA Deployment .................................................................................................................... 40

Remove CA APM for SOA ........................................................................................................................................... 41

Chapter 3: Monitoring a Service-Oriented Architecture 43

Viewing SOA-Specific Information in CA Introscope ................................................................................................ 43

About Client and Server Web Services and Operations ...................................................................................... 44

About service namespaces and operation names .............................................................................................. 44

About Unidentified Services and Operations ...................................................................................................... 45

About virtual agents ............................................................................................................................................ 45

Use the SOA Performance Dashboards ...................................................................................................................... 46

8 for SOA Implementation Guide

SOA Performance Overview Dashboard ............................................................................................................. 49

SOA Performance Client Health Dashboard ........................................................................................................ 50

SOA Performance Server Health Dashboard ....................................................................................................... 50

SOA Performance Most Critical Operations Dashboard ..................................................................................... 51

SOA Performance Most Dependent Operations Dashboard .............................................................................. 51

SOA Performance Busiest Operations Dashboard .............................................................................................. 52

Using Investigator to view SOA performance metrics ............................................................................................... 52

The Available Metrics .......................................................................................................................................... 52

View Summarized Metrics on Overview Tabs ..................................................................................................... 53

View Dependency Metrics on the Dependencies Tab ........................................................................................ 55

Viewing Deviation Metrics on the Deviations Tab .............................................................................................. 59

View Critical Operation Metrics on the Most Critical Tab................................................................................... 60

View Dependent Operations on the Most Dependent Tab ................................................................................ 60

Viewing SOAP Fault and Error Metrics on the Errors Tab ................................................................................... 61

Viewing boundary blame in the Investigator ............................................................................................................. 62

View the Default SOA-Specific Metric Groupings ...................................................................................................... 62

View the Default CA APM for SOA Alerts ................................................................................................................... 63

Chapter 4: Using the SOA Dependency Map 65

Understanding the use of the SOA Dependency Map ............................................................................................... 65

Understanding the challenge of the SOA environment ...................................................................................... 65

Understanding what the SOA Dependency Map provides ................................................................................. 66

Understanding dependencies and SOA terminology .......................................................................................... 66

Understanding what you can do with the SOA Dependency Map ...................................................................... 67

How the SOA Dependency Map Gets Data ................................................................................................................ 68

About Persisted Data for the SOA Dependency Map ......................................................................................... 68

Updating the dependency map with new services and operations .................................................................... 70

Aging and removal for obsolete map nodes ....................................................................................................... 71

What to do if the dependency map displays incomplete data ........................................................................... 71

About logical equivalence rules .......................................................................................................................... 72

Understanding context in the SOA Dependency Map ............................................................................................... 73

Understanding how the content type affects what you see ............................................................................... 73

Understanding how the Investigator node affects what you see ....................................................................... 74

Displaying the SOA Dependency Map ........................................................................................................................ 74

About Investigator tree nodes and map nodes .................................................................................................. 75

About standalone and dependent map nodes ................................................................................................... 75

About map nodes for operations ........................................................................................................................ 76

Choosing a physical or logical view ............................................................................................................................ 76

Select a Content Type ................................................................................................................................................ 77

Set a Primary Metric for Dependency Map Nodes .................................................................................................... 78

Selecting ToolTip metrics for dependency map nodes .............................................................................................. 78

Contents 9

Changing the dependency levels displayed ............................................................................................................... 79

Checking for additional dependencies for a map node ...................................................................................... 80

Hiding dependencies for a map node ................................................................................................................. 80

Checking for additional dependencies for all items in the map.......................................................................... 81

Hiding dependencies for all items in the map .................................................................................................... 81

Navigating within the SOA Dependency Map ............................................................................................................ 82

Panning, zooming, and fitting the SOA Dependency Map .................................................................................. 82

Jumping from a map node to the associated Investigator tree node ................................................................. 83

Showing all operations for a service ................................................................................................................... 83

Showing all services for an agent ........................................................................................................................ 84

Saving SOA Dependency Map images ........................................................................................................................ 84

SOA Dependency Map Sharing ........................................................................................................................... 84

Saving the SOA Dependency Map as a snapshot ................................................................................................ 85

Starting a Transaction Trace from a map node .......................................................................................................... 86

SOA Dependency Map for a Cluster ........................................................................................................................... 87

Chapter 5: Using Transaction Tracing in SOA Environments 89

About cross-process transaction tracing .................................................................................................................... 89

Understanding how segments of a transaction are linked ................................................................................. 90

Understanding context for a cross-process transaction trace ............................................................................ 91

Using transaction tracing to solve problems .............................................................................................................. 91

Start and View Transaction Traces ............................................................................................................................. 92

Using the Summary View .................................................................................................................................... 93

Use the Trace View ............................................................................................................................................. 94

Use the Tree View ............................................................................................................................................... 94

Using the Sequence View .................................................................................................................................... 95

Set Filters for Transaction Traces ............................................................................................................................... 98

Adding and saving filters ................................................................................................................................... 100

Removing filters ................................................................................................................................................ 100

Using complex filters ......................................................................................................................................... 101

Querying the event database for SOA services ........................................................................................................ 101

Viewing error event information ...................................................................................................................... 102

Viewing correlated event information .............................................................................................................. 102

Chapter 6: Configuring SOA-Specific Properties 103

Configuring the name displayed for web services ................................................................................................... 103

Configuring correlated tracing ................................................................................................................................. 105

Configuring properties for clients and servers .................................................................................................. 106

Disabling correlated tracing .............................................................................................................................. 106

Configuring the Insertion Point for SOAP Handlers ................................................................................................. 107

Client and Server Properties for Inserting the SOAP Handler ........................................................................... 107


Changing the Default Order for SOAP Handlers ................................................................................................ 108

Configuring limits for the SOA dependency map ..................................................................................................... 108

Chapter 7: Monitoring Oracle Service Bus 111

About Oracle Service Bus (OSB) ............................................................................................................................... 111

How to Enable Monitoring for Oracle Service Bus ................................................................................................... 114

Enabling the agent for monitoring Oracle Service Bus ..................................................................................... 114

Enable the Oracle Service Bus Enterprise Manager Extension ......................................................................... 116

Use Dashboards to Monitor Oracle Service Bus....................................................................................................... 118

Understanding and viewing metrics for Oracle Service Bus .................................................................................... 120

Metrics for BusinessServices ............................................................................................................................. 121

Metrics for Pipelines ......................................................................................................................................... 122

Metrics for ProxyServices .................................................................................................................................. 122

Metrics for Transports ...................................................................................................................................... 123

Metrics for UDDI ............................................................................................................................................... 124

Metrics for XQueries ......................................................................................................................................... 124

View Default Oracle Service Bus Metric Groupings ................................................................................................. 124

View Default Oracle Service Bus Alerts .................................................................................................................... 125

Viewing Oracle Service Bus dependencies ............................................................................................................... 126

Tracing transactions for Oracle Service Bus ............................................................................................................. 127

Understanding the value of cross-process transaction tracing ......................................................................... 127

Starting and Viewing a Sample Transaction Trace ............................................................................................ 127

Chapter 8: Monitoring TIBCO BusinessWorks 129

About TIBCO BusinessWorks .................................................................................................................................... 129

How to Enable Monitoring for TIBCO BusinessWorks .............................................................................................. 131

Enabling the agent for monitoring TIBCO BusinessWorks ................................................................................ 131

Configure TIBCO BusinessWorks to Use the Agent ........................................................................................... 135

Configuring automatic agent naming ................................................................................................................ 136

Enable the Enterprise Manager Extension ........................................................................................................ 137

Use Dashboards to Monitor TIBCO BusinessWorks ................................................................................................. 138

Understanding and viewing metrics for TIBCO BusinessWorks ............................................................................... 140

Metrics for Activities ......................................................................................................................................... 142

Metrics for Group Actions ................................................................................................................................. 142

Metrics for Hawk ............................................................................................................................................... 142

Metrics for jobs and job pools .......................................................................................................................... 150

Metrics for Processes ........................................................................................................................................ 152

Metrics for Transports ...................................................................................................................................... 154

Metrics for WebServices ................................................................................................................................... 157

View Default TIBCO BusinessWorks Metric Groupings ............................................................................................ 158

Viewing default TIBCO BusinessWorks alerts........................................................................................................... 158

Contents 11

Viewing TIBCO BusinessWorks dependencies ......................................................................................................... 159

Tracing transactions for TIBCO BusinessWorks ........................................................................................................ 161

How to Use the Transaction Trace Data in Tibco ............................................................................................. 162


Starting and viewing a sample transaction trace .............................................................................................. 163

About frontends and backends for BusinessWorks ................................................................................................. 164

Understanding the limitations for spawned processes .................................................................................... 165

Disabling the association of multiple backends with a frontend ...................................................................... 165

Adding a custom TIBCO BusinessWorks backend ............................................................................................. 166

Customizing metric aging and removal .................................................................................................................... 167

Configuring correlated tracing for TIBCO BusinessWorks ........................................................................................ 167

Chapter 9: Monitoring TIBCO Enterprise Message Service 169

About TIBCO Enterprise Message Service ................................................................................................................ 169

How to Install the SOA Extension for TIBCO EMS .................................................................................................... 170

Run the Standalone Agent Installer ......................................................................................................................... 171

Use a Response File for Silent Installation ........................................................................................................ 171

Manually Extract an Installation Archive .......................................................................................................... 172

Prepare the TIBCO EMS Server for Monitoring ........................................................................................................ 172

Configuring the TIBCO EMSMonitor agent............................................................................................................... 173

Configuring basic connection properties .......................................................................................................... 174

Configuring polling intervals for the server ...................................................................................................... 175

Configuring filters for selective monitoring ............................................................................................................. 176

Configuring filters for queues and topics .......................................................................................................... 176

Defining the advanced components to include ................................................................................................ 177

Defining regular expression filters for advanced components ......................................................................... 177

Replacement of Special Characters in EMS Names ........................................................................................... 178

Defining a monitoring level ...................................................................................................................................... 178

Using the default monitoring level definitions ................................................................................................. 179

Modifying the default monitoring level definitions .......................................................................................... 180

Creating encrypted passwords ................................................................................................................................. 182

Connecting to TIBCO EMS server instances using SSL .............................................................................................. 183

Starting the EMSMonitor agent ............................................................................................................................... 185

Start EMSMonitor With a Startup Script ........................................................................................................... 185

Running the EMSMonitor agent as a Windows service .................................................................................... 186

Enable the Enterprise Manager Extension ............................................................................................................... 186

Use Dashboards to Monitor TIBCO EMS .................................................................................................................. 187

Understanding and viewing TIBCO EMS metrics ...................................................................................................... 189

Metrics for Last Check ....................................................................................................................................... 192

Metrics for Queues ........................................................................................................................................... 193

Metrics for the Server ....................................................................................................................................... 197


Metrics for Topics ............................................................................................................................................. 205

Metrics for Routes............................................................................................................................................. 209

Metrics for Channels ......................................................................................................................................... 210

Metrics for Bridges ............................................................................................................................................ 212

Viewing default TIBCO EMS metric groupings ......................................................................................................... 212

Viewing default TIBCO EMS alerts ............................................................................................................................ 213

Summary of agent configuration properties ............................................................................................................ 214

Chapter 10: Monitoring webMethods Broker 221

About webMethods Broker ...................................................................................................................................... 221

How to Install the SOA Extension for webMethods Broker ..................................................................................... 223

Verify Prerequisites ........................................................................................................................................... 223

Run the Standalone Agent Installer .................................................................................................................. 223

Prepare webMethods Broker for Monitoring ................................................................................................... 225

Configure the Agent for the webMethods Broker ............................................................................................ 226

Enable the Enterprise Manager Extension for webMethods Broker ................................................................ 231

Use Dashboards to Monitor webMethods Broker ................................................................................................... 232

Understanding and Viewing Metrics for the Broker ................................................................................................ 234

Metrics for Brokers ........................................................................................................................................... 238

Metrics for Client groups .................................................................................................................................. 239

Metrics for Clients ............................................................................................................................................. 239

Metrics for Document Types ............................................................................................................................. 241

Metrics for the Retry Queue ............................................................................................................................. 241

Metrics for Territory Stats ................................................................................................................................. 242

Metrics for the Trace queue ............................................................................................................................. 243

Metrics for Utilization ....................................................................................................................................... 244

View Default Broker Metric Groupings .................................................................................................................... 244

View Default Broker Alerts ....................................................................................................................................... 245

Chapter 11: Monitoring webMethods Integration Server 247

About webMethods Integration Server ................................................................................................................... 247

How to Enable Monitoring for webMethods Integration Server ............................................................................. 250

Manually Enable the Agent for Monitoring webMethods Integration Server .................................................. 251

About the Directive Files for webMethods Integration Server ......................................................................... 252

Enable the Enterprise Manager Extension ........................................................................................................ 253

Use Dashboards to Monitor webMethods ............................................................................................................... 253

Filtering the services monitored and displayed ....................................................................................................... 258

About the Default Configuration File ................................................................................................................ 259

Including and excluding services using regular expressions ............................................................................. 259

Specifying a Different Location for the Configuration File ................................................................................ 260

View and Navigate Metrics for webMethods .......................................................................................................... 260

Contents 13

Metrics for Adapters ......................................................................................................................................... 261

Metrics for Authorization .................................................................................................................................. 263

Metrics for Business Processes ......................................................................................................................... 264

Metrics for Flow Services .................................................................................................................................. 267

Metrics for Java Services ................................................................................................................................... 267

Metrics for JDBC Pools ...................................................................................................................................... 268

Metrics for Thread Pools ................................................................................................................................... 268

Metrics for Trading Networks ........................................................................................................................... 269

Metrics for Triggers ........................................................................................................................................... 272

Metrics for WebServices ................................................................................................................................... 272

Metrics for XSLT Services .................................................................................................................................. 274

Viewing default webMethods metric groupings ...................................................................................................... 274

Viewing default webMethods alerts ........................................................................................................................ 275

Viewing webMethods dependencies ....................................................................................................................... 276

Tracing transactions for webMethods ..................................................................................................................... 277

About Configuring Cross-Process Transaction Tracing...................................................................................... 277



Using the Sequence View for webMethods processes ..................................................................................... 278

Chapter 12: Monitoring WebSphere Process Server and WESB 281

About WebSphere Process Server and WESB .......................................................................................................... 281

Monitoring WebSphere Process Server Components ....................................................................................... 282

Monitoring WebSphere Enterprise Service Bus standalone ............................................................................. 285

How To Enable Monitoring for WebSphere Process Server or WESB ...................................................................... 285

Enabling the agent for monitoring WPS or WESB ............................................................................................. 286

Enable the Enterprise Manager Extension for WPS or WESB ........................................................................... 289

Using dashboards to monitor WPS or WESB ............................................................................................................ 292

About WebSphere Process Server dashboards ................................................................................................. 292

About WESB dashboards ................................................................................................................................... 294

View WebSphere Process Server or WESB Dashboards.................................................................................... 295

View and Navigate Metrics for WPS/WESB ............................................................................................................. 296

Metrics for Business Objects Maps ................................................................................................................... 297

Metrics for Business Processes ......................................................................................................................... 297

Metrics for Business Rules ................................................................................................................................ 297

Metrics for Business State Machines ................................................................................................................ 298

Metrics for Data Bindings .................................................................................................................................. 298

Metrics for Human Tasks .................................................................................................................................. 298

Metrics for Interface Maps ............................................................................................................................... 298

Metrics for J2CA Adapters................................................................................................................................. 299

Metrics for Java Components ........................................................................................................................... 299


Metrics for Mediation flows and primitives ...................................................................................................... 299

Metrics for Relationships .................................................................................................................................. 303

Metrics for Selectors ......................................................................................................................................... 303

Metrics for Service Integration Bus Communication ........................................................................................ 303

Metrics for WebSphere Process Server Faults .................................................................................................. 303

Viewing default WPS and WESB metric groupings ................................................................................................... 303

Viewing default WPS and WESB alerts ..................................................................................................................... 304

Viewing WPS or WESB dependencies ...................................................................................................................... 305

Tracing transactions for WPS or WESB..................................................................................................................... 306



Using the Sequence View for WebSphere processes ........................................................................................ 307

Configure Tracing to Include Business Process/Business State Machine Activities .......................................... 308

Appendix A: SOA-Specific Agent Configuration Properties 311

Understanding where agent properties are located ................................................................................................ 311

Configure Agent Properties ...................................................................................................................................... 311

About SOA-Specific Agent Properties ...................................................................................................................... 312

agent.httpheaderinsertion.enabled .................................................................................................................. 313

agent.httpheaderread.enabled ......................................................................................................................... 314

agent.soapheaderinsertion.enabled ................................................................................................................. 315

agent.soapheaderread.enabled ........................................................................................................................ 316

agent.soa.metricNameFormatting .................................................................................................................... 316

agent.transactiontrace.boundaryTracing.cacheFlushFrequency ...................................................................... 317

agent.transactiontrace.boundaryTracing.enable .............................................................................................. 318

soa.client.prependhandler ................................................................................................................................ 318

soa.server.appendhandler ................................................................................................................................ 319

Appendix B: SOA-Specific Enterprise Manager Configuration Properties 321

Configuring Enterprise Manager properties ............................................................................................................ 321

About SOA-specific Enterprise Manager properties ................................................................................................ 322

soa.dependencymap.aging.refresh.interval ..................................................................................................... 325

soa.dependencymap.aging.expire.interval ....................................................................................................... 326

soa.dependencymap.heuristics.clientside.enable ............................................................................................ 326

soa.dependencymap.heuristics.namematch.enable ........................................................................................ 327

soa.dependencymap.heuristics.serverside.enable ........................................................................................... 328

soa.dependencymap.log.suppress .................................................................................................................... 330

soa.dependencymap.max.edge.ratio ................................................................................................................ 331

soa.dependencymap.max.vertices.................................................................................................................... 332

soa.deviation.enable ......................................................................................................................................... 333

soa.deviation.art.enable ................................................................................................................................... 334

Contents 15

soa.deviation.dependencymetric.enable .......................................................................................................... 334

soa.deviation.count.per.metric ......................................................................................................................... 335

soa.deviation.dependency.refreshrate ............................................................................................................. 336

soa.deviation.errors.enable .............................................................................................................................. 337

soa.deviation.max.metric.count ....................................................................................................................... 337

soa.deviation.mean.days .................................................................................................................................. 338

soa.deviation.metric.expressionlist .................................................................................................................. 338

soa.deviation.metric.calledbackends ................................................................................................................ 339

soa.deviation.usage.enable .............................................................................................................................. 340

soa.dashboard.typeviewer.average.enable ...................................................................................................... 341

soa.dashboard.typeviewer.errors.enable ......................................................................................................... 342

soa.dashboard.typeviewer.response.enable .................................................................................................... 343

soa.dashboard.typeviewer.mostcritical.enable ................................................................................................ 344

soa.dashboard.typeviewer.mostcritical.count.................................................................................................. 345

soa.dashboard.typeviewer.mostdependent.enable ......................................................................................... 346

soa.dashboard.typeviewer.mostdependent.count ........................................................................................... 347

Appendix C: SOA-Specific Workstation Configuration Properties 349

Configuring Workstation properties ........................................................................................................................ 350

About SOA-Specific Workstation Properties ............................................................................................................ 351

soa.dependencymap.ui.view.nodecount .......................................................................................................... 352

com.wily.introscope.soa.dependencymap.ui.view.edgecount ......................................................................... 353

soa.dashboard.typeviewer.average.enable ...................................................................................................... 354

soa.dashboard.typeviewer.errors.enable ......................................................................................................... 355

soa.dashboard.typeviewer.response.enable .................................................................................................... 356

soa.dashboard.typeviewer.mostcritical.enable ................................................................................................ 357

soa.dashboard.typeviewer.mostcritical.count.................................................................................................. 358

soa.dashboard.typeviewer.mostdependent.enable ......................................................................................... 359

soa.dashboard.typeviewer.mostdependent.count ........................................................................................... 360

workstation.soa.dependencymap.fetchmetrics ............................................................................................... 361

workstation.traceview.crossprocess.duration.full ............................................................................................ 362

workstation.traceview.crossprocess.duration.net............................................................................................ 363

Appendix D: SOA-Specific WebView Configuration Properties 365

Configure WebView Properties ................................................................................................................................ 365

About SOA-Specific WebView Properties ................................................................................................................ 366

soa.dependencymap.ui.view.nodecount .......................................................................................................... 366

com.wily.introscope.soa.dependencymap.ui.view.edgecount ......................................................................... 367


Index 369


Chapter 1: About CA Application Performance Management for SOA

A service-oriented architecture (SOA) is an application platform that enables organizations to share and reuse loosely coupled services to accomplish business goals.

There are several benefits to deploying applications using a service-oriented architecture, but there are also unique challenges to monitoring SOA environments. This section highlights the key ways you can use CA Application Performance Management for SOA (CA APM for SOA) to meet those challenges.

This section contains the following topics:

What is a Service-Oriented Architecture? (see page 17) Common components of the SOA infrastructure (see page 18) How to Monitor SOA Performance Using CA Introscope (see page 19) Understanding the Architecture for Monitoring SOA (see page 23) Additional SOA Platform Support (see page 25)

What is a Service-Oriented Architecture?

A service-oriented architecture (SOA) is an application platform that relies on standardized communication protocols to enable loosely coupled services to accomplish business goals.

The benefits of using SOA include greater business agility and flexibility, improvements in customer service and efficiency, and reduced development costs. Monitoring and managing a complex SOA environment, however, can be far more difficult than managing a traditional client-server environment.

In a traditional client-server environment, there is direct communication between clients and a limited number of servers. When problems occur, finding the cause of the failure is typically straightforward because only a few systems are involved in any individual business transaction. You can isolate the source of the problem by investigating the specific systems directly involved in the transaction.

Identifying the source of a problem becomes more difficult when web application servers act as a central point for distributing access to applications across multiple client-server systems. Performance degradation, errors, or operation failures can be caused by virtually any component or computer that participates in the web server connected infrastructure.

Common components of the SOA infrastructure


A service-oriented architecture introduces an additional layer of complexity for monitoring application performance and availability. With SOA, loosely coupled services rely on standardized communication to integrate and extend applications that run on different platforms. Because the services separate the business logic from the underlying operating system or platform, organizations can be more agile and respond quickly to changes in market or product dynamics. Individual services can be designed to handle specific parts of complex or multistep business processes, creating chains of dependencies across a heterogeneous environment.

Using a service-oriented architecture enables organizations to develop and deploy applications faster and in a more cost-effective way because services can be reused, modified, or replaced as independent components. This efficient, modular approach to application architecture, however, presents its own challenges for application management.

Common components of the SOA infrastructure

Although using SOA simplifies the implementation and integration of business processes, the underlying SOA infrastructure typically relies on a complex interaction of multiple components. For example, completing a simple business transaction typically involves multiple individual services running on different components exchanging messages with each other using different protocols. Monitoring the key components of the transaction requires visibility into how the services communicate, how requests and responses are routed from one service to another, which services have dependencies on other services, and where critical bottlenecks occur.

Although the specific monitoring requirements depend on your SOA implementation, a typical SOA infrastructure includes:

multiple services that use standard interfaces to enable client-side and server-side components to exchange messages with each other

a message handling system that enables requests and responses to be routed, transformed, and delivered from one component to another

adapters that enable external or legacy systems to connect and use the services deployed

a registry that records and publishes information about the services available

How to Monitor SOA Performance Using CA Introscope


The following figure illustrates a simplified SOA infrastructure that uses the Simple Object Access Protocol (SOAP) and eXtensible Markup Language (XML) to enable web services (WS) to communicate with each other through an enterprise service bus (ESB) that controls the delivery of messages to the appropriate destinations.

Because the SOA infrastructure depends on the modular delivery of reusable and adaptable components, transactions in these environments typically involve more components. As the number of components involved in transactions increase, tracking the flow of a transaction becomes increasingly difficult. There are also more potential points of failure as more messages are passed from process to process or from one platform to another, often over different transport protocols. In addition, once organizations commit to deploying applications in a SOA environment, they tend to move an increasing number of mission-critical services to that environment, making the monitoring of that infrastructure increasingly important to the health of the business.

CA APM for SOA addresses these unique challenges by providing visibility into the health of the SOA infrastructure and the real-time performance of the components that participate in SOA transactions.


CA APM for SOA provides real-time and historical views into application performance for the SOA environment. It extends the core CA Introscope capabilities to enable you to monitor and track web service transactions from the frontend where a user requests service to the backend systems used to fulfill the request. By using CA Introscope with CA APM for SOA, you can proactively monitor SOA client and server performance, triage incidents, and analyze service-related problems in depth without access to application source code or SOA architects.



Adding CA APM for SOA to CA Introscope helps you monitor the SOA environment by providing:

dashboard visibility of SOA client and server health and performance for proactive management of the environment

overviews and detailed metrics that help you isolate problems to the web service, application, or back-end

visual representation of dependencies between agents, services, and operations to help you assess how a problem in one component may affect other components

correlated transaction tracing across platforms, transport protocols, and application servers

visibility and context for application errors or SOAP faults produced by web service components

In addition to these default features that enable the monitoring and application management for SOA clients and servers, you can customize CA Introscope and CA APM for SOA to suit your needs. For example, you can:

build a web service audit trail by verifying web service invocation receipt and completion

create application groups of web services, and know whether a group is exceeding response time, transaction volume, or error thresholds

set up virtual agents to collect aggregated metrics for web service clients and services

Monitoring Web Service Clients and Servers

In most cases, web service transactions consist of a client that makes requests to a web service and a server that responds to the request. For example, a Java class that enables a user or program to request a stock quote can be considered a web service client. The Stock Quote web service that provides the price in response to the request is considered the web service server.

The agent tracks and displays client and server metrics separately, enabling you to monitor and set thresholds for client-side and server-side performance separately. Keeping the client-side and server-side separate also allows you to see dependencies in the proper context.

In most cases, the client and server for a web service run in separate Java Virtual Machines (JVMs) or Microsoft Common Language Runtime environments (CLRs). Therefore, the metrics for client-side and server-side operations are typically reported by two or more agents. If you want to see the metrics for the client and server aggregated together, you can do so by configuring a virtual agent (see page 45).



Using SOA-Specific Dashboards for Proactive Management

With CA APM for SOA, you can monitor critical services around the clock, in real-time and with production load. SOA-specific dashboards summarize key performance indicators and provide default thresholds and alert indicators to give you early notification when response time increases or there is unusual activity, such as increased load or reduced throughput. The dashboards and alert indicators enable you to identify potential problems quickly and proactively, and then analyze issues in detail to determine the nature of the problem and who is responsible for resolution.

Using CA Introscope and CA APM for SOA dashboards, you can monitor web service client and server performance continuously to detect potential problems at a glance as they are developing. In many cases, taking this proactive approach helps you identify and correct a failing component before it affects your customers or end users.

Viewing Dependencies and Using Metrics for Triage and Diagnosis

When a problem appears in complex SOA environments, it is often a challenge to know where to start looking for the source. Because the application architecture is more modular, there are more components involved in each transaction and more potential points of failure.

Dashboards and alert indicators provide early visibility of potential issues. The SOA dependency map provides visibility into how modular components are interrelated and how those relationships are affecting performance. Dependencies let you analyze where there are potential bottlenecks or critical operations and compare the average response time or other metrics for services that have dependencies on each other.

High-level views summarize overall application performance, alert you to potential problems, and illustrate the dependency relationships between components. CA Introscope with CA APM for SOA also provides both high-level summaries and detailed operation-level metrics that architects and developers in your organization can use to review, isolate, and resolve problems. See Using Investigator to view SOA performance metrics (see page 52) for more information about using metrics to evaluate web services performance and operation.

Tracing transactions that involve SOA components

In the SOA environment, it is common for messages to pass between loosely coupled components using multiple protocols, making the tracking of transaction flow more difficult. Transaction traces provide detailed information about individual transactions in which web services are involved, the number and nature of web service faults, and component interactions. For example, transaction traces identify where each segment of a transaction took place and how well each segment performed in real-time. Application experts can then use the information to identify the root cause of errors or performance degradation.



When an incident occursfor example, if the response time for a particular web service slowsan alert can notify the appropriate stakeholders before a service level agreement (SLA) is violated or an end-user is affected. Application Support personnel can then gather more detailed information about the nature of the problem by monitoring individual transactions to visually identify the parts of the transaction that are taking the most time and the sequence of calls synchronously or asynchronously to complete each captured transaction.

Monitoring Across Multiple Platforms and Transports

CA Introscope with CA APM for SOA lets you monitor and manage your entire infrastructure, including transactions that span multiple operating systems, application platforms, or transport protocols. In a typical SOA environment, it is common for transactions to use a combination of SOAP, XML, HTTP, HTTPS, and JMS transport protocols and to include processing on multiple application server environments.

With CA APM for SOA, you can trace transactions across any combination of supported J2EE or .NET servers. For example, you can trace the full path of a transaction that includes a service running on WebLogic sending a request to a service running on SAP NetWeaver or on a .NET application server. Depending on the additional SOA extensions you enable, you can also monitor transactions across any combination of Oracle Service Bus, IBM WebSphere Process Server, IBM WebSphere Enterprise Service Bus, TIBCO BusinessWorks, webMethods Integration Server, or IBM WebSphere MQ components.

It is also common for the SOA environment to include both composite applications that are linked to the SOA infrastructure through adapters and new applications that use standardized protocols such as SOAP and XML. Because the environment includes both legacy and new applications, you may need to monitor applications that use various transports and payload types. For example, with CA APM for SOA, you can monitor applications that use SOAP over HTTP, SOAP over JMS, XML over HTTP, or other messaging transports and protocols.

Understanding the Architecture for Monitoring SOA



CA APM for SOA provides the following lightweight components for CA Introscope:

A SOA-specific extension to the Java or .NET Agent

A SOA-specific management module for the Enterprise Manager

The agent extension enables the agent to monitor Java- and .NET-based web services on supported application servers and send information about the performance of those web services to the Enterprise Manager.

The SOA-specific extension to the Enterprise Manager enables the SOA-specific information collected by the agent to be displayed using the CA Introscope Workstation in SOA-specific dependency maps, dashboards, Investigator nodes, and tabs.



The following figure illustrates the basic architecture with the agent and CA APM for two application servers. The application servers send and receive web service requests and report web service data to a single Enterprise Manager with CA APM for SOA enabled.

Additional SOA Platform Support



In addition to the functionality provided by CA APM for SOA, there are several additional SOA platforms that you can monitor. Depending on your environment, you may be able to monitor the following additional SOA platforms:

Oracle Service Bus (OSB) is an Enterprise Service Bus that handles message distribution and transformation for Oracle WebLogic.

TIBCO BusinessWorks is a business service development and processing engine.

TIBCO Enterprise Message Service enables synchronous and asynchronous communications between systems throughout the enterprise using queues, topics, and advanced components such as bridges, multicast channels, and routes.

webMethods Broker provides asynchronous processing and message handling services to publish and deliver documents.

webMethods Integration Server provides infrastructure components to enable organizations to create, orchestrate, and integrate business processes and web services.

IBM WebSphere Process Server (WPS) with IBM WebSphere Enterprise Service Bus (WESB) is an integration platform that includes message handling through WebSphere Enterprise Service Bus.

IBM WebSphere Enterprise Service Bus (WESB) as a standalone product. WebSphere Enterprise Service Bus manages message flow, data transformation, and routing between services and clients with the help of mediation flows and primitives.



Most of the SOA platform extensions add files to the agent and Enterprise Manager. For example, the following figure illustrates adding the SOA extension for TIBCO BusinessWorks to the application server and the Enterprise Manager:

For some SOA extensions, the agent cannot be used. For example, the SOA extension for TIBCO Enterprise Message Service uses a standalone agent. For more information about any SOA extension, see the appropriate chapter for that extension.


Chapter 2: Installing and Configuring CA APM for SOA

This section contains the following topics:

Installation and Configuration (see page 27) CA Introscope Components and Versions (see page 28) How to Add CA APM for SOA to an Agent (see page 31) Enable Extensions on the Enterprise Manager (see page 37) Verify the CA APM for SOA Deployment (see page 40) Remove CA APM for SOA (see page 41)

Installation and Configuration

You can install and configure CA APM for SOA on the agent and Enterprise Manager in the following ways:

Is the Agent Installed? Is CA APM for SOA Enabled? Next Steps

Yes Yes Enable Extensions on the Enterprise Manager (see page 37).

Yes No Add CA APM for SOA Manually to an Agent (see page 33).

No No Review CA APM for SOA Prerequisites (see page 28).

Add CA APM for SOA to an Agent (see page 31).

Note: Use this information with the information in the CA APM Java Agent Implementation Guide or the CA APM .NET Agent Implementation Guide to complete the installation.

CA Introscope Components and Versions



CA APM for SOA provides an extension to CA Introscope that enables monitoring of service-oriented architectures and web services. You can install CA APM for SOA at the same time you install core CA Introscope components or separately after you install core CA Introscope components. Whether you install CA APM for SOA with CA Introscope or you install CA APM for SOA separately, install the following CA Introscope components and versions:

The Java agent or the .NET agent must be at the same version as CA Introscope.

The Enterprise Manager must be at the same version as the agent or at a higher version than the agent.

Basic system requirements for agents

CA APM for SOA adds files to the Enterprise Manager and the agent. Because CA APM for SOA extends the agent, the minimum system requirements for processing, memory, and available disk space are the same as the requirements for the agent.

See the following guides for specific information about CA APM system requirements:

For basic memory and disk space requirements, see CA APM Installation and Upgrade Guide.

For guidelines on adjusting processing load and managing system resources, such as CPU, see the CA APM Sizing and Performance Guide.

For the minimum JVM and JRE versions and related JVM memory requirements, see the CA APM Java Agent Implementation Guide.

In addition to the basic agent requirements, CA APM for SOA-enabled agents require a supported SOAP engine to be available in the local operating environment. For supported SOAP engines, see to the CA APM Compatibility Guide. The SOAP engine you use determines the SOAP stack implementation and type of web service message exchanges the agent can support.

SOAP and Application Server Requirements for Agents

The operating system and application server you use determine the SOAP engine and SOAP stack implementation available to handle web service messages. For example, applications on a computer using Apache Axis 2.0 can process SOAP messages using either JAX-RPC or JAX-WS.



Native SOAP Engine Support for Java Agents

If you add CA APM for SOA to a Java agent, the agent can support various SOAP engines and application programming interfaces (APIs). Depending on the application server and version, the agent supports SOAP stack implementations that adhere to native, JAX_RPC, or JAX-WS standards.

Note: For a complete list of the application servers and SOAP stack implementations that the agent supports in the current version, see the CA APM for SOA section of the Compatibility Guide.

Native SOAP Engine Support for .NET Agents

By default, the .NET agent supports the monitoring of ASP.NET web services. If you add CA APM for SOA to a .NET agent, the agent provides standard web service naming and additional dependency-related metrics and dependency-based mapping for the SOAP communication services you are using. To support the monitoring of web services on the .NET agent using the .NET Framework, you can use the following web services:

Standard ASP.NET web services

Windows Communication Foundation (WCF) web services

In addition to the .NET Framework, use the following attributes to monitor ASP.NET web services:

Server-side web services must have the WebMethod attribute applied.

Client-side web services must have the SOAPDocumentMethod, HttpMethod, or SoapRpcMethod attribute applied.

Note: For information about SOAP support, see the SOA Performance Management section of the Compatibility Guide. For information about these attributes or how to apply them to methods or classes, see the Microsoft Developer Network (MSDN) Library.

Understanding Directory and File Naming Conventions

This guide uses the following conventions in file names and directory paths:

Where you see It indicates

The top-level directory where the agent is installed. This directory is typically named wily.

The top-level directory where the Enterprise Manager is installed.



Where you see It indicates

Version-specific identifier included in file names or displayed in the user interface.

For example, the following file name:

com.wily.introscope.soa.dependencymap_.jar

represents a version-specific file name, such as:

com.wily.introscope.soa.dependencymap_v9.1.0.0.jar

Forward slash (/) path separators

The path separator used in directory names on the platform you are using.

The forward slash (/) is used on UNIX platforms and in examples throughout this guide, but you should use the separator appropriate to the platform you are using.

Dollar sign ($) environment variables

The environment variable notation used on your platform.

The dollar sign ($) is used on UNIX platforms and in examples throughout this guide, but you should use the character appropriate to the platform you are using.

Backing Up Before Upgrading From a Previous Version

If you are upgrading from a previous version of Web Services Manager or CA APM for SOA, back up your current environment and save the existing files in a backup directory before adding the CA APM for SOA agent or Enterprise Manager files.

If you are upgrading from a previous version, do the following:

Copy the existing /IntroscopeAgent.profile file to a backup directory.

Copy the existing /webservices.pbd file to a backup directory.

Copy the existing /modules/SPM_ManagementModule.jar file to a backup directory.

If you are upgrading from a previous version and the agent is a .NET agent, do the following:

Verify that you have uninstalled the older version of the .NET agent before installing a new version of the .NET agent.

Verify that the .NET agent and the CA APM for SOA files you want to upgrade are at the same version level. A mismatch in version information can cause errors and prevent applications from being monitored.

How to Add CA APM for SOA to an Agent



You can add CA APM for SOA and SOA-related extensions to an agent automatically when you install the agent interactively or silently using a response file. You can also add CA APM for SOA and other SOA-related extensions to an agent manually after installing the agent.

Depending on the type of installation you choose, perform the appropriate task:

Selecting CA APM for SOA in the Standalone agent installer (see page 31)

Adding CA APM for SOA during silent installation (see page 32)

Adding CA APM for SOA manually to an agent (see page 33)

After installing or updating an agent to include CA APM for SOA, see Configuring agent properties after installation (see page 35) for information about configuring the application environment. If you want to monitor other SOA platforms, such as Oracle Service Bus or TIBCO BusinessWorks, you can also install those files interactively, using a response file, or manually after installing the agent and selecting CA APM for SOA. For more information, see How to enable SOA platform extensions (see page 35).

Selecting CA APM for SOA in the Standalone Agent Installer

If you install the agent interactively, you have the option to add CA APM for SOA and other monitoring extensions as a step in the installation process. The specific options displayed in the Standalone agent installer depend on the agent and the application server you select. For example:

Select Default, JBoss, Tomcat, WebLogic, or WebSphere as the application server if you want to enable CA APM for SOA

Select WebLogic as the application server if you want to enable CA APM for Oracle Service Bus

Select Default as the application server if you want to enable CA APM for TIBCO BusinessWorks or CA APM for webMethods Integration Server

Select WebSphere as the application server if you want to enable CA APM for WebSphere Process Server with WESB or CA APM for WebSphere Enterprise Service Bus (WESB) as a standalone product.

For example, if you run the Standalone agent installer interactively on Windows and select Default as your application server, you can select CA APM for SOA and CA APM for TIBCO BusinessWorks or CA APM for webMethods Integration Server as monitoring options.



If you select the CA APM for SOA option in the Standalone agent installer, the related files for the agent are automatically copied to the appropriate directory in the agents home directory and the agents profile is automatically updated to include the appropriate ProbeBuilder directives files for monitoring SOA environments. For example, appmap-soa.pbd and webservices.pbd are automatically added to the introscope.autoprobe.directivesFile property.

If you install CA APM for SOA using the Standalone agent installer, perform the next steps for configuring (see page 35) Java and .NET agents.

Use Silent Mode to Enable CA APM for SOA for the Agent

If you install the agent in silent mode, you can use settings in the response file. These settings let you specify whether you want to enable CA APM for SOA

apm_9.5--apm for soa implementation guide

Documents

ca software

ca database performance

ca copyright notices

proprietary information

applicable license agreement

software products

available copies

internal use