Package org.camunda.bpm.engine.impl.telemetry.dto

Class InternalsImpl

java.lang.Object

org.camunda.bpm.engine.impl.telemetry.dto.InternalsImpl

All Implemented Interfaces:

Internals

public class InternalsImpl
extends Object
implements Internals

Field Summary

Fields

Modifier and Type	Field	Description
protected ApplicationServerImpl	applicationServer
protected Set<String>	camundaIntegration
protected Map<String,Command>	commands
protected DatabaseImpl	database
protected JdkImpl	jdk
protected LicenseKeyDataImpl	licenseKey
protected Map<String,Metric>	metrics
static String	SERIALIZED_APPLICATION_SERVER
static String	SERIALIZED_CAMUNDA_INTEGRATION
static String	SERIALIZED_LICENSE_KEY
static String	SERIALIZED_TELEMETRY_ENABLED
protected Boolean	telemetryEnabled
protected Set<String>	webapps

Constructor Summary

Constructors

Constructor	Description
InternalsImpl()
InternalsImpl(DatabaseImpl database, ApplicationServerImpl server, LicenseKeyDataImpl licenseKey, JdkImpl jdk)
InternalsImpl(InternalsImpl internals)

Method Summary

Modifier and Type	Method	Description
ApplicationServerImpl	getApplicationServer()	Information about the application server Camunda is running on.
Set<String>	getCamundaIntegration()	Used Camunda integrations (e.g, Spring boot starter, Camunda Platform Run, WildFly/JBoss subsystem or Camunda EJB service).
Map<String,Command>	getCommands()	Information about the number of command executions performed by the Camunda engine.
DatabaseImpl	getDatabase()	Information about the connected database system.
JdkImpl	getJdk()	Information about the installed Java runtime environment.
LicenseKeyDataImpl	getLicenseKey()	Information about the Camunda license key issued for enterprise editions of Camunda Platform.
Map<String,Metric>	getMetrics()	A selection of metrics collected by the engine.
Set<String>	getWebapps()	Webapps enabled in the Camunda installation (e.g., cockpit, admin, tasklist).
Boolean	isTelemetryEnabled()
void	mergeDynamicData(InternalsImpl other)
void	putCommand(String commandName, int count)
void	putMetric(String metricName, int count)
void	setApplicationServer(ApplicationServerImpl applicationServer)
void	setCamundaIntegration(Set<String> camundaIntegration)
void	setCommands(Map<String,Command> commands)
void	setDatabase(DatabaseImpl database)
void	setJdk(JdkImpl jdk)
void	setLicenseKey(LicenseKeyDataImpl licenseKey)
void	setMetrics(Map<String,Metric> metrics)
void	setTelemetryEnabled(Boolean telemetryEnabled)
void	setWebapps(Set<String> webapps)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SERIALIZED_APPLICATION_SERVER

public static final String SERIALIZED_APPLICATION_SERVER

See Also:

Constant Field Values

SERIALIZED_CAMUNDA_INTEGRATION

public static final String SERIALIZED_CAMUNDA_INTEGRATION

See Also:

Constant Field Values

SERIALIZED_LICENSE_KEY

public static final String SERIALIZED_LICENSE_KEY

See Also:

Constant Field Values

SERIALIZED_TELEMETRY_ENABLED

public static final String SERIALIZED_TELEMETRY_ENABLED

See Also:

Constant Field Values

database

protected DatabaseImpl database

applicationServer

@SerializedName("application-server")
protected ApplicationServerImpl applicationServer

licenseKey

@SerializedName("license-key")
protected LicenseKeyDataImpl licenseKey

commands

protected Map<String,Command> commands

camundaIntegration

@SerializedName("camunda-integration")
protected Set<String> camundaIntegration

metrics

protected Map<String,Metric> metrics

webapps

protected Set<String> webapps

jdk

protected JdkImpl jdk

telemetryEnabled

@SerializedName("telemetry-enabled")
protected Boolean telemetryEnabled

Constructor Detail

InternalsImpl

public InternalsImpl()

InternalsImpl

public InternalsImpl(DatabaseImpl database,
                     ApplicationServerImpl server,
                     LicenseKeyDataImpl licenseKey,
                     JdkImpl jdk)

InternalsImpl

public InternalsImpl(InternalsImpl internals)

Method Detail

getDatabase

public DatabaseImpl getDatabase()

Description copied from interface: Internals

Information about the connected database system.

Specified by:

getDatabase in interface Internals

setDatabase

public void setDatabase(DatabaseImpl database)

getApplicationServer

public ApplicationServerImpl getApplicationServer()

Description copied from interface: Internals

Information about the application server Camunda is running on.

Specified by:

getApplicationServer in interface Internals

setApplicationServer

public void setApplicationServer(ApplicationServerImpl applicationServer)

getCommands

public Map<String,Command> getCommands()

Description copied from interface: Internals

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.

Specified by:

getCommands in interface Internals

setCommands

public void setCommands(Map<String,Command> commands)

putCommand

public void putCommand(String commandName,
                       int count)

getMetrics

public Map<String,Metric> getMetrics()

Description copied from interface: Internals

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.

Specified by:

getMetrics in interface Internals

setMetrics

public void setMetrics(Map<String,Metric> metrics)

putMetric

public void putMetric(String metricName,
                      int count)

mergeDynamicData

public void mergeDynamicData(InternalsImpl other)

getJdk

public JdkImpl getJdk()

Description copied from interface: Internals

Information about the installed Java runtime environment.

Specified by:

getJdk in interface Internals

setJdk

public void setJdk(JdkImpl jdk)

getCamundaIntegration

public Set<String> getCamundaIntegration()

Description copied from interface: Internals

Used Camunda integrations (e.g, Spring boot starter, Camunda Platform Run, WildFly/JBoss subsystem or Camunda EJB service).

Specified by:

getCamundaIntegration in interface Internals

setCamundaIntegration

public void setCamundaIntegration(Set<String> camundaIntegration)

getLicenseKey

public LicenseKeyDataImpl getLicenseKey()

Description copied from interface: Internals

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

Specified by:

getLicenseKey in interface Internals

setLicenseKey

public void setLicenseKey(LicenseKeyDataImpl licenseKey)

isTelemetryEnabled

public Boolean isTelemetryEnabled()

setTelemetryEnabled

public void setTelemetryEnabled(Boolean telemetryEnabled)

getWebapps

public Set<String> getWebapps()

Description copied from interface: Internals

Webapps enabled in the Camunda installation (e.g., cockpit, admin, tasklist).

Specified by:

getWebapps in interface Internals

setWebapps

public void setWebapps(Set<String> webapps)