Package org.camunda.bpm.engine.telemetry

Interface Internals

  • All Known Implementing Classes:
    InternalsImpl
    public interface Internals
    This class represents the structure of data describing Camunda internal metrics and the technical environment in which Camunda is set-up. This information is sent to Camunda when telemetry is enabled.
    See Also:
    Camunda Documentation: Collected Telemetry Data

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      ApplicationServer getApplicationServer()
      Information about the application server Camunda is running on.
      java.util.Set<java.lang.String> getCamundaIntegration()
      Used Camunda integrations (e.g, Spring boot starter, Camunda Platform Run, WildFly/JBoss subsystem or Camunda EJB service).
      java.util.Map<java.lang.String,​Command> getCommands()
      Information about the number of command executions performed by the Camunda engine.
      Database getDatabase()
      Information about the connected database system.
      java.util.Date getDataCollectionStartDate()
      The date when the engine started to collect dynamic data, such as command executions and metrics.
      Jdk getJdk()
      Information about the installed Java runtime environment.
      LicenseKeyData getLicenseKey()
      Information about the Camunda license key issued for enterprise editions of Camunda Platform.
      java.util.Map<java.lang.String,​Metric> getMetrics()
      A selection of metrics collected by the engine.
      java.util.Set<java.lang.String> getWebapps()
      Webapps enabled in the Camunda installation (e.g., cockpit, admin, tasklist).

    • Method Detail

      • getDatabase

        Database getDatabase()
        Information about the connected database system.

      • getApplicationServer

        ApplicationServer getApplicationServer()
        Information about the application server Camunda is running on.

      • getLicenseKey

        LicenseKeyData getLicenseKey()
        Information about the Camunda license key issued for enterprise editions of Camunda Platform. May be null when no license is used.

      • getDataCollectionStartDate

        java.util.Date getDataCollectionStartDate()
        The date when the engine started to collect dynamic data, such as command executions and metrics. If telemetry sending is enabled, dynamic data resets on sending the data to Camunda. This method returns a date that represents the date and time when the dynamic data collected for telemetry is reset. Dynamic data and the date returned by this method are reset in three cases:
        • At engine startup, the date is set to the current time, even if telemetry is disabled. It is then only used by the telemetry Query API that returns the currently collected data but sending telemetry to Camunda is disabled.
        • When sending telemetry to Camunda is enabled after engine start via API (e.g., ManagementService.toggleTelemetry(boolean). This call causes the engine to wipe all dynamic data and therefore the collection date is reset to the current time.
        • When sending telemetry to Camunda is enabled, after sending the data, all existing dynamic data is wiped and therefore the collection date is reset to the current time.
        Returns:
        A date that represents the start of the time frame where the current telemetry data set was collected.

      • getCommands

        java.util.Map<java.lang.String,​Command> getCommands()
        Information about the number of command executions performed by the Camunda engine. If telemetry sending is enabled, the number of executions per command resets on sending the data to Camunda. Retrieving the data through ManagementService.getTelemetryData() will not reset the count.

      • getMetrics

        java.util.Map<java.lang.String,​Metric> getMetrics()
        A selection of metrics collected by the engine. Metrics included are:
        • The number of root process instance executions started.
        • The number of activity instances started or also known as flow node instances.
        • The number of executed decision instances.
        • The number of executed decision elements.
        The metrics reset on sending the data to Camunda. Retrieving the data through ManagementService.getTelemetryData() will not reset the count.

      • getCamundaIntegration

        java.util.Set<java.lang.String> getCamundaIntegration()
        Used Camunda integrations (e.g, Spring boot starter, Camunda Platform Run, WildFly/JBoss subsystem or Camunda EJB service).

      • getWebapps

        java.util.Set<java.lang.String> getWebapps()
        Webapps enabled in the Camunda installation (e.g., cockpit, admin, tasklist).

      • getJdk

        Jdk getJdk()
        Information about the installed Java runtime environment.