Usage metrics

Deprecated endpoint

With the 8.8 release, Camunda announces the deprecation of the following Tasklist usage metrics endpoint. Scheduled for removal in the 8.10 release. Use the new endpoint, /v2/system/usage-metrics.

Tasklist provides usage metrics under usage-metrics Actuator endpoint. It is exposed on management port, which can be configured via management.server.port configuration parameter (default: 8080).

Number of active users

This endpoint returns the number of unique users assigned to tasks in a given period and each of the unique usernames.

This also returns the usernames so we can reconcile in the case of multiple instances.

Endpoint:

http://<host>:<port>/actuator/usage-metrics/assignees?startTime={startTime}&endTime={endTime}&tenantId={tenantId}

Here, startTime and endTime are of format yyyy-MM-dd'T'HH:mm:ss.SSSZZ, e.g. "1970-11-14T10:50:26.963-0100". tenantId is optional and can be used to filter the results for a specific tenant.

Sample response:

{
  "total": 2
}

Breaking change

Assignees list removed from response.