Package com.avioconsulting.mule.opentelemetry.api.providers

Interface OpenTelemetryMetricsProvider<T extends OpenTelemetryMetricsConfigProvider>

All Known Implementing Classes:

OpenTelemetryMetricsProviderCollection

public interface OpenTelemetryMetricsProvider<T extends OpenTelemetryMetricsConfigProvider>

Service interface for Metrics providers

Method Summary

Modifier and Type	Method	Description
void	addMeteredComponent(String location)	Add a single component location for capturing metrics.
<N extends MetricBaseNotificationData<N>> void	captureCustomMetric(N metricNotification)	For any notifications raised with MetricBaseNotificationData's subclass as a notification data, this module will delegate
void	captureFlowMetrics(TransactionMeta transactionMeta, String flowName, Exception exception)	This method is called when processing start or end of a Mule flow.
void	captureProcessorMetrics(org.mule.runtime.api.component.Component component, org.mule.runtime.api.message.Error error, String location, SpanMeta spanMeta)	This method is called for capturing Mule Processor event metrics such as start or end of the execution.
void	initialize(T configProvider, io.opentelemetry.api.OpenTelemetry openTelemetry)	Initialize provider
void	stop()

Method Detail

initialize

void initialize(T configProvider,
                io.opentelemetry.api.OpenTelemetry openTelemetry)

Initialize provider

Parameters:

configProvider -

stop

void stop()

addMeteredComponent

void addMeteredComponent(String location)

Add a single component location for capturing metrics.

Parameters:

location - String value of target processor

captureProcessorMetrics

void captureProcessorMetrics(org.mule.runtime.api.component.Component component,
                             org.mule.runtime.api.message.Error error,
                             String location,
                             SpanMeta spanMeta)

This method is called for capturing Mule Processor event metrics such as start or end of the execution. Implement this method for capture any processor metrics.

Parameters:

component - Component instance of the Processor

error - Nullable Error if any associated with the event.

location - String of the associated processor

spanMeta - SpanMeta for any additional information about related Span

captureFlowMetrics

void captureFlowMetrics(TransactionMeta transactionMeta,
                        String flowName,
                        Exception exception)

This method is called when processing start or end of a Mule flow. Implement this method to capture any flow metrics.

Parameters:

transactionMeta - TransactionMeta for any information about related transaction span.

flowName - String name of the associated flow

exception - Nullable Exception if any associated with the event

captureCustomMetric

<N extends MetricBaseNotificationData<N>> void captureCustomMetric(N metricNotification)

For any notifications raised with MetricBaseNotificationData's subclass as a notification data, this module will delegate

Type Parameters:

N - Sub-class of MetricBaseNotificationData

Parameters:

metricNotification - MetricBaseNotificationData for the metric