APM (Application Performance Monitoring) Dashboard

Data Capture Configuration

Control Tower APM Dashboard displays the data captured by APMClient. APMClient is data capture utility which capture system and components (RPA components) level data for APM dashboard.

This data capture utility is available for both sever side and client side components for data capture.

 

Following table explains about the relevant data capture configuration:

 

Configuration	Description
At Server side	·       APMClient utility is available at <<AssistEdge>>\app\APMClient build location. ·       APMClient automatically starts whenever at least one sever side component is started and closes once all the sever side components are closed. It runs only if any of the RPA components is running.
At Client side	·       APMClient utility is available at <<AssistEdge>>\clienttools\AutomationRuntime\Robot\APMClient build location. ·       APMClient automatically starts along with proctor or agent.

 

NOTE:

Ensure that you copy the APMClient folder with the Proctor and Agent folder . These folders must be at the parallel location. If the APM client folder is not copied with other folders, then: ·       Data will not be captured for that particular robot farm ·       Also, data will not be available on the APM Dashboard

 

Updating Data Capture Configurations

To update configurations as per the requirements:

1.    Navigate to build path folder  - $\APMClient\APMClient.exe.config.

 

NOTE:

APMClient is available at two places as mentioned in data capture field description table, you must edit respective APMClient.exe.config configuration file for update.

 

·       Enable/Disable Data Capture: Set the value of  APMDataCaptureEnable configuration key to True or False to enable or disable the data capture respectively.

·       Change Data Capture Interval: Edit SysMetricsCaptureInterval configuration key. Set value in minutes to capture data at particular interval. The minimum value should be 1. If the value is less than 1,  the system considers 1 as the default value.

 

·       Data Send Interval: Edit  DataSendInterval configuration key value. Set value in minutes to send data to server at particular interval. DataSendInterval must be in multiple of SysMetricsCaptureInterval. For example, if data capture interval is 2 minutes then, data send interval can be either 2 minutes, 4minutes, 6minutes and so on. If the interval is not set in multiple of SysMetricsCaptureInterval then, default 5 multiples of SysMetricsCaptureInterval will be used.

 

 

·       Configure Server User Friendly Names: By default, APMClient captures system DNS (hostname) name as the server name. This name is visible in APM Dashboard server list and all graph data. However, you can change the name as per your requirement.

 

2.    Edit UserFriendlyHostNameForAPM configuration key. Specify the preferred server name that you want to view in Control Tower APM dashboard.

 

 

For example, the following image shows user defined  name, which  isvisible in Control Tower APM Dashboard server list drop-down and charts.

 

 

·       Data retain configuration:

By default, APMClient retains data locally in file system for last 30 minutes. This is useful in case of connectivity issues with messaging (rabbitmq) server. Once connection is reestablished, it pushes data stored/retained locally. Edit RetainDataForMins configuration key. If RetainDataForMins is lower than DataSendInterval then, RetainDataForMins value will be set as DataSendInterval value. For example, If RetainDataForMins=5 and DataSendInterval =10 then, RetainDataForMins will be set as 10. For instance, RetainDataForMins=10.

 

 

·       Stop data capture in case of inactivity:

At server side, when all the server processes/components are closed, APMClient gets closed as well, and the data capture stops. However, at client side, when agents and proctors are closed, the APMClient closes after 10 minutes (default) of inactivity. Edit StopDataCaptureAfterMissedInterval configuration key and provide appropriate time interval. APMClient closes after configured interval data is missed.

Configuring Data Capture for APM Dashboard

APM data is captured at all RPA configured severs and stored in TxnStore. APM dashboard information is retrieved from these data. APM data is captured (if enabled) at configured interval (default is 1 minute) and aggregated in dashboard chart view based on the time duration (filter) selected.

 

For more information about how average aggregation is performed by TxnStore search, see https://www.elastic.co/guide/en/elasticsearch/reference/6.7/search-aggregations-metrics-avg-aggregation.html

 

For more information about detailed data capture configuration , see Data Capture Configuration.

 

NOTE:

APM Dashboard displays the data for maximum of last 30 days.

APM Data Store Configuration

APM Dashboard shows data for maximum of last 30 days. This data is stored in TxnStore for the same duration of last 30 days. Data more than 30 days (set by default) will be purged automatically.

 

To retain the data for more than 30 days, update the control tower configuration accordingly.

 

To perform APM data store configuration:

1.    Navigate to $\app\ControlTower\config\config.yml and then, open the config.yml.

2.    Configure the rpaapm_index_ttl_days configuration key to value for number of days you want to keep APM data in TxnStore index.

 

Prerequisites

Data Capture Configuration

Updating Data Capture Configurations

Configuring Data Capture for APM Dashboard

APM Data Store Configuration