# Plug-in Programming Guide

# BEA TSAM Agent Data Collection Framework

This topic contains the following sections:

- Overview

## Overview

The BEA TSAM Agent enhances Tuxedo infrastructure to collect the performance metrics when TSAM is enabled. The instrument covers the major performance sensitive areas in Tuxedo applications, that is call path stages, services, transactions and system servers. TSAM Agent uses Tuxedo FML32 typed buffer to contain the metrics collected so that each metric is defined as a built-in FML32 field. The monitoring points depend on the monitoring types and only apply to Tuxedo ATMI applications. Listing 2-1 lists the monitoring points.

Table 2-1 Call Path Monitoring Points
Stage | Supported Tuxedo Process Types
Before request message sent to IPC queue | Native Client, Application Server, GWTDOMAN, BRIDGE
Request sent to IPC queue failure | Native Client, Application Server, WSH and JSH
After request message got from IPC queue | Application Server, GWTDOMAIN
Before reply message sent to IPC queue | Application Server, GWTDOMAIN, BRIDGE
After reply message got from IPC queue | Native Client,Application Server, GWTDOMAIN
Before request message sent to network | GWTDOMAIN
After request message got from network | GWTDOMAIN
Before reply message sent to network | GWTDOMAIN, WSH,JSH
After reply message got from network | GWTDOMAIN

Table 2-2 Service Monitoring Points
Stage | Supported Tuxedo Process Types
After request1 message got from IPC queue | Application Server, GWTDOMAIN
Before reply message sent to IPC queue | Application Server,GWTDOMAIN

1Only data collection point, no plug-in invocation

Table 2-3 System Server Monitoring Points
Stage | Supported Tuxedo Process Types
Main Loop1 | GWTDOMAIN, BRIDGE

1The metrics are collected internally and this point is to pass the data to plug-in

Table 2-4 Transaction Monitoring Points
Stage | Supported Tuxedo Process Types
Before the1 transaction routine executed | Native Client, Application Server, TMS, GWTDOMAIN,WSH, JSH, TMQFORWARD
After the transaction routine executed | Native Client, Application Server, TMS, GWTDOMAIN,WSH, JSH, TMQFORWARD

1Only data collection point, no plug-in invocation

Note: | The monitoring point is not necessarily added for all the message processing stages. It depends on the process internal running model. For example, when BRIDGE or WSH receives a message from the IPC queue, the message is forwarded to the network immediately. In this case, there is only one monitoring point (point l).