46 BRM Monitoring Utilities and Scripts

Learn about the syntax and parameters for the Oracle Communications Billing and Revenue Management (BRM) monitoring utilities and scripts.

Topics in this document:

• pstatus

• start_it

• start_monitor

• stop_monitor

pstatus

Use this utility to write Perflib performance data to trace log files. Optionally, it can also generate a counter report or error report.

For more information, see:

• Enabling Monitoring of Your CM

• Enabling Monitoring of Your Oracle DM

• Enabling Selective Opcode Tracing

Location

BRM_home/bin

Syntax

pstatus [-h] [-ttimingFlag] [-fflistFlag] [-FopcodeNameorNumber] [-aalarmFlag] 
        [-v] [-x] [-H] [-z] [-sopDelay|-SopDelay] [-eerrorDelay|-EerrorDelay] [-r|-R] 
        [-ccolumns|-Ccolumns] dataFile

Parameters

-h

Displays the syntax and parameters for this utility.

-ttimingFlag

Specifies whether to provide timing data:

• 0: Does not provide timing data. This is the default.

• 1: Provides real-time map file timing.

• 2: Provides detailed aggregate timing.

-fflistFlag

Specifies whether to provide flist tracing:

• 0: Does not provide flist tracing data. This is the default.

• 1: Provides summary flist tracing data.

• 2: Provides detailed flist tracing data.

-FopcodeNameorNumber

Specifies to generate tracing data for a specified opcode name or opcode number. For example, -F108 specifies to enable flist tracing for the PCM_OP_SUBSCRIPTION_PURCHASE_DEAL opcode.

If you list multiple opcodes, use a comma as a delimiter. If the parameter is empty or missing, the utility traces all opcodes.

-aalarmFlag

Specifies whether to include alarm data: off (0) or on (non-zero number). The default is off.

-v

Specifies to show variable settings.

-x

Specifies to print the data in CSV format.

-H

Show a header for every output. Use -H only with the -s or -S parameters.

-z

Specifies to skip counters with zero calls.

-sopDelay|-SopDelay

Specifies to provide opcode statistic totals (-s) or opcode statistic differences (-S). If opDelay is set, the data is printed at the specified frequency in seconds.

-eerrorDelay|-EerrorDelay

Specifies to provide error statistic totals (-e) or error statistic differences (-E). If errorDelay is set, the data is printed at the specified frequency in seconds.

-r|-R

Specifies to reset the counters (-r) or the errors (-R).

-ccolumns

Specifies to create a counter report with the specified list of columns in the order listed.

Note:

You can generate a counter report or an error report, but not both concurrently.

Table 46-1 lists the columns that you can include in the counter report. For example, -csPnt specifies to include these columns in the counter report in the order shown: Timestamp, Program, Opcode name, and Elapsed. The default options are sponceNtaARP.

Table 46-1 Counter Report Columns

Option	Column Name	Description
s	Timestamp	The timestamp when the data was collected.
p	Program	The name of the program.
o	Opcode number	The opcode number, which can be found in the opcode's associated header file.
n	Opcode name	The opcode name.
f	OpFlags	The opcode flags.
F	Filename	The file name.
L	Line#	The line number in the source code.
C	Source	The code source, which combines the file name and line number.
O	Object Type	The object type for database operations.
d	DbNo	The database number.
D	DbNoStr	The database number string, such as 0.0.0.1.
c	Calls	The number of calls made.
e	Errors	The number of errors.
N	Records	The number of records.
t	Elapsed	The aggregate elapsed time.
a	OpRate/s	The average operation throughput time.
r	OpAvg	The average rate in operations.
A	SysAvg	The average system run time.
R	SysRate/s	The average system throughput rate as operations per second.
P	PID	The process ID (PID) of the program that created the file.
U	User CPU	The user of the CPU.
S	System CPU	The system CPU.
all	N/A	A special string to show all supported columns.

-Ccolumns

Specifies to create an error report with the specified list of columns in the order listed. The -Ccolumns parameter is only permitted with the -eerrorDelay or -EerrorDelay parameter.

Note:

You can generate a counter report or an error report, but not both concurrently.

Table 46-2 lists the columns that you can include in the error report. For example, -CsOeE specifies to include these columns in the error report in the order shown: Timestamp, Opcode name, Error count, and Error rate. The default options are sOCLNeP.

Table 46-2 Error Report Columns

Option	Column Name	Description
s	Timestamp	The timestamp
o	Opcode	The opcode number, which can be found in the opcode's associated header file.
O	Opcode name	The opcode name.
p	Program	The name of the program.
c	ErrClassStr	The error class string.
C	ErrClass	The error class number.
l	ErrLocStr	The error location string.
L	ErrLoc	The error location number.
n	ErrNumStr	The error number string.
N	ErrNum	The error number.
d	DbNo	The database number.
D	DbNoStr	The database number string, such as 0.0.0.1.
e	Err Count	The number of errors.
E	ErrRate/s	The error rate.
P	PID	The process ID (PID) of the program that created the file.
all	N/A	A special string to show all supported columns.

dataFile

Specifies the name of the input memory mapped data file (*.dat) that contains the performance data.

Results

The utility notifies you only if it encounters errors.

start_it

Use this utility to start BRM processes using the Performance Library (Perflib).

Note:

To trace batch applications, ensure you set the LD_PRELOAD environment variable to trace opcodes that are initiated in a client.

Location

BRM_home/apps/perflib

Syntax

start_it  [-ddirectory] [-n] command [arg1 arg2 argn ...]

Parameters

-ddirectory

Specifies the directory containing the performance library settings (the perf.env or perf_dm.env file). The default is the directory in which you run the utility.

-n

Specifies to not preload the libperflib.so shared library for the application to use.

command

Specifies the command to run, such as start_cm or start_dm_oracle.

arg1 arg2 argn ...

Specifies the optional arguments, such as pin_bill_accts -test.

Results

The utility notifies you only if it encounters errors.

start_monitor

Use this utility to start exposing metrics for the specified application.

Location

BRM_home/apps/perflib

Syntax

start_monitor [-h] [-a32|-a64] [-fpidFile] [-pjmxPort] [-llogFile] [-D] [-s] 
              [-PhttpPort] [-bbackLog] [-Sfrequency] [-tthreads] fdataFile,afilename

Parameters

-h

Displays the syntax and parameters for this utility.

-a32|-a64

Specifies the size of the architecture: 32 bits or 64 bits. The default is 64 bits (-a64).

-fpidFile

Specifies the name of the PID file in which to write the process ID. The default is monitor.pid.

-pjmxPort

Specifies the JMX port number for exposing metrics. The default is 1617.

-llogfile

Specifies whether to include alarm data: off (0) or on (non-zero number). The default is off.

-D

Enables metrics for the Oracle DM shared memory, front-end processes, and back-end processes.

-s

Specifies to use password protection to connect to Perflib-controlled applications. The user names and passwords must be defined in monitor.password.

-PhttpPort

Specifies the HTTP port number for exposing metrics (http://httpServer:httpPort/metrics). If provided, the utility starts the HTTP server.

-bbackLog

Specifies the permissible connection backlog for the server. The default is 0.

-Sfrequency

Specifies the sleep time for debug mode. When debug mode is enabled in your Log4j configuration, the monitor prints statistics at the frequency specified.

-tthreads

Specifies the number of threads for the HTTP Server. The default is 1.

fdataFile, afilename

Specifies the name of Perflib data files to monitor. Replace fdataFile with the name of the Perflib data file, and replace afilename with the name used to expose data via JMX.

Results

The utility notifies you only if it encounters errors.

stop_monitor

Use this utility to stop monitoring the specified application.

Location

BRM_home/apps/perflib

Syntax

stop_monitor  [-h] [-fpidFile]

Parameters

-h

Displays the syntax and parameters for this utility.

-fpidFile

Specifies the name of the PID file containing the process ID to stop. The default is monitor.pid.

Results

The utility notifies you only if it encounters errors.