org.adroitlogic.x.api.metrics

Interface MetricsReportable

All Known Implementing Classes:

AbstractBiDirectionalEgressConnectorElement, AbstractContentExtractProcessor, AbstractFlowEndProcessingElement, AbstractProcessingElement, AbstractScopeEndElement, AbstractScopeStartElement, AbstractSequencedProcessingElement, AbstractValidator, AddVariable, BiDirectionalAsyncEgressConnectorElement, BiDirectionalEgressConnectorElement, CallOutEgressConnectorElement, CallOutTypedEgressConnectorElement, EgressConnectorElement, ExceptionalFlowEnd, ExecutorMetricsReporter, GetDestinationUri, IngressConnectorElement, IntegrationFlow, MockInOnlyProcessingElement, MockInOutProcessingElement, MockProcessingElement, OneWayEgressConnectorElement, RemoveVariable, ResponseIngressConnectorElement, ScheduledIngressConnectorElement, SetDestinationUri, SubFlowEnd, SubFlowReference, SubFlowStart, SuccessfulFlowEnd, SystemInfoCollectorTask, TransactionScopeEndElement, TransactionScopeStartElement, UniDirectionalResponseEgressConnectorElement, XTimerMetricsReporter

public interface MetricsReportable

Interface class to be implemented by any class reporting metrics to the metrics engine

Since:

17.01

Author:

Udith Gunaratna

Method Summary

Modifier and Type	Method and Description
default Map<String,String>	getAdditionalProperties() Returns a map of additional properties to be set in the metrics records
String	getEntityId() Returns the entity ID to be used for metrics streams
default String	getFlowId() Returns the flow ID to be used for metrics streams
XMetricsEngine	getMetricsEngine() Retrieves the metrics engine to be used for this class
default String	getProjectId() Returns the project name to be used for metrics streams
default String	getProjectVersion() Returns the project version to be used for metrics streams

Method Detail

getMetricsEngine

XMetricsEngine getMetricsEngine()

Retrieves the metrics engine to be used for this class

Returns:

instance of XMetricsEngine

getEntityId

String getEntityId()

Returns the entity ID to be used for metrics streams

Returns:

entity ID

getFlowId

default String getFlowId()

Returns the flow ID to be used for metrics streams

Returns:

flow ID

getProjectId

default String getProjectId()

Returns the project name to be used for metrics streams

Returns:

project name

getProjectVersion

default String getProjectVersion()

Returns the project version to be used for metrics streams

Returns:

project version

getAdditionalProperties

default Map<String,String> getAdditionalProperties()

Returns a map of additional properties to be set in the metrics records

Returns:

additional properties