Package org.operaton.bpm.engine.telemetry

Interface Internals

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

  • Method Details

    • getDatabase

      Database getDatabase()
      Information about the connected database system.

    • getApplicationServer

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

    • getDataCollectionStartDate

      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 Operaton. 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 Operaton is disabled.
      • When sending telemetry to Operaton 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 Operaton 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

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

    • getMetrics

      Map<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 Operaton. Retrieving the data through ManagementService.getTelemetryData() will not reset the count.

    • getOperatonIntegration

      Set<String> getOperatonIntegration()
      Used Operaton integrations (e.g, Spring boot starter, Operaton Run, WildFly/JBoss subsystem or Operaton EJB service).

    • getWebapps

      Set<String> getWebapps()
      Webapps enabled in the Operaton installation (e.g., cockpit, admin, tasklist).

    • getJdk

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