Reference Guide

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Oracle TSAM Reference Guide

The Oracle TSAM Reference Guide describes, system processes and commands delivered with the Oracle TSAM software.

Table 1 lists the Oracle TSAM system processes and commands.

Table 1 Oracle TSAM System Processes and Commands 
Name
Description
tpgetcallinfo
Routine for retrieving call path message monitoring attributes
LMS (Local Monitor Server)
The Oracle TSAM Agent Local Monitor Server

 

tpgetcallinfo

Name

tpgetcallinfo()—Routine for retrieving call path message monitoring attributes.

Synopsis

int tpgetcallinfo(const char *msg, FBFR32 **obuf, long flags)

Description

tpgetcallinfo() is used for call path monitoring only. It supports the following parameters:

msg

The typed buffer use for measurement.

obuf

The FML32 buffer used to contain the fields.

flags

Reserved for future use.

For monitored calls, tpgetcallinfo()uses the following fields: following fields:

tpgetcallinfo()

Retrieves the message monitoring attributes when call path monitoring is enabled.

tpgetcallinfo()

Can be used in different scenarios to accomplish different functions. Typical usage is as follows:

Table 2 lists the FML monitor metrics field names.

Table 2 Monitor Initiator Field Names
Field Name
Type
Description
Service
Monitoring
Initiator
TA_MONCORRID
string
The monitored call correlation ID. It is a critical call path monitoring metric.
Y
Y
TA_MONLASTTIMESEC
long
Timestamp for the last stop on the call path tree in seconds.
Y
Y
TA_MONLASTTIMEUSEC
long
Ttimestamp of last stop on the call path tree in microseconds.
Y
Y
TA_MONSTARTTTIMESEC
long
Timestamp when the monitoring initiator starts the call in seconds.
Y
Y
TA_MONSTARTTIMEUSEC
long
Timestamp of the monitoring initiator starts the call in microseconds.
Y
Y
TA_MONCLTADDR
string
The workstation client address
Y
N
TA_MONTOTALTIME
long
The end-to-end time used for a monitored call in milliseconds.
N
Y

Return Values

Upon successfully getting a FML32 buffer containing the monitoring attributes, returns 0.

Upon failure, tpgetcallinfo() returns -1 and sets tperrno to indicate the error condition.

Errors

Upon failure, tpgetcallinfo() sets tperrno to one of the following values,

[TPEINVAL]

Invalid arguments were given (for example, msg is NULL or obuf is not a valid FML32 buffer)

[TPESYSTEM]

The message input does not contain monitoring attributes. Usually this is because the call path monitoring is not turned on for the message.

[TPEOS]

An operating system error has occurred.

Example(s)

Listing 1-1 provides a service-side tpgetcallinfo example.

Listing 1-1 Service-Side tpgetcallinfo Example 
#include <stdio.h>
#include <atmi.h>
#include <userlog.h>
#include <fml32.h>
#include <tpadm.h>  
#if defined(__STDC__) || defined(__cplusplus)
tpsvrinit(int argc, char *argv[])
#else
tpsvrinit(argc, argv)
int argc;
char **argv;
#endif
{

       /* tpsvrinit logic */
#ifdef __cplusplus
extern "C"
#endif
void
#if defined(__STDC__) || defined(__cplusplus)
APPSVC(TPSVCINFO *rqst)
#else
TOUPPER(rqst)
TPSVCINFO *rqst;
#endif
{
       FBFR32 *metainfo;
       int len = 0;
       /* Allocate the metainfo space */
       metainfo = tpalloc("FML32", NULL, 1024);
       if (metainfo == NULL ) {
              userlog("Memory allocation failed");
              tpreturn(TPFAIE, 0, 0, 0);
       }
       /* Get the monitoring attributes*/
       if ( tpgetcallinfo(rqst->data, &metainfo, 0) == 0 ) 
       {
              char *corrid;
              long laststopsec, starttimesec;
              if ((corrid = Ffind32(metainfo, TA_MONCORRID, 0, &len) ) {
                     userlog("Correlation ID = %s", corrid);
              }
              len = sizeof(starttimesec);
              if (( Fget32(metainfo, TA_MONSTARTTIMESEC, &starttimesec, &len) == 0) {
                     userlog("Message beginning time = %ld", starttimesec);
              }
}
              len = sizeof(lasttimesec);
       if (( Fget32(metainfo, TA_MONLASTTIMESEC, &lasttimesec, &len)  == 0) 		{
              userlog("Message entering my queue time = %ld", lasttimesec);
       }
       }
       tpfree(metainfo);
       /* rest of service processment */
       ......
}

 

LMS (Local Monitor Server)

Name

LMS—The Oracle TSAM Agent Local Monitor Server

Synopsis

LMS SRVGRP=“identifier” SRVID=“number” [other_parms]
CLOPT= “-A -- -l tsam-manager-dataserver-url [-t heartbeat-interval]
[-x internal-queue-size-limit] [-e log-warning-interval]”

Description

LMS is an Oracle TSAM Agent Tuxedo server. It provides the following functions:

The LMS must be configured in the UBBCONFIG file and set with the proper options. Only one LMS can be deployed per Tuxedo machine.

Options

-l

Mandatory parameter. It is followed by the Oracle TSAM manager data server. The host address and port number are set based on your Oracle TSAM manager installation.
Note: tsam/dataserver is the data server address. It strongly recommended that tsam/dataserver is not changed.
For TCP/IP addresses, one of the following formats is used as shown in Table 1-1.

Table 1-1 Ipv4 and IPv6 Address Formats
IPv4
IPv6
//IP:port
//[IPv6 address]:port
//hostname:port_number
//hostname:port_number
//#.#.#.#:port_number
Hex format is not supported

For more information, see TMUSEIPV6 in the TUXENV(5) environment variable listing found in the Tuxedo 10g R3 Reference Guide, Section 5 - File Formats, Data Descriptions, MIBs, and System Processes Reference.

-x

Optional parameter. It limits the LMS max internal queue size. Its range is [1001-999999]. The messages sent from the Oracle TSAM default plug-in are stored in the queue first. If the system load is heavy, the queue may consume a lot of memory. The -x option allows you to adjust the amount of memory used by LMS. The default is 100000.
If the internal queue max size is reached, the oldest message is dropped and the latest one is added.

-t

Optional parameter. It specifies the time interval in seconds that LMS should connect to the Oracle TSAM manager if there is no performance activity. Its range is [1-60]. The default value is 30 seconds.

-e

Optional parameter. It specifies the time interval LMS sends a warning message to ULOG if performance metrics data is dropped due to queue size limit. Its range is [1-65535]. The default value is equal the -t value. The warning message reports how many messages have been lost during the past interval.

Environment Variable(s)

TM_MON_REPORT_LOG

Controls the reporting time interval for the following message in the event the plug-in fails to call the LMS server:
LIBTUX_CAT:6774: WARN: LMS server is unavailable currently
Note: You must manually set TM_MON_REPORT_LOG.
TM_MON_REPORT_LOG has a range (in seconds) of [0,65535]. The the time 60s. TM_MON_REPORT_LOG=0, indicates that the warning message is disabled.

Example(s)

Listing 1-2 shows the LMS in UBBCONFIG.

Listing 1-2 LMS in UBBCONFIG 
...
*SERVERS
LMS SRVGRP=LMSGRP SRVID=1 MINDISPATCHTHREADS=1 MAXDISPATCHTHREADS=5 
CLOPT=”-A -- -l tsamweb.abc.com:8080/tsam/dataserver -x 200000 -t 60 -e 120”
...

LMS Notes

LMSSVC and Security

The communication channel between a plug-in and the LMS is based on the Tuxedo service infrastructure. LMSSVC is the service advertised by LMS to receive requests. If ACL and MANDATORY ACL are used in UBBCONFIG, LMSSVC should be configured to allow all monitored processes access.

How Many LMS Deployed in One Domain

It is recommend that you deploy one LMS for each machine so that IPC queue communication through local processes to LMS is limited.
Note: A single LMS can be used by multiple machines, but it will consume network bandwidth and extend the BRIDGE computing cycle. The overall Tuxedo application performance may be significantly impacted.

  Back to Top       Previous  Next