YMJake.RocketMQ.Client.OpenTelemetry 1.0.1

YMJake.RocketMQ.Client.OpenTelemetry

OpenTelemetry instrumentation for YMJake.RocketMQ.Client - Automatic distributed tracing for Apache RocketMQ 5.x messaging operations.

Features

• ✅ Automatic tracing for message send and receive operations
• ✅ W3C Trace Context propagation (traceparent/tracestate)
• ✅ OpenTelemetry semantic conventions for messaging
• ✅ RocketMQ-specific attributes (namespace, message type, tags, etc.)
• ✅ Batch message support
• ✅ Customizable filtering and enrichment
• ✅ Zero code changes required in your application

Supports .NET 8.0 (LTS) and .NET 10.0

Installation

dotnet add package YMJake.RocketMQ.Client.OpenTelemetry

Quick Start

using OpenTelemetry;
using OpenTelemetry.Resources;
using OpenTelemetry.Trace;
using RocketMQ.Client.OpenTelemetry;

var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .SetResourceBuilder(ResourceBuilder.CreateDefault()
        .AddService("my-service"))
    .AddRocketMqInstrumentation()
    .AddOtlpExporter()  // or AddConsoleExporter(), AddJaegerExporter(), etc.
    .Build();

That's it! The instrumentation automatically listens to DiagnosticListener events emitted by the RocketMQ client and produces spans for all send and receive operations.

Advanced Configuration

Filtering Messages

.AddRocketMqInstrumentation(options =>
{
    // Only trace messages from specific topics
    options.Filter = data => 
        data.Messages.Any(m => m.Topic.StartsWith("important-"));
})

Custom Tag Conversion

.AddRocketMqInstrumentation(options =>
{
    // Truncate message IDs for readability
    options.TagValueConverter = (name, value) =>
        name == "messaging.message.id" ? value?.Substring(0, 8) : value;
})

Additional Attributes

.AddRocketMqInstrumentation(options =>
{
    options.AdditionalAttributes["environment"] = () => "production";
    options.AdditionalAttributes["version"] = () => "1.0.0";
})

Span Attributes

The instrumentation follows OpenTelemetry semantic conventions and adds the following attributes:

Standard Messaging Attributes

• messaging.system = "rocketmq"
• messaging.operation = "publish" | "receive"
• messaging.destination.name = topic name
• messaging.message.id = message ID
• messaging.message.body.size = message body size in bytes
• messaging.batch.message_count = number of messages in batch
• messaging.client_id = RocketMQ client ID

RocketMQ-Specific Attributes

• messaging.rocketmq.namespace = RocketMQ namespace
• messaging.rocketmq.message.type = "normal" | "fifo" | "delay"
• messaging.rocketmq.message.tag = message tag
• messaging.rocketmq.message.group = message group (for FIFO)
• messaging.rocketmq.client_group = consumer group
• messaging.rocketmq.message.delivery_timestamp = scheduled delivery time

How It Works

The instrumentation uses .NET's DiagnosticListener to subscribe to events emitted by the RocketMQ client. It automatically:

1. Creates spans for send and receive operations
2. Propagates trace context via message properties (traceparent/tracestate)
3. Links consumer spans to producer spans for distributed tracing
4. Sets appropriate span status based on operation results

No changes are required in your application code beyond adding the instrumentation to your TracerProvider.

License

Apache License 2.0. Based on Apache RocketMQ Clients.

Links

• Main Package: YMJake.RocketMQ.Client
• Repository: Gitee