Edit on Github

Get Telemetry Data

Fetches the telemetry data that would be sent to Camunda if telemetry was enabled. Telemetry metrics and statistics are monitored constantly so the dynamic parts of the telemetry data will change over time. Even if sending this data to Camunda is not enabled it is available through this endpoint.

Using this endpoint will not send data to Camunda or enable telemetry. Its main purpose is transparency and easy access to important system information and metrics. For more information on the telemetry topic, visit the Telemetry page.

Method

GET /telemetry/data

Parameters

This method takes no parameters.

Result

A JSON object containing all collected telemetry data.

Name Type Description
product Object A data object containing further information about the installation. See the product description for its properties.
installation String A unique installation id generated by the Camunda Platform. The id is generated once per database, so all engines connected to one database will receive the same id.

Product

Name Type Description
name String The name of the product (i.e., Camunda BPM Runtime).
version String The version of the process engine (i.e., 7.X.Y).
edition String The edition of the product (i.e., either community or enterprise).
internals Object A data object containing further information about technical internals and the environment of the Camunda Platform installation. See the internals description for its properties.

Internals

Name Type Description
database Object Data object containing information about the connected database system. See the database description for its properties.
application-server Object Data object containing information about the application server Camunda is running on. See the application server description for its properties.
license-key Object Data object containing information about the Camunda license key issued for enterprise editions of Camunda Platform. See the license key description for its properties.
commands Object Information about the number of command executions performed by the Camunda engine. Keys of the object are the command names. Values are JSON objects with a single property count.
metrics Object A selection of metrics collected by the engine. Keys of the object are the metric names. Values are JSON objects with a single property count. Metrics included are:
  • The number of process instances started (process-instances).
  • The number of activity instances started or also known as flow node instances (flow-node-instances).
  • The number of executed decision instances (decision-instances).
  • The number of executed decision elements (executed-decision-elements).
camunda-integration Array Contains String values describing the Camunda integrations used (e.g, Spring boot starter, Camunda Platform Run, WildFly/JBoss subsystem or Camunda EJB service).
jdk Object Information about the installed Java runtime environment. See the JDK description for its properties.

Database

Name Type Description
vendor String The vendor of the connected database system.
version String The version of the connected database system.

Application Server

Name Type Description
vendor String The vendor of the installed application server.
version String The version of the installed application server.

License Key

Name Type Description
customer String The name of the customer this license was issued for.
type String Camunda uses different license types e.g., when one license includes usage of Cawemo enterprise.
valid-until String The expiry date of the license in the format 'YYYY-MM-DD'.
unlimited boolean A flag indicating if the license is unlimited or expires.
features boolean A collection of features that are enabled through this license. Features could be Camunda BPM, Optimize or Cawemo.
raw boolean The raw license data. This combines all data fields also included in this class in the form which is stored in the license key String. Note, that this is not the license key as issued to the customer but only contains the plain-text part of it and not the encrypted key.

JDK

Name Type Description
vendor String The vendor of the Java runtime environment.
version String The version of the Java runtime environment.

Response Codes

Code Media type Description
200 application/json Request successful.

Example

Request

GET /telemetry/data

Response

{
    "installation": "8343cc7a-8ad1-42d4-97d2-43452c0bdfa3",
    "product": {
      "name": "Camunda BPM Runtime",
      "version": "7.14.0",
      "edition": "enterprise",
      "internals": {
        "database": {  
          "vendor": "h2",
          "version": "1.4.190 (2015-10-11)"
        },
        "application-server": {
          "vendor": "Wildfly",
          "version": "WildFly Full 19.0.0.Final (WildFly Core 11.0.0.Final) - 2.0.30.Final"
        },
        "jdk": {
          "version": "14.0.2",
          "vendor": "Oracle Corporation"
        },
        "commands": {
          "StartProcessInstanceCmd": {"count": 40},
          "FetchExternalTasksCmd":  {"count": 100}
        },
        "metrics": {
          "process-instances": { "count": 936 },
          "flow-node-instances": { "count": 6125 },
          "decision-instances": { "count": 140 },
          "executed-decision-elements": { "count": 732 }
        },
        "camunda-integration": [
          "spring-boot-starter",
          "camunda-bpm-run"
        ],
        "license-key": {
          "customer": "customer name",
          "type": "UNIFIED",
          "valid-until": "2022-09-30",
          "unlimited": false,
          "features": {
            "camundaBPM": "true"
          },
          "raw": "customer=customer name;expiryDate=2022-09-30;camundaBPM=true;optimize=false;cawemo=false"
        },
        "webapps": [
          "cockpit",
          "admin"
        ]
      }
    }
}

On this Page: