otel

OpenTelemetry Package

Home  /  OpenTelemetry Package

The otel package provides OpenTelemetry integration for the go-rabbitmq library. It implements the MetricsCollector and Tracer interfaces using OpenTelemetry semantic conventions for messaging systems, enabling production-grade observability for your RabbitMQ applications.

Features

• OpenTelemetry Metrics: Full metrics collection using OpenTelemetry SDK
• Distributed Tracing: Span creation and context propagation for publish/consume operations
• Semantic Conventions: Follows OpenTelemetry Messaging Semantic Conventions
• Connection Metrics: Track connections, reconnections, and connection attempts
• Publishing Metrics: Monitor publish operations, confirmations, and message sizes
• Consumption Metrics: Track message consumption, processing, and requeue events
• Delivery Assurance Metrics: Monitor delivery outcomes and timeouts
• Health Check Metrics: Track health check operations and durations
• Error Tracking: Comprehensive error counting by operation type

🔝 back to top

Installation

go get github.com/cloudresty/go-rabbitmq/otel

🔝 back to top

Quick Start

Basic OpenTelemetry Integration

package main

import (
    "context"
    "log"

    "github.com/cloudresty/go-rabbitmq"
    rabbitotel "github.com/cloudresty/go-rabbitmq/otel"
    "go.opentelemetry.io/otel"
)

func main() {
    // Get OpenTelemetry meter and tracer from your provider
    meter := otel.Meter("rabbitmq-client")
    tracer := otel.Tracer("rabbitmq-client")

    // Create OpenTelemetry metrics collector
    metrics, err := rabbitotel.NewMetricsCollector(meter)
    if err != nil {
        log.Fatal("Failed to create metrics collector:", err)
    }

    // Create OpenTelemetry tracer wrapper
    otelTracer := rabbitotel.NewTracer(tracer)

    // Create RabbitMQ client with OpenTelemetry observability
    client, err := rabbitmq.NewClient(
        rabbitmq.FromEnv(),
        rabbitmq.WithMetrics(metrics),
        rabbitmq.WithTracer(otelTracer),
    )
    if err != nil {
        log.Fatal("Failed to create client:", err)
    }
    defer client.Close()

    // All publish/consume operations are now traced and metered
    publisher, _ := client.NewPublisher()
    _ = publisher.Publish(context.Background(), "events", "user.created",
        rabbitmq.NewMessage([]byte(`{"user_id": "123"}`)))
}

🔝 back to top

Metrics Reference

Connection Metrics

Publishing Metrics

Delivery Assurance Metrics

Consumption Metrics

Health Metrics

🔝 back to top

Semantic Conventions

This package follows the OpenTelemetry Semantic Conventions for Messaging. The following attributes are automatically added to spans and metrics:

🔝 back to top

API Reference

For detailed API documentation, see API Reference.

🔝 back to top

Cloudresty

Website  |  LinkedIn  |  BlueSky  |  GitHub  |  Docker Hub

_{© Cloudresty - All rights reserved}