IBM Business Automation Workflow V
19.0.0.2

MeteringAgent command-line utility

Use the MeteringAgent command-line utility to start a thread that analyzes the audit log files from the WebSphere® Application Server Auditing Facility, collects license compliance records, and sends the information to the IBM® FileNet® System Manager. Concurrent user metrics are required for the Concurrent User license option, and you can also record and monitor activity metrics.

The MeteringAgent analyzes the audit log changes and sends the information to the FileNet System Manager, a performance monitoring tool for enterprise content management (ECM) products. It monitors the number of users who access ECM products and provides both real-time and historical usage information. It uses the IlmtReporter script to generate comma-separated values (CSV) files and IBM Software License Metric Tag (.slmtag) files that can be read by the IBM License Metric Tool agent.

Because the agent must keep monitoring the logs, make it a long-running command, for example by using the nohup command on Linux or registering the command as a service on Windows.

Run the MeteringAgent command on each computer that has one or more managed nodes.

Prerequisites

The following conditions must be met:

You must have run the MeteringConfig command to start the WebSphere Application Server Auditing Facility.
The deployment environment must be running.
The computer that the agent runs on must have the correct time. Otherwise, data collection might not be accurate.

Location

The MeteringAgent command-line utility is in the install_root_/bin directory.

The command log is in install_root_/logs/metering/MeteringAgent.timestamp.log.

Syntax

install_root_/bin/MeteringAgent
-pchConfigFile pchConfig.properties
-profile deployment_manager_profile

Concurrent user metrics are tracked in the following audit logs:

dmgr_profile/logs/metering/BinaryAudit_cell_name_dmgr_name_dmgr.log
node_profile/logs/metering/BinaryAudit__cell_name_node_name_nodeagent.log
node_profile/logs/metering/BinaryAudit__cell_name_node_name_app_server_name.log

When the DEF listener is enabled, the activity metrics log is created in install_root_/logs/metering/ActivityMetricLog.server_name.log.

Parameters

-pchConfigFile pchConfig.properties

Required parameter that specifies the location of the pchConfig.properties file, which is used to configure the FileNet System Manager (formerly Performance Clearinghouse) listener.

You can find a sample file in install_root/util/metering/pchConfig.properties. Modify the file to specify the values for your environment.

Customize the behavior of the listener by using the parameters shown in the following table. For more information about these parameters, see Listener configuration parameters.

Property	Default Value	Description
port_number	322775	The primary TCP port number on which the first instantiated listener (called the primary listener) listens for connections from managers.
secondary_port	OS defined	When this parameter is defined, secondary listeners attempt to bind to the specified port number, then that number plus 1, plus 2, and so on, until they successfully bind to a port.
output_interval	900 (15 minutes)	The aggregation interval in seconds.
output_count	96	The maximum number of summary blocks that are written to the summary log file before it is closed and a new log is opened.

Manage the user history queue by using the properties shown in the following table. For more information about these properties, see IBM System Dashboard for Enterprise Content Management Listener configuration.

Property	Default Value	Description
filenet.pch.ILMT.MAX_HISTORY	2500000	The maximum number of User History Queue records to store in the listener buffers.
filenet.pch.ILMT	enabled \| disabled	Enable or disable the IBM License Metric Tool collection of metrics.
filenet.pch	enabled \| disabled	Enable or disable the entire listener data collection and network services.

Examples

nohup MeteringAgent -start -pchConfigFile /opt/pchConfig.properties -profile DmgrProfile > /opt/meteringAgent.log 2>&1 &

sc create ServiceTest binpath= "C:\Windows\System32\cmd.exe /C C:\baw\bin\MeteringAgent.bat -start -pchConfigFile c:\pchConfig.properties -profile DmgrProfile"

What to do next

While the metering agent is running, you must schedule the IlmtCollector script to run (for example, once a day) to save the data for the concurrent user and activity metrics that are collected. See Collecting license compliance records in the FileNet P8 Platform documentation.