IBM Support

Agent and events statistics monitoring tool

News


Abstract

Monitor a running server to generate statistics for agents and events by running the pmiManager script. The results are stored in CSV files and can be viewed in a spreadsheet. The statistics include the number of times an agent or event type is invoked, the average time an agent or event type is active, and the number of times an agent or event type is invoked per second.

Content

The pmiManager script is in the <InstallDir>/runtime/ia/bin folder.

When the tool monitors the server, it generates a number of CSV files in the location that you specify. For each agent or event type that is monitored, a file is generated with the file names in the form of <event-type>.EventStats.csv or <event-type>.<agent-type>.AgentStats.csv. Each file has the following columns:

elapsed_time: The time that is elapsed since the monitoring began, expressed in seconds.
timestamp: The date and time.
total_count: The number of invocations across all partitions.
average_time: The total time that an event or agent is processed, divided by number of partitions.

Each partition has the following columns:

count: The number of invocations for the partition.
time: The time that is spent on processing the event or agent.

The various _header.csv and _data.csv files are combined in the results subdirectory. The results subdirectory contains eight files.

Each agent and event has a corresponding file that contains the following information:

  • The number of invocations across all of the partitions of the server (Count.csv).
  • The number of invocations per second across all of the partitions of the server (CountSec.csv).
  • The total time that an event or agent is processed, divided by the number of partitions across the server (AverageTime.csv).
Additionally, you can consult two files that combine the previous agent and event information: AgentStats.csv and EventStats.csv.

Monitor a running server to produce CSV files that contain runtime information about the event and agents types.

Syntax

pmiManager monitor fileDirectory pollPeriod
[--propertiesFile=properties_file]
[--username=username]
[--password=password]
[--host=hostname]
[--port=port]
[--keyStoreLocation=keystore_location]
[--keyStorePassword=keystore_password]
[--sslProtocol=sslProtocol]
[--trustStorePassword=truststore_password]
[--trustStoreLocation=truststore_location]
[--disableSSLHostnameVerification=true|false]

Description

Table 1. Mandatory parameters for the pmiManager monitor command.
Parameter
Description
fileDirectoryThe directory where the CSV files are written to. A sub directory called 'results' is also created in this directory.
pollPeriodThe period in seconds that the manager polls the server.

Table 2. Optional parameters for the pmiManager monitor command.
Parameter
Description
propertiesFileThe path to a properties file from which to read properties. If you do not specify a value, the default path to the connection.properties file in the runtime/ia/etc directory is used.
usernameThe user name of a user who has the administrator role.
passwordThe password of a user who has the administrator role.
hostThe default host name is localhost. To change the host name, specify the fully qualified name of the remote server. For example: myserver.mycompany.com.
portThe default port value is 9443. To change the port, specify the port of the remote server.
trustStorePasswordThe password for remote Secure Sockets Layer (SSL) authentication.
trustStoreLocationLocation of the truststore (javax.net.ssl.trustStore). Default iscisDev/resources/security/key.jks in the servers directory.
disableSSLHostnameVerificationThis parameter is used for remote connections only. If set to true, it disables SSL host name verification. If no value is specified, it defaults to the value in the properties file that is specified by the --propertiesFile parameter. If no value is specified by that parameter, it defaults to false.
keyStoreLocationThe location of the keystore. If you do not specify a value, this parameter uses the value in the properties file specified by the --propertiesFile option. If no value is specified on the command line or in the properties file, no keystore is used.
keyStorePasswordThe keystore password. If you do not specify a value, this parameter uses the value in the properties file specified by the --propertiesFile option. If no value is specified on the command line or in the properties file, you are asked to provide a password interactively.
sslProtocolThe SSL protocol for the connection. If you do not specify a value, this parameter uses the value in the properties file specified by the --propertiesFile option. If no value is specified on the command line or in the properties file, the value "TLS" is used.

[{"Product":{"code":"SSQP76","label":"IBM Operational Decision Manager"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Documentation","Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"8.7","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
15 June 2018

UID

swg21694866