9.2

Edit

UI overview

Dashboard

Provides a quick overview of the components, alerts, and incidents.

Environment status

Components

Provides summary of the system components with ability to get the messages about health and statuses.

  1. The component group name
  2. Name of the component
  3. Version of the component
  4. Server name (Alias)
  5. Component status shows the status of the component and is clicklable. When have errors and warnings click on the status to see the list of incidents.
    1. Waiting for status: We are getting the response from component or it is not installed.
    2. Operational: The component is working.
    3. Partially available: The component is experiencing some slowness.
    4. Performance issues: The component may have some operational issues.
    5. Major Outage: The component is not operational.
  6. Health Checks messages

Errors

Warnings

Info

note

In the current version of Platform Monitor, only the following components provide the Health Checks information: Control Tower, WorkSpace, OCR, and RPA.

Health check messages:

  • Errors: critical issues found and requires immedeate attention and resolving for correct operation of the system, the component can be in not operational state.
  • Warnings: issue requiring attention, the component can be in operational state.
  • Info: information message about the component such as version, license, and so on.

Incidents

Provides a timeline log of incidents.

Incidents statuses:

  • Investigating: you have reports of a problem and you're currently looking into them.
  • Fixed: the fix has worked, you're happy to close the incident.

Latest data

Provides ability to see the metrics change in time.

  1. Bulk show of metrics graphics

  2. Single metric graphic

Monitoring

Alerts

  1. Alert about failure

  2. Successfull check

  3. Allert Issues pop-up

Anomaly

See Proactive monitoring.

Checks

Events

Forecast

See Proactive monitoring.

Items

Trend

See Proactive monitoring.

Command Board

The command board provides meand to execute the commands and restart the components.

  1. Choose on or off.
  2. Click Execute.

Processes

One of Platform Monitor's feature is external process management. This allows controlling process state and lifecycle.

Process management UI

Go to the Processes tab (when not disabled in a configuration).

Process columns

  • Autorestart: OFF means after process stopped it will not be automatically recovered. ON means process will be automatically started if it is in the stopped state.
  • Expression: command line which will be executed to spawn the process.
  • Uptime: time since the process started.
  • State: either stopped or running.
  • TotalStats: process memory and CPU usage.

Manage process

  1. Choose a arocess.

  2. Choose an action.

Process actions

These actions allows starting, stopping, and restarting a process.

  1. Start starts the process.
  2. Stop stops the process.
  3. Restart restarts the process.
  4. On/Off autorestart enables or disables autorestart.
  5. Logs shows logs.

Logs

Logs will display standard output and errors if there are any.

Process configuration

Processes can be defined in the main configuration YAML file.

Example:

processes:
  - id: top
    type: command
    expression: top
    autorestart: false
    tag: hub
  - id: pause
    type: command
    expression: ping -t localhost
    autorestart: false
    tag: node

Supported options are as follows:

  • id: unique ID of process

  • type: either "command" (system call) or "http" (web call)

  • expression: command to execute for launching process

  • autorestart: true (default) to automatically restore a process. The process watchdog will be created.

  • tag: list of tags for process

  • stop: expression to stop process

  • directory: custom directory from which a process is executed

  • loggerOut: true (default) if collecting a standard output stream

  • loggerErr: true (default) if collecting a standard error stream

Process watchdog

Platform Monitor proactively monitors state of each launched process. If autorestart is set to true, all stopped processes are automatically started.

A process watchdog is scheduled to run every 30 seconds and will analyze all configured processes.

Control Panel

The UI has the following sections and functionality:

  • RPA robots overview: instances and robots statistics
  • Each RPA server has a list of processes
  • Process metrics (Uptime/Memory)
  • Process actions (Start/Stop/Restart)
  • RPA Server metrics (CPU/Memory/Disk/Uptime)

Bot Manager

List of bots.

Bots statistics

  • Robots Total: sum of stopped and running Bot processes

  • Robots Running: when a Bot process is up and running; doesn't reflect whether it is executing a task

  • Robots Stopped: when a Bot process is crashed or manually stopped

Instance statistics

  • Instances Total: all RPA Servers configured in RPA Manager

  • Instances Available: RPA Servers accessible through Platform Monitor

RPA Server

Process actions

  • Start launches a selected process.

  • Stop stops a selected process.

  • Restart stops and starts a selected process.

  • Screenshot takes a screenshot (works for active sessions only).

  • Logout executes a logout command (a session will close and all processes will be stopped)

Metrics description

The guide describes what kind of checks are executed in APM against WorkFusion components to get environment health and performance metrics.

Server

Check in APM Source Description Metrics
server.disk JAVA Check disk statistics for specified directory
  • Free disk space
  • Total disk space
  • Percentage of used space
server.memory COMMAND Check memory statistics using external command
  • Total memory
  • Free memory
  • Cached memory
  • Buffers memory
  • Available memory
  • Total swap size
  • Free swap size
server.cpu.util COMMAND Gets cpu utilization info. Provides an average value (from 0.0 to 1.0) of CPU's load over the last minute which takes into account available cores.
  • load

APP

Check in APM Source Description Metrics
wf.login HTTP Open WorkFusion Login page
  • Response code
  • Response time
ws.dashboard HTTP Open WorkSpace Index page
  • Response code
  • Response time

DB

Check in APM Source Description Metrics
riak.stats HTTP Open Riak stats page and parse JSON
  • Response code
  • Response time
  • Riak version

riak.tcp

stanchion.tcp

riakcs.tcp

 TCP Checks that specified ports are in LISTENING mode
  • Port is listening
s3cmd.ls COMMAND Execute s3cmd command to list available buckets. Checks configuration of s3cmd and availability of Riak services
  • Command exit code
solr HTTP Request Solr admin information API and parse JSON
  • Response code
  • Response time
  • Solr version
mysql.query1 SQL Run MySQL query to retrieve database name
  • Query status
  • MySQL database name
mysql.query2 SQL Run MySQL query to retrieve version
  • Query status
  • MySQL database name
postgres.query1 SQL Run Postgres query to retrieve database name
  • Query status
  • Postgres database name
postgres.query2 SQL Run Postgres query to retrieve version
  • Query status
  • Postgres database name
mongodb.db MONGO Run MongoDB query to retreive database statistics
  • Size of database data
  • Query status
mongodb.server MONGO Run MongoDB query to retrieve server statistics
  • MongoDB version

ML

Check in APM Source Description Metrics
gateway.api HTTP Request Gateway API on currently available hypermodels
  • Response code
  • Response time
gateway.info HTTP Request Gateway API about deployed version
  • Response code
  • Response time
  • Gateway version
scaling.api HTTP Request Scaling API on currently available hypermodels
  • Response code
  • Response time
scaling.info HTTP Request Scaling API about deployed version
  • Response code
  • Response time
  • Scaling version
duccadapter.info HTTP Request Duccadapter API about deployed version
  • Response code
  • Response time
  • Scaling version
emulator.api HTTP Request Emulator API - catalog endpoint
  • Response code
  • Response time
emulator.info HTTP Request Emulator API about deployed version
  • Response code
  • Response time
  • Emulator version
rabbitmq.api HTTP Request RabbitMQ overview API
  • Response code
  • Response time
  • Number of messages
  • Number of ready messages
  • Number of unack messages
  • Number of queues
ducc.reservations HTTP Open DUCC reservations page
  • Response code
  • Response time

OCR

Check in APM Source Description Metrics
ocr.rest.api HTTP Request OCR Rest API entrypoint
  • Response code
  • Response time
ocr.rest.summary HTTP Request OCR Rest API - summary endpoint
  • Response code
  • Response time
ocr.rest.info HTTP Request OCR Rest API about deployed version
  • Response code
  • Response time
  • OCR Rest version
ocr.rest.tasks HTTP Request OCR Rest API about queued tasks
  • Response code
  • Response time
  • Number of queued tasks
ocr.license HTTP Request OCR Rest API about license page count
  • Response code
  • Response time
  • Number of pages remaining

RPA

Check in APM Source Description Metrics
rpa.ct.hub.%rpa_hub_hostname%.%rpa_hub_port% HTTP Request Bot Relay API about session statistics
  • Response code
  • Response time
  • New session requests
  • Free slots
  • Busy slots
  • Total slots
← PreviousNext →