Usage metrics

Removed endpoints

The actuator usage metrics endpoints (/actuator/usage-metrics/*) were deprecated in 8.8 and removed in 8.10.
Use the usage metrics endpoint instead.

Usage metrics endpoint (recommended)

Overview

The usage metrics endpoint retrieves metrics for a specific date range, including:

• Process instances: Total created
• Decision instances: Total executed
• User tasks assigned: Total unique assignees
• Active tenants: Total active tenants
• Tenants: List of active tenants with per-tenant metrics

Export interval
Usage metrics are exported every 5 minutes by default. This may cause a short delay in reported metrics.
You can adjust this interval in application.properties or via environment variables:

zeebe.broker.experimental.engine.usageMetrics.exportInterval=5m

API details

Parameter	Required	Description	Format / Default
startTime	Yes	Start of date range	ISO 8601: 2025-09-16T12:30:45.123-00:00
endTime	Yes	End of date range	ISO 8601: 2025-09-16T12:30:45.123-00:00
tenantId	No	Filter by tenant	String
withTenants	No	Include per-tenant breakdown	false (default)

Endpoint:

http://<host>:<port>/v2/system/usage-metrics?startTime={startTime}&endTime={endTime}&tenantId={tenantId}&withTenants={withTenants}

More info: usage metrics API

Examples

Without tenant breakdown:

http://<host>:<port>/v2/system/usage-metrics?startTime={startTime}&endTime={endTime}&withTenants=false

Response:

{
  "processInstances": 5,
  "decisionInstances": 23,
  "activeTenants": 2,
  "assignees": 3,
  "tenants": {}
}

With tenant breakdown:

http://<host>:<port>/v2/system/usage-metrics?startTime={startTime}&endTime={endTime}&withTenants=true

Response:

{
  "processInstances": 5,
  "decisionInstances": 23,
  "activeTenants": 2,
  "assignees": 3,
  "tenants": {
    "tenant1": {
      "processInstances": 1,
      "decisionInstances": 2,
      "assignees": 1
    },
    "tenant2": {
      "processInstances": 4,
      "decisionInstances": 21,
      "assignees": 3
    }
  }
}

Best practices for monitoring

• Monitor overall cluster activity by combining process, decision, and task metrics.
• Track trends over time to better understand resource usage and user engagement.
• Integrate metrics into dashboards or automation scripts for centralized monitoring and alerting.