Configurations

Config

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x 

Turn Off Tracing

Boolean

Turn off tracing for this application.

false

 

Turn Off Metrics

Boolean

Turn off Metrics for this application.

false

 

Metrics Provider

One of:

OpenTelemetry Metrics Provider

 

Name

String

The identifier of this element used to reference it in other components

x 

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform will expire the instance at the exact moment that it becomes eligible. The runtime will actually purge the instances when it sees it fit.

 

Service Name

String

Service name for this application.

x 

Resource Attributes

Array of Attribute

 

OpenTelemetry Exporter

Open Telemetry Exporter Configuration. System or Environment Variables will override this configuration. See Documentation for variable details.

 

Span All Processors

Boolean

By default, Spans are created for known components only. Setting this flag to true will create trace spans for every processor in a flow.

false

 

Disable Spans for

Array of Mule Component

When generating spans for all processors, this list defines the processors that should be skipped from tracing. No spans will be generated for these components.

 

Disable Interception for

Array of Mule Component

Module uses message processor interception mechanism to inject trace context variable. Any specific message processor (namespace:name) or specific namespace (namespace:*) can be excluded from this interception process.

 

Enable Interception for

Array of Mule Component

Module uses message processor interception mechanism to inject trace context variable. Any specific message processor (namespace:name) or specific namespace (namespace:*) can be included from this interception process.

 

Max Queue Size

Number

The maximum number of spans in the waiting queue. Any new spans are dropped once the queue is full.

2048

 

Max Batch Export Size

Number

The maximum number of spans to export in a single batch. This must be smaller or equal to Max Queue Size.

512

 

Batch Export Delay Interval

Number

The delay interval in milliseconds between two consecutive batch exports.

5000

 

Batch Export Timeout

Number

The Maximum number of milliseconds the exporter will wait for a batch to export before cancelling the export.

30000

 

Associated Operations

Operations

Add Custom Tags

<opentelemetry:add-custom-tags>

Deprecated: Use addTransactionTags instead. When OTEL_TRACE_CONTEXT does not pre-exist,there is no way for users to get current transaction id.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Trace Transaction Id

String

#[vars.OTEL_TRACE_CONTEXT.TRACE_TRANSACTION_ID]

 

Tags

Object

Map of String Keys and String Values containing the tags. Behavior of null values in the map is undefined and not recommended.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

For Configurations

Add Transaction Tags

<opentelemetry:add-transaction-tags>

Add custom tags to an ongoing trace transaction. The tags will be added as attributes to the root span of this transaction. If the transaction’s root span previously contained a mapping for the key, the old value is replaced by the new value.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Tags

Object

Map of String Keys and String Values containing the tags. Behavior of null values in the map is undefined and not recommended.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

For Configurations

Get Current Trace Context

<opentelemetry:get-current-trace-context>

Get the trace context for current trace transaction.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Object

For Configurations

Get Trace Context

<opentelemetry:get-trace-context>

Deprecated: Use Get Current Trace Context instead. When OTEL_TRACE_CONTEXT does not pre-exist, there is no way for users to get current transaction id.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x 

Trace Transaction Id

String

provided by user

#[vars.OTEL_TRACE_CONTEXT.TRACE_TRANSACTION_ID]

 

Config Ref

ConfigurationProvider

The name of the configuration to be used to execute this component

x 

Target Variable

String

The name of a variable on which the operation’s output will be placed

 

Target Value

String

An expression that will be evaluated against the operation’s output and the outcome of that expression will be stored in the target variable

#[payload]

 

Output

Type

Object

For Configurations

Types

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute

Attribute

Field Type Description Default Value Required

Key

String

x

Value

String

x

Mule Component

Field Type Description Default Value Required

Namespace

String

x

Name

String

x

Otlp Exporter

Field Type Description Default Value Required

Collector Endpoint

String

Protocol

Enumeration, one of:

  • GRPC

  • HTTP_PROTOBUF

GRPC

Request Compression

Enumeration, one of:

  • NONE

  • GZIP

NONE

Endpoint Cert Path

String

Client Cert Path

String

Client Cert Key Path

String

Headers

Array of Header

Config Properties

Object
Field Type Description Default Value Required

Key

String

x

Value

String

x

Logging Exporter

Field Type Description Default Value Required

Log Prefix

String

Config Properties

Object

Generic Exporter

Field Type Description Default Value Required

Config Properties

Object