sermojohn / otelkafka

This repository provides instrumentation library for github.com/confluentinc/confluent-kafka-go

Instrumentation for `github.com/confluentinc/confluent-kafka-go/kafka

This instrumentation is for the github.com/confluentinc/confluent-kafka-go/kafka package.

Compatibility

The Producer will end spans when a delivery report is returned. Setting "go.delivery.reports" to false will disable the delivery reports and can result in an build up of un-ended spans. If delivery reports are disabled, an un-instrumented Producer should be used instead.

This instrumentation was built to support v1.7.0 of github.com/confluentinc/confluent-kafka-go/kafka. Similar to the instrumented package, librdkafka 1.6.0+ is required. This means you will need to use an environment that supports the pre-built binaries, or install the library manually. Important to note, similar to the instrumented package, cgo is required and this instrumentation does not support the Windows operating system.

Getting started

The NewConsumer and NewProducer functions are provided as drop-in replacements of the equivalent from the kafka package. See these examples for how to use these functions.

Credits

This repository forked from splunk-otel-go confluent-kafka-go, copyrighted by:

// Copyright Splunk Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.