Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
On-prem
On-prem agent

On-prem agent monitoring ​

Starting with OPA version 32.0, the on-prem agent exposes a Prometheus-compatible metrics endpoint.

Prometheus server is an open-source monitoring tool that collects metrics by polling (scraping) HTTP endpoints at regular intervals and storing the results in a local time-series database. Visualization and alerting tools, such as Grafana, can then query that database to build dashboards and set up alerts based on metrics such as CPU usage, memory, JVM health, and connector activity. Tools that support the Prometheus exposition format directly, such as Datadog, can also scrape the endpoint without a Prometheus server.

MANUAL MONITORING DEPRECATION

The manual monitoring feature (available from OPA 2.14.0) was deprecated and isn't available in OPA version 31.0 or higher. You can still access the old monitoring tool if you're running an OPA version between 2.14.0 and 30.0.

Enable the monitoring endpoint ​

Add the --mgmt-listen flag to the agent's start parameters to enable monitoring:

NETWORK ACCESS

Use 127.0.0.1 as the host address to restrict access to the local machine, or use a specific network interface address to allow access from other hosts. Note that Prometheus endpoints are unauthenticated by default.

The agent logs the following when the management server is ready to accept requests:

ManagementServer - Management server is up
Access the deprecated monitoring UI

Complete the following steps using an OPA version between 2.14.0 and 30.0 to access the old monitoring UI:

1

Run the agent start command for your operating system with the --monitoring and --mgmt-listen flags.

2

Go to http://[HOST]:[PORT]/monitoring. Replace [HOST] and [PORT] with the values defined in the previous step.

Scrape metrics ​

Use the following command as a manual check to verify the endpoint is working. Refer to Configure automated scraping for ongoing automated collection.

sh
curl http://[HOST]:[PORT]/prometheus

The response is in the standard Prometheus text exposition format, with Content-Type: text/plain;version=0.0.4;charset=utf-8. Each metric includes a # HELP description, a # TYPE declaration, and one or more sample lines:

# HELP jvm_threads_live_threads The current number of live threads
# TYPE jvm_threads_live_threads gauge
jvm_threads_live_threads{session_id="abc123"} 60.0

The endpoint doesn't stream or push data. Each request returns a fresh snapshot of the current metric values at the time of the call.

Configure automated scraping ​

Some monitoring tools, such as Grafana, require you to store OPA metrics in a Prometheus server time-series database.

You can add a scrape job to prometheus.yml to collect and store metrics at regular intervals. For example:

yaml
scrape_configs:
  - job_name: 'workato-opa'
    metrics_path: '/prometheus'
    static_configs:
      - targets:
          - '[HOST]:[PORT]'

Multiple agents ​

Each agent in a group exposes its own /prometheus endpoint. Add a target for each agent in your scrape config:

yaml
scrape_configs:
  - job_name: 'workato-opa'
    metrics_path: '/prometheus'
    static_configs:
      - targets:
          - '10.0.1.10:[PORT]'
          - '10.0.1.11:[PORT]'

Every metric includes a session_id label that uniquely identifies the agent instance it came from. Use this label in queries to filter or compare agents. For example:

# Metrics from a specific agent
jvm_memory_used_bytes{session_id="abc123"}

# Memory usage across all agents (group or compare by session_id in your dashboard)
jvm_memory_used_bytes

Last updated: