opentelemetry

README

Solace: solace.dev/go/messaging-trace/opentelemetry

The Solace PubSub+ OpenTelemetry Integration API for Go is used to handle injection and extraction of tracing information for carrier objects (Solace message) for a Solace PubSub+ Event Broker.

Getting Started

To get started using the Solace PubSub+ OpenTelemetry Integration API for Go, simply include it as a required module in your Go project by running go get solace.dev/go/messaging-trace/opentelemetry. The Solace PubSub+ OpenTelemetry Integration API for Go requires Go version 1.20+ (based on the minimum compatible version for opentelemtry-Go https://github.com/open-telemetry/opentelemetry-go/blob/main/README.md).

Usage

• Sample applications https://github.com/SolaceSamples/solace-samples-go.
• Documentation https://docs.solace.com/Solace-PubSub-Messaging-APIs/Go-API/go-home.htm
• Developer reference https://docs.solace.com/API-Developer-Online-Ref-Documentation/go/

OS Support

The Solace PubSub+ OpenTelemetry Integration API for Go has a hard depedency on the Solace PubSub+ API which is a wrapper around the high performance Solace C API via Cgo and has support for the following operating systems:

• Linux (x86/x86_64) variants with Linux 2.6 or later (compatible with glibc (desktop/server) and musl-c (Alpine Linux))
• Linux (arm64) variants compatible with glibc (desktop/server)
• Windows WSL 2.0
• macOS 10.15 and later (x86_64 versions)
• macOS 11.0 and later (arm64 versions)

Contributing

Ensure that you read CONTRIBUTING for details on the process for submitting pull requests to us.

Authors

See the list of contributors who participated in this project.

License

This project is licensed under the Apache License, Version 2.0. - See the LICENSE file for details.

This project packages and links against the Solace PubSub+ API. See the licenses for the packgae for details.

Code of Conduct

Note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Support

Ask Solace Community

Have a question? Ask the Solace Community!

Ask Solace Support

https://solace.com/support

Resources

• The Solace Developer Portal
• Understanding Solace technology

Copyright 2024 Solace Corporation. All rights reserved.

Documentation

Overview

Package opentelemetry contains the functions used to handle injection and extraction of tracing information for carrier objects (Solace message) for a Solace PubSub+ Event Broker.

Index

• Variables
• func NewInboundMessageCarrier(carrier message.InboundMessage) carrier.InboundMessageCarrier
• func NewOutboundMessageCarrier(carrier message.OutboundMessage) carrier.OutboundMessageCarrier
• func SemVersion() string
• func Version() string

Variables

var TracingPropertyName = internal.NewTracingPropertyNames()

TracingPropertyName - the tracing property names

Functions

func NewInboundMessageCarrier

func NewInboundMessageCarrier(carrier message.InboundMessage) carrier.InboundMessageCarrier

NewInboundMessageCarrier returns an instance of carrier.InboundMessageCarrier that can be used with otel integration for extracting tracing information from a received Inbound message.

func NewOutboundMessageCarrier

func NewOutboundMessageCarrier(carrier message.OutboundMessage) carrier.OutboundMessageCarrier

NewOutboundMessageCarrier returns an instance of carrier.OutboundMessageCarrier that can be used with otel integration for injecting tracing information before publishing an Outbound message.

func SemVersion

func SemVersion() string

SemVersion is the semantic version to be supplied to tracer/meter creation.

Deprecated: Use Version instead.

func Version

func Version() string

Version is the current release version of the Solace PubSub+ OpenTelemetry Integration API.