Built-in Metrics

The following table describes the built-in metrics. The identifiers of all built-in metrics are available as constants of the class org.camunda.bpm.engine.management.Metrics.

Querying

Metrics can be queried by making a offered by the ManagementService. For example, the following query retrieves the number of all executed activity instances throughout the entire history of reporting:

Configuration

The process engine flushes the collected metrics to the runtime database tables in an interval of 15 minutes. The behavior of metrics reporting can be changed by replacing the instance of the process engine configuration. For example, to change the reporting interval, a process engine plugin replacing the reporter can be employed:

Metrics are reported with an identifier of the reporting party. This identifier allows to attribute reports to individual engine instances when making a metrics query. For example in a cluster, load metrics can be related to individual cluster nodes. By default the process engine generates a reporter id as <local IP>$<engine name>. The generation can be customized by implementing the interface org.camunda.bpm.engine.impl.metrics.MetricsReporterIdProvider and setting the engine property metricsReporterIdProvider to an instance of that class.

If you are directly accessing the Java API, you can disable the metrics reporting by using the engine configuration flag and set it to false.