View Source OpenTelemetry.SemConv.Incubating.Metrics.MessagingMetrics (OpenTelemetry.SemConv v1.27.0)

OpenTelemetry Semantic Conventions for Messaging metrics.

Summary

Functions

Number of messages that were delivered to the application.

Duration of messaging operation initiated by a producer or consumer client.

Number of messages producer attempted to publish to the broker.

Duration of processing operation.

Functions

Link to this function

messaging_client_consumed_messages()

View Source
@spec messaging_client_consumed_messages() :: :"messaging.client.consumed.messages"

Number of messages that were delivered to the application.

Instrument: counter
Unit: {message}

Notes

Records the number of messages pulled from the broker or number of messages dispatched to the application in push-based scenarios.
The metric SHOULD be reported once per message delivery. For example, if receiving and processing operations are both instrumented for a single message delivery, this counter is incremented when the message is received and not reported when it is processed.

iex> OpenTelemetry.SemConv.Incubating.Metrics.MessagingMetrics.messaging_client_consumed_messages()
:"messaging.client.consumed.messages"
Link to this function

messaging_client_operation_duration()

View Source
@spec messaging_client_operation_duration() :: :"messaging.client.operation.duration"

Duration of messaging operation initiated by a producer or consumer client.

Instrument: histogram
Unit: s

Notes

This metric SHOULD NOT be used to report processing duration - processing duration is reported in messaging.process.duration metric.

iex> OpenTelemetry.SemConv.Incubating.Metrics.MessagingMetrics.messaging_client_operation_duration()
:"messaging.client.operation.duration"
Link to this function

messaging_client_published_messages()

View Source
@spec messaging_client_published_messages() :: :"messaging.client.published.messages"

Number of messages producer attempted to publish to the broker.

Instrument: counter
Unit: {message}

Notes

This metric MUST NOT count messages that were created haven't yet been attempted to be published.

iex> OpenTelemetry.SemConv.Incubating.Metrics.MessagingMetrics.messaging_client_published_messages()
:"messaging.client.published.messages"
Link to this function

messaging_process_duration()

View Source
@spec messaging_process_duration() :: :"messaging.process.duration"

Duration of processing operation.

Instrument: histogram
Unit: s

Notes

This metric MUST be reported for operations with messaging.operation.type that matches process.

iex> OpenTelemetry.SemConv.Incubating.Metrics.MessagingMetrics.messaging_process_duration()
:"messaging.process.duration"
Link to this function

messaging_process_messages()

View Source
This function is deprecated. Replaced by `messaging.client.consumed.messages`. .
@spec messaging_process_messages() :: :"messaging.process.messages"
Link to this function

messaging_publish_duration()

View Source
This function is deprecated. Replaced by `messaging.client.operation.duration`. .
@spec messaging_publish_duration() :: :"messaging.publish.duration"
Link to this function

messaging_publish_messages()

View Source
This function is deprecated. Replaced by `messaging.client.produced.messages`. .
@spec messaging_publish_messages() :: :"messaging.publish.messages"
Link to this function

messaging_receive_duration()

View Source
This function is deprecated. Replaced by `messaging.client.operation.duration`. .
@spec messaging_receive_duration() :: :"messaging.receive.duration"
Link to this function

messaging_receive_messages()

View Source
This function is deprecated. Replaced by `messaging.client.consumed.messages`. .
@spec messaging_receive_messages() :: :"messaging.receive.messages"