otelSDK

otelSDK

This SDK wraps the Opentelemetry libraries to increase maintainability and time to development. The rationale being that if you dont use this approach, then OTEL imports will run throughout your code base and should changes be necessary they will be required for each instance of use.

The SDK currently only supports stdout tracing to file, this will be improved shortly

Simple usage

Instantiate at application startup

ctx := context.TODO()
var shutdownTracer otelSDK.ShutdownTracerFn
ctx, shutdownTracer, err = myOtel.ConfigureStdoutTracing(ctx, APPNAME)
if err != nil {
    defer shutdownTracer()
}

Add HTTP middleware

// Example comments for github.com/gorilla/mux but works with any
// var handler http.Handler

handler = myOtel.NewTracedHttpHandler(context.TODO(), "myAppName", handler)

// add other handlers, e.g.
// handler = HttpLogger(handler, route.Name)

// router.
//    Methods(route.Method).
//    Path(route.Pattern).
//    Name(route.Name).
//    Handler(handler)

Instrument your top level HTTP request handlers, plus any processing within as required

func myRequestHandler(w http.ResponseWriter, r *http.Request) {
{
    var span otelSDK.Span
    ctx, span = otelSDK.TraceStart(ctx, "MyAppName", "MyCausationId", "MyCorrelationId")
    defer otelSDK.TraceEnd(span)

    // insert your request handler code here
    // set any attributes and events as required:
    span = otelSDK.TraceSetStringAttribute(span, key, value)
    otelSDK.TraceAddEvent(span, "my note that an event occurred")

    // at end of the handler, write any errors
    if err != nil {
        myOtel.TraceError(span, err)
    }
}

Include any other third party libs directly in your code

opentelemetry.io/docs/instrumentation/go/libraries/