otelkit

README

otelkit

OpenTelemetry middlewares for go-kit

Usage

setup tracer provider before server run.

package main

import (
	"context"
	"github.com/go-kit/kit/transport/http"
	"github.com/nnnewb/otelkit"
	"go.opentelemetry.io/otel"
	"go.opentelemetry.io/otel/exporters/jaeger"
	"go.opentelemetry.io/otel/sdk/resource"
	tracesdk "go.opentelemetry.io/otel/sdk/trace"
	semconv "go.opentelemetry.io/otel/semconv/v1.17.0"
	"log"
	"time"
)

func main() {
	// Create the Jaeger exporter
	exp, err := jaeger.New(jaeger.WithCollectorEndpoint(jaeger.WithEndpoint(url)))
	if err != nil {
		log.Fatal(err)
	}

	tp := tracesdk.NewTracerProvider(
		// Always be sure to batch in production.
		tracesdk.WithBatcher(exp),
		// Record information about this application in a Resource.
		tracesdk.WithResource(resource.NewWithAttributes(
			semconv.SchemaURL,
			semconv.ServiceName(service),
		)),
	)

	// Register our TracerProvider as the global so any imported
	// instrumentation in the future will default to using it.
	otel.SetTracerProvider(tp)

	ctx, cancel := context.WithCancel(context.Background())
	defer cancel()

	// Cleanly shutdown and flush telemetry when the application exits.
	defer func(ctx context.Context) {
		// Do not make the application hang when it is shutdown.
		ctx, cancel = context.WithTimeout(ctx, time.Second*5)
		defer cancel()
		if err := tp.Shutdown(ctx); err != nil {
			log.Fatal(err)
		}
	}(ctx)

	// ...
	
	svr := http.NewServer(
		ep,
		enc,
		dec, 
		otelkit.OpenTelemetryTraceServer(),
		otelkit.OpenTelemetryTraceServerResp(),
		otelkit.OpenTelemetryTraceServerEnd())
}

Documentation

Index

• func OpenTelemetryTraceClient() khttp.ClientOption
• func OpenTelemetryTraceClientEnd() khttp.ClientOption
• func OpenTelemetryTraceClientResp() khttp.ClientOption
• func OpenTelemetryTraceServer() khttp.ServerOption
• func OpenTelemetryTraceServerEnd() khttp.ServerOption
• func OpenTelemetryTraceServerResp() khttp.ServerOption

Functions

func OpenTelemetryTraceClient

func OpenTelemetryTraceClient() khttp.ClientOption

func OpenTelemetryTraceClientEnd

func OpenTelemetryTraceClientEnd() khttp.ClientOption

func OpenTelemetryTraceClientResp

func OpenTelemetryTraceClientResp() khttp.ClientOption

func OpenTelemetryTraceServer

func OpenTelemetryTraceServer() khttp.ServerOption

func OpenTelemetryTraceServerEnd

func OpenTelemetryTraceServerEnd() khttp.ServerOption

func OpenTelemetryTraceServerResp

func OpenTelemetryTraceServerResp() khttp.ServerOption