Tools for Administrators

This article discusses the tools provided by RA that administrators can use to monitor and manage the system. The following table lists the tools and their location.
cara
This article discusses the tools provided by RA that administrators can use to monitor and manage the system. The following table lists the tools and their location.
Tool
Location
DBUtil
On Windows:
<
install_location
>\Arcot Systems\tools\win
On UNIX Platforms:
<
install_location
>/arcot/tools/<
platform_name
>
arrfversion
On Windows:
<
install_location
>\Arcot Systems\bin\
On UNIX Platforms:
<
install_location
>/arcot/sbin/
arrfclient
arrfserver
arrfupload
arrfstatsmonitor
This article describes the following tools:
2
DBUtil Risk Analytics Database Tool
During RA installation, the installer collects the information to connect to the RA database. After the installation is completed, this information is stored in an encrypted format in a file called
securestore.enc
. This file stores the following encrypted information that you need to connect to the RA database:
  • Database user name and password (Used by Transaction Server to connect to the database.)
  • Master key (Used for encrypting the database user name and password that is stored in
    securestore.enc
    .)
RA supports both software and hardware modes to protect the data. The
DBUtil
tool can be used to perform database operations for both the modes.
If for some reason you need to add a new database user name, password, or DSN or change the master key value any time
after
installation, then you can use DBUtil to perform these tasks.
This section includes the following:
Because the master key is used for encrypting sensitive information, for security reasons, the DBUtil tool
does not
provide any option to view the key value.
Update the Master Key
Specified during installation, the
master key
is used to encrypt the values in the
securestore.enc
file. It also encrypts all encryption keys that are used by the product and are stored in the RA database.
If for security reasons you need to change the master key value in
securestore.enc
, then:
  1. Back up the current
    securestore.enc
    file.
    The current
    securestore.enc
    is available at:
    • On Windows
      <install_location>\Arcot Systems\conf
    • On UNIX-based Platforms
      <install_location>/arcot/conf
  2. Delete the
    securestore.enc
    in ARCOT_HOME\conf\.
  3. Navigate to the following location where DBUtil is available:
    • On Windows
      <install_location>\Arcot Systems\tools\win
    • On UNIX-based Platforms
      <install_location>/arcot/tools/<platform_name>
  4. Run the following command:
    • (Windows, for software mode)
      dbutil -init <master_key_name>
    • (Windows, for hardware mode)
      dbutil -init <HSM_Key_Label>
    • (UNIX, for software mode)
      ./dbutil -init <master_key_name>
    • (UNIX, for hardware mode)
      ./dbutil -init <HSM_Key_Label>
    The tool re-creates
    securestore.enc
    with the master key name that you specify.
    If the master key setup fails, contact CA Arcot Suppor at for help.
  5. Update the database information in the
    securestore.enc
    file.
    The RA installer automatically configures the database username/password and database DSN/password information in
    securestore.enc
    . However, after creating a new
    securestore.enc
    file, you must manually insert this information in the new file. You need to use the
    dbutil -pi
    option to do so.
    To insert the supplied database values in securestore.enc, use the following commands:
    • (Windows, for software mode)
      dbutil -pi <dbUser> <dbPassword>
    • (Windows, for hardware mode)
      dbutil -pi <dbUser> <dbPassword> [-h HSMPin [-d HSMModule]]
    • (UNIX, for software mode)
      ./dbutil -pi <dbUser> <dbPassword>
    • (UNIX, for hardware mode)
      ./dbutil -pi <dbUser> <dbPassword> [-h HSMPin [-d HSMModule]]
      In the preceding commands,
      dbUser
      is the database user name and
      dbPassword
      is the password associated with the specified user name. For example, on Windows:
      dbutil -pi arcotuser welcome123
    The user name and DSN Name that you specify in this command is case-sensitive.
  6. If you have performed distributed deployment of RA, then you must copy the new securestore.enc file to all the systems where RA components are installed.
Use DBUtil Options
The following table lists the options for
DBUtil
. In this table,
key-value
pair refers to either DSN, password, or database username/password pair. The DSN/password is used by Transaction Server, while user name/password is used by Administration Console and User Data Service.
Because the master key is used for encrypting sensitive information, for security reasons, the DBUtil tool
does not
provide any options to view the key value.
Ensure that you run all examples and commands in the following table from the directory where the DBUtil tool is located.
Option
Description
-h
Displays the Help for the tool.
Syntax (Windows):
dbutil -h
Syntax (UNIX):
./dbutil -h
-init
Creates a new securestore.enc with the new master key that you specify, as discussed in  Update theMasterKey.
Syntax (Windows):
dbutil -init key
Syntax (UNIX):
./dbutil -init key
For example (Windows):
dbutil -init MasterKeyNew
dbutil -init RiskAnalyticsDatabaseMKNew
Important!
This command succeeds only if there is no securestore.enc in the conf directory.
-pi
Inserts an additional key-value pair into securestore.enc.
Syntax (Windows):
dbutil -pi <key> <value> [-h HSMPin [-d HSMModule]]
Syntax (UNIX):
./dbutil -pi <key> <value> [-h HSMPin [-d HSMModule]]
-h HSMPin
is required if
securestore.enc
is protected by HSM cryptography.
-d HSMModule
is optional when
-h
is present. It defaults to "nfast"
(NCipher).
For example (Windows):
dbutil -pi RiskAnalyticsBackupDSN dbapassword
dbutil -pi Jack userpassword
dbutil -pi Jack userpassword -h hsmpassword -d chrysalis
Important!
Each key can have only one value. If you have already inserted a key-value pair, then you cannot insert another value for the same key.
-pu
Updates the value for an existing key-value pair in securestore.enc. This feature can be used when you need to update the database password.
Syntax (Windows):
dbutil -pu <key> <value> [-h HSMPin [-d HSMModule]]
Syntax (UNIX):
./dbutil -pu <key> <value> [-h HSMPin [-d HSMModule]]
For example (Windows):
dbutil -pu RiskAnalyticsDatabaseDSN newPassword
dbutil -pu Jack userPassword
dbutil -pu Jack userpassword -h hsmpassword -d chrysalis
-pd
Deletes the specified key-value pair from securestore.enc.
Syntax (Windows):
dbutil -pd <key> [-h HSMPin [-d HSMModule]]
Syntax (UNIX):
./dbutil -pd <key> [-h HSMPin [-d HSMModule]]
For example (Windows):
dbutil -pd RiskAnalyticsDatabaseDSNOld
dbutil -pd Jack
-i
Inserts the specified primary name-value pair in securestore.enc, if hardware-based encryption is used to secure the data in this file. This is used during server startup to provide HSM initialization information.
Syntax (Windows):
dbutil -i <primeKey> <HSMPin>
Syntax (UNIX):
./dbutil -i <primeKey> <HSMPin>
where
primeKey
is the name of the HSM module.
For example (Windows):
dbutil -i chrysalis hsmpassword
-u
Updates the specified primary name-value pair in securestore.enc, if hardware-based encryption is used to secure the data in this file.
Syntax (Windows):
dbutil -u <primeKey> <HSMPin>
Syntax (UNIX):
./dbutil -u <primeKey> <HSMPin>
where
primeKey
is the name of the HSM module.
For example (Windows):
dbutil -u chrysalis newhsmpassword
-d
Deletes the specified primary name-value pair from securestore.enc, if hardware-based encryption is used to secure the data in this file.
Syntax (Windows):
dbutil -d <primeKey>
Syntax (UNIX):
./dbutil -d <primeKey>
where
primeKey
is the name of the HSM module.
For example (Windows):
dbutil -d chrysalis
arrfversion Risk Analytics Modules Version Display Tool
The
arrfversion
tool enables you to check and display the versions of Risk Analytics Rule and Plugin modules (
.dll
files on Windows and
.so
on UNIX-based platforms) that are available at the following directories (relative to ARCOT_HOME):
  • /
    bin
    /
  • /plugin/
    rules
    /
  • /plugin/rules/
    addon
    /
When you contact CA Suppor () for problems related to deployment and operation, make it a practice to specify the version of the deployed modules. This helps in faster identification and resolution of a problem.
Syntax:
The syntax to use the tool is:
Windows:
arrfversion <library1_path> [<library2_path> ...]
Unix:
./arrfversion <library1_path> [<library2_path> ...]
In the preceding syntax, the <
libraryN_path
> string specifies the name of an individual module, such as:
  • aradminprotocol.dll
    on Windows
  • libaradminprotocol.so
    on UNIX-based platforms
If you do not specify the absolute path of the library module, then the specified module is looked up in the folders specified by the standard environment variables. For example:
  • %PATH%
    for Windows
  • $LD_LIBRARY_PATH
    for UNIX-based platforms
Examples:
Windows:
arrfversion ScoreEngine.dll
 
UNIX-Based Platforms:
./arrfversion /opt/arcot/plugins/rules/libaradminprotocol.so
 
arrfclient Server Refresh and Shutdown Tool
The
arrfclient
tool enables you to gracefully shut down the server or refresh its cache without restarting it. In case of graceful shutdowns, the server allows all existing requests to complete while not accepting any new requests.
Before You Use the Tool
Before you use the tool, you must configure the settings in riskfortadminclient.ini. This file is available at the following location:
On Windows:
<install_location>\Arcot Systems\conf\
On UNIX Platforms:
<install_location>/arcot/conf/
The minimal parameters in this file that must be configured for the tool to work properly are listed in the following table.
Parameter
Default
Description
Host
localhost
The host name or the IP Address of the system where Transaction Server is running.
Port
7980
The port number on which the server is listening to server management requests.
Transport
tcp
The transport mode for server management listener.
These settings ensure the typical TCP-based communication between the tool and Transaction Server.
How to Run the Tool in Interactive Mode
The tool provides the
-i
option to run it in the interactive mode. When run in this mode, the server starts its own console prompt (#).
To run the arrfclient tool in the interactive mode:
  1. Navigate to the location where the tool is available:
    • On Windows:
      <install_location>\Arcot Systems\bin\
    • On UNIX-based platforms:
      <install_location>/arcot/bin/
  2. Run the following command:
    Windows: arrfclient -i Unix: ./arrfclient -i
    The tool starts in interactive mode.
  3. Specify the options listed in the following table to perform the required task:
Options
Description
?
Lists the commands for all the options supported by arrfclient.
cr
Refreshes the cache of the server instance. You must enter the instance IP and
the server management port number.
The instance IP is the IP address or the host name at which Transaction Server or Case Management Server is available.
The port number at which Transaction Server or Case Management Server listens to the operations requests.
Note:
By default, Transaction Server is available on port 7980.
After successful operation, the message "Instance refreshed successfully" and a transaction ID is returned.
sd
Shuts down the Transaction Server instance. You must enter the instance IP and the server management port number.
After successful operation, the message "Successfully initiated shutdown operations" and a transaction ID is returned.
q
Closes the interactive mode.
arrfserver Transaction Server Tool
The
arrfserver
tool enables you to troubleshoot Transaction Server connection errors (for example, if it is not coming up) and allows you to configure the following setting from the command line in interactive mode:
  • The authentication and authorization settings for RA Web services.
  • The RA settings that are either used rarely or are needed only under certain deployment scenarios.
  • The RA configurations that are not exposed through Administration Console.
How to Run the Tool in Interactive Mode
The tool provides the
-i
option to run it in the interactive mode. In this mode all the server configurations are done in a similar fashion as that in the service mode, except that the listeners are not started.
When run in this mode, the server starts its own console prompt (#).
To run the arrfserver tool:
  1. Navigate to the location where the tool is available:
    • On Windows:
      <install_location>\Arcot Systems\bin\
    • On UNIX-based platforms:
      <install_location>/arcot/bin/
  2. Run the following command:
    Windows: arrfserver -i Unix: ./arrfserver -i
    The tool starts in interactive mode.
  3. Specify the options listed in the following table to perform the required task.
Option
Description
?
Lists the commands for the
all
the options supported by arrfserver.
??
Searches the commands based on the pattern you provide.
For example, if you enter ?? conf, then all the tool options that match the pattern are displayed.
help
Explains the specified command in more detail.
For example, if you enter help setsaconf, then the usage of the command is briefly explained.
setsaconf
Enables you to configure the Web Services APIs that are provided by Transaction Server for authentication and authorization.
Note:
Do
not
use this option. This option was used in the previous release to configure the Web services for authentication and authorization. For more information about enabling Web Services for authentication and authorization, see How to Configure Web Services Authentication and Authorization.
q
Closes the interactive mode.
arrfupload Quova Data Upload Tool
RA uses Neustar IP Intelligence (formerly Quova) data to identify the geolocation information of a user by using the IP address of the system from which the transaction originated. It then uses this data to evaluate Negative Country, Negative IP, and Zone Hopping rules.
You must download the Neustar IP Intelligence data regularly. Data files for information related to geolocation must be downloaded every week, while the data files related to Anonymizer must be downloaded every month. Contact CA Support at for the details about the download procedure.
The
Risk Analytics Data Upload Tool
(
arrfupload
) is a command-line utility that enables you to upload the geolocation data from Neustar IP Intelligence files to the Risk Analytics database.
Before You Use the Tool
The
riskfortdataupload.ini
file controls the behavior of the RA Data Upload tool. It is available at the following location:
On Windows:
<install_location>\Arcot Systems\conf\
On UNIX Platforms:
<install_location>/arcot/conf/
You must configure the parameters in this file before you can use the tool.
Parameter
Default
Description
Tables
Do Not Load
The tables that the user can work with.
Possible values are:
  • GeoPoint
  • Anonymizer
Load
0
The indicator whether to upload the data to the table or not.
Possible values are:
  • 0 (Do not load)
  • 1 (Load)
Swap
0
The indicator whether to switch RA configuration to start using the table where GeoPoint or GeoAnonymizer data has just been uploaded.
Important!
The Transaction Server cache must be refreshed after this change.
Possible values are:
  • 0 (Do not swap)
  • 1 (Swap)
Filename
--
The name of the file from which the Neustar IP Intelligence data has to be loaded.
Important!
You must mention the absolute path to the file, along with the file name.
If both, Load and Swap are set to 1, the table is first loaded and then swapped.
How to Run the Tool
This tool is available at the following location:
On Windows:
<install_location>\Arcot Systems\bin\
On UNIX Platforms:
<install_location>/arcot/bin/
This tool uses the database information in the arcotcommon.ini file to connect to the RA database and uses the username and password specified in the
securestore.enc
file to authenticate to the database.
Syntax:
Run the following command to use the tool:
Windows: arrfupload <option> Unix: ./arrfupload <option>
The Neustar IP Intelligence information that you upload by using this tool is not available until you refresh the Transaction Server cache. For instructions on refreshing the cache, see Refreshing the Cache.
The following table lists the options supported by the utility.
Options
Description
-help
Lists
all
options supported by the tool, followed by the brief usage of the option.
-config
This option is used to read information from riskfortdataupload.ini (the configuration file used by the tool) and perform the required action.
This option uses the following flags:
Tables
:
The set of tables the user wants to update. The values allowed are either Geopoint or Anonymizer. If neither is specified, then no data is uploaded. This option does not have any default value.
Load
:
If set to 1, it indicates that the data will be uploaded and if set to 0, it indicates that data will not be uploaded. The default is value is 0.
Important!
If set to 1, the Filename and Tables flags
must
be set.
Swap
:
If set to 1, it indicates that the table will be swapped and if set to 0, it indicates that the table will not be swapped. The default value is 0.
Important!
This flag is valid only if the Tables flag is set correctly. Also, you must refresh the Transaction Server cache to use the new table.
Filename
:
Indicates the name and the path of the Neustar IP Intelligence file that contains the data to be uploaded.
Important!
This flag is valid only if the Load flag is set to 1.
-tnames
This option is used to display the current ARQGeoPoint and ARQGeoAnonymizer tables being used by the RA database.
-prompt
This option is used to display an interactive command-line menu that enables the user to select the table (ARQGeoPoint or ARQAnonymizer) that they want to update by using the latest Neustar IP Intelligence data. Based on the table specified by the user, a submenu with the following options appears:
Load Quova Data:
Depending on the set of tables chosen from the main menu, this option enables the data to be loaded in to the specified table. You must specify the name of the file from which Neustar IP Intelligence data has to be loaded and the path where this file is available.
Swap Quova Tables:
Depending on the set of tables chosen from the main menu, this option enables the user to swap tables.
Exit to the previous menu:
Enables the user to access the main menu.
Exit the program:
Enables the user to exit from the tool.
-prompt <<
Table name
> <
Load
> <
Swap
> <
Absolute path of the file
>> [<
Table name
> <
Load
> <
Swap
> <
Absolute path of the file
>]
This option is used to set up a scheduled task to upload both GeoAnonymizer and GeoPoint data.
arrfstatsmonitor Risk Analytics Statistics Monitoring Client
The RA Statistics Monitoring Client tool (
arrfstatsmonitor
) retrieves server statistics from Transaction Server and enables administrators to use the statistics to monitor the health of the system in real time. It also helps administrators detect any deterioration of system parameters so that they can correct the issues identified.
The arrfstatsmonitor tool performs the following tasks:
  • Processes the statistics data received from Transaction Server to derive additional statistics, such as Response Time Percentile information
  • Remembers the statistics data received across refreshes to present historical values or incremental change values
  • Collects additional information, such as CPU footprint and memory footprint
  • Presents the output on the client console
  • Stores the output in log files
You can run the
arrfstatsmonitor
tool
only
on the machine where Transaction Server is installed.
Managing Statistics Collection
A GA can choose to enable or disable statistics collection at the server by configuring the
Enable Risk Analytics Statistics Monitoring
parameter in the Miscellaneous Configurations page. However, the Transaction Server
must be
restarted if this parameter is updated.
Deployment Modes
You can choose to deploy the arrfstatsmonitor tool in one of the following modes:
  • File monitoring
  • On-demand UI monitoring
File Monitoring
In this mode, you launch the arrfstatsmonitor tool in the FILE mode by specifying a comma-separated list of instance IDs of multiple Transaction Servers that you want to monitor.
This can be registered as a Windows service or a cron job. You can schedule the job to reset the statistics counters every day at midnight.
On-Demand UI Monitoring
In this mode, you launch the arrfstatsmonitor tool in the UI mode by specifying the comma-separated instance IDs of Transaction Servers that you want to monitor.
Using the Tool
The
arrfstatsmonitor
tool is available at the following location:
On Windows:
<install_location>\Arcot Systems\bin\
On UNIX Platforms:
<install_location>/arcot/sbin/
Syntax:
Run the following command to use the tool:
Windows: arrfstatsmonitor.exe <option> Unix: ./arrfstatsmonitor <option>
The following table lists the options supported by the tool.
Options
Description
-id <
comma-separated-list-of-TransactionServer-instance-ids
>
Instance IDs of the Transaction Server processes from which you want to retrieve statistics.
You can specify one or more Transaction Server instance IDs if you want the tool to collect statistics from multiple Transaction Servers simultaneously and spool them out to a log file.
You can find the Transaction Server instance ID in the Transaction Server startup log file as Instance Sequence ID or in the Instance Management page (for Master Administrator).
For example:
arrfstatsmonitor.exe - id 1
Note
: This is a mandatory option.
To collect statistics from multiple servers in UNIX environments, see Collecting Statistics from Multiple Servers in UNIX Environments.
-refresh <
refresh-interval-in-seconds
>
The frequency at which the tool retrieves server statistics.
For example:
arrfstatsmonitor.exe - id 1 - refresh 120
Note
: If you do not specify a value, it defaults to 60 seconds.
-mode (UI | FILE)
The output mode to be set for the tool, which can be one of the following:
UI mode
: Displays statistics on the client’s console
File mode
: Writes the statistics to a log file
One log file per Transaction Server instance and per launched arrfstatsmonitor instance is created in the
logs
folder in the tool's installation folder. The log files are named, as follows:
RFStatsLog_rm-instance-id_dd_mm_yyyy_hh_mm_ss.csv
Where:
rm-instance-id
is the instance ID of the corresponding Transaction Server.
dd_mm_yyyy_hh_mm_ss
is the datetime stamp corresponding to the tool's start time.
For example
arrfstatsmonitor.exe - id 2,3,6 - mode FILE
The log file rolls over when the file size exceeds 10MB.
Note
: If you do not specify a value for mode, it defaults to UI mode. In the case of UI mode, you can specify only one instance ID for the
-id
option.
-reset
Sends a message to Transaction Server to reset the statistics counters.
For example:
arrfstatsmonitor.exe - id 1 - reset
Note
: If you specify this option, the tool exits and does not monitor statistics. When you use this option, you cannot use any other option except
-id
.
-CalloutDLL
 
(Only Windows)
The complete path to a callout DLL application, for example,
CalloutDLL.dll
. The DLL file exports the DumpRFStats API so that it periodically receives the statistics dump that can further be used for custom actions to be performed based on Transaction Server parameters..
 
Collecting Statistics from Multiple Servers in UNIX Environments
To collect statistics from multiple servers in UNIX environments, you must create a
arrfstats.ini
file in the
conf
directory in ARCOT_HOME. This file must list the instance ID and the corresponding ARCOT_HOME.
A sample
arrfstats.ini
file, for example, can contain the following.
#Configure the parameters for the RFStatsMonitor and Risk Analytics instances that will be part of this monitoring [arcot/RFStats] MaxInstances=5 [arcot/RFStats/Instance1] INSTANCEID=2 ARCOT_HOME=/export/home/RF_301_M8/arcot [arcot/RFStats/Instance2] INSTANCEID=3 ARCOT_HOME=/export/home/RF_301_M8_2/arcot/
Tool Output Modes
The
arrfstatsmonitor
tool displays the output either on the client console or writes the output to a log file, depending on the value that you specified for the
mode
option while running the tool.
Output on Console
The arrfstatsmonitor tool's output on the client console can be categorized into the following sections:
  • Process Overview
  • ISO8583 Receiver and Dispatcher Queue Details
  • System Throughput Details
  • Transaction Information
Process Overview
The following table describes the fields in this section.
Field
Description
Total VirMem
Size of User mode portion of Virtual Address Space (VAS) of the calling process in bytes
Used VirMem
Unreserved and uncommitted memory in User mode portion of VAS
Used VM (Process)
(UNIX) Total virtual memory used by the process
Total PhyMem
Total physical memory of the machine
Used PhyMem
Total physical memory available for use without having to write to disk. It is the sum of size of standby, free, and zero lists.
Used Phy Mem (Process)
(UNIX) Total physical memory used by the process.
Current RSS
(Windows) Present working set size
Peak RSS
(Windows) Peak working set size
Page Faults
(Windows) Page faults for the process
Prvt Bytes
(Windows) Total private bytes. This is the total memory that is committed for the running process.
SERVER PID
Process ID of the Server process. This is assigned by the operating system.
CURRENTTIME
Current time
SERVER INSTANCE ID
RA instance ID
LASTRESETTIME
Time when the statistics monitoring client was reset last
SERVERSTARTTIME
Time when Transaction Server started
LWPs
(UNIX) Total number of threads in the running process
WORKERs
(UNIX) Total worker threads that register and post statistics to be written into shared memory
Maximum Resident Set Size
(UNIX) Portion of process memory that is in RAM
Total Num of Threads
(Windows) Total number of threads in the process
Num of Worker Threads
(Windows) Total worker threads that register and post statistics to be written into shared memory
CPU USAGE
CPU usage
Shared Memory ID
(UNIX) The shared memory ID thats being read by the statistics monitoring client
Shared Memory Size (KB)
(UNIX) The shared memory size
#CPUS
Total Number of CPUs in the machine
#CPUS_UP
(UNIX) Total number of CPUs that are being utilized
PAGE SIZE
(Windows) Page size for the machine
MIN APPLICATION ADDRESS
(Windows) A pointer to the lowest memory address accessible to applications and DLLs
MAX APPLICATION ADDRESS
(Windows) A pointer to the highest memory address accessible to applications and DLLs
CPU USAGE%
CPU usage percentage in User space and Kernel space
CPU USAGE TIME(secs)
Amount of time spent by process in User mode and Kernel mode
ISO8583 Receiver and Dispatcher Queue Details
This section contains the current and historical queue sizes (number of elements in the queue) for Receiver and Dispatcher queues. The following table describes the fields in this section.
Field
Description
ISO8583 Receiver Queue Max and Min
Receiver queue maximum and minimum size to date
ISO8583 Receiver Queue Size
Current receiver queue size
ISO8583 Receiver Queue Last Few Snapshots
Historical receiver snapshots in past few refreshes
ISO8583 Dispatcher Queue Max and Min
Dispatcher queue maximum and minimum size
ISO8583 Dispatcher Queue Size
Current dispatcher queue size
ISO8583 Dispatcher Queue Last Few Snapshots
Historical dispatcher snapshots in past few refreshes
Historical queue sizes depict the queue size during previous refreshes. The details are displayed in reverse chronological order.
System Throughput Details
The following table describes the fields in this section.
Field
Description
System Throughput Max and Min
Maximum and minimum throughput since monitoring started
Current Throughput
System throughput at this instant of time
System Throughput Last Few Snapshots
History of system throughput in past few refreshes
Transaction Information
This section contains transaction information grouped by the transaction type (synchronous requests) or MTI (asynchronous or ISO 8583 requests). The following table describes the fields in this section.
Field
Description
Type
The type of transaction. It can be one of the following:
SDK-RE
SDK-PE
ISO-RE
ISO-PE
ISO-RV
ISO-NMSG
ISO-DQ
ISO-Q1T
ISO-Q2T
#Txns
Number of transactions since the last statistics reset
Elapse Time - Avg
Average elapse time
Elapse Time - Median
Bucketized median
Elapse Time - 90%le
90th percentile of elapse times, bucketized
Elapse Time - 95%le
95th percentile of elapse times, bucketized
Elapse Time - Min
Minimum elapse time
Elapse Time - Max
Maximum elapse time
Output in Log File
The arrfstatsmonitor tool spools the collected statistics to a comma-separated value (CSV) file. The following table describes the columns in the CSV file.
Column
Description
CURRENTTIME
Current Time
LASTRESETTIME
Time when the statistics monitoring client was reset last
SERVERSTARTTIME
Time when Transaction Server started
Total-VirMem
Size of User mode portion of Virtual Address Space (VAS) of the calling process in bytes
Used-VirMem
Unreserved and uncommitted memory in User mode portion of VAS
USED VM PROCESS
(UNIX) Virtual memory used by process
Total-PhyMem
Total physical memory of the machine
Used-PhyMem
Total physical memory available for use without having to write to disk. It is the sum of size of standby, free, and zero lists.
USED PHY PROCESS
(UNIX) Physical memory used by process
Current-RSS
Present working set size
Peak-RSS
Peak working set size
#Page-Faults
Page faults for the process
Prvt-Bytes
Total private bytes. This is the total memory that is committed for the running process.
SERVER-PID
PID of Server process
SERVER-INSTANCE-ID
Transaction Server Instance Sequence ID
Total Num Threads
Total number of threads in the process
Total Worker Threads
Total worker threads that register and post statistics to be written into shared memory.
CPU USAGE
CPU usage
#CPUS
Total Number of CPUs in the machine
PAGE SIZE
Page size for the machine
MIN APPLICATION ADDRESS
A pointer to the lowest memory address accessible to applications and DLLs
MAX APPLICATION ADDRESS
A pointer to the highest memory address accessible to applications and DLLs
CPU USAGE (USER)
CPU usage percentage in User space
CPU USAGE (SYSTEM)
CPU usage percentage in Kernel space
CPU USAGE TIME SECS (USER)
Amount of time spent by process in User mode
CPU USAGE TIME SECS (SYSTEM)
Amount of time spent by process in Kernel mode
CPU USAGE TIME SECS (TOTAL)
Amount of time spent by process in both User mode and Kernel mode
Q1Size
Asynchronous Pool Receiver queue size
Q2Size
Asynchronous Pool Dispatcher queue size
SYSTEM-TPUT
Overall system throughput at any instance of time
SDK-RE
Total number of 3D Secure risk evaluation transactions.
SDK-RE-AVG
3D Secure risk evaluation average response time
SDK-PE
Total number of 3D Secure post evaluation transactions
SDK-PE-AVG
Average response time for 3D Secure post evaluation transactions
ISO-RE
Total number of ISO risk evaluation transactions
ISO-RE-AVG
Average response time for ISO risk evaluation
ISO-PE
Total number of ISO post evaluation transactions
ISO-PE-AVG
Average response time for ISO post evaluation transactions
ISO-RV
Total number of ISO reversal transactions
ISO-RV-AVG
Average response time for ISO Reversal transactions
ISO-NMSG
Total number of ISO network messages
ISO-NMSG-AVG
Average response time for ISO network messages
ISO-DQ
Total number of transactions removed (de-queued) from the ISO8583 Receiver Queue for processing. This field is currently not applicable.
ISO-DQ-AVG
Average DQ (de-queue) time
ISO-Q1T
Total number of transactions that waited in the ISO8583 Receiver Queue before getting processed. This field is currently not applicable.
ISO-Q1T-AVG
Average Q1 Time
ISO-Q2T
Total number of transactions that waited in the ISO8583 Receiver Queue before getting dispatched. This field is currently not applicable.
ISO-Q2T-AVG
Average Q2 Time