ocsentry

README

ocsentry

Provides OpenCensus traces support for Sentry.

Why?

OpenCensus has tracing instrumentations for a variety of technologies (databases, services, caches, etc...), this library enables those instrumentations for Sentry performance tools with minimal effort.

Also implementing traces with Sentry client directly makes it harder to change the technology in the future, as opposed to vendor-unlocked OpenCensus.

Usage

• Replace default tracer with a wrapper: trace.DefaultTracer = ocsentry.WrapTracer(trace.DefaultTracer).
• Use ocsentry.HTTPHandlerMiddleware instead of github.com/getsentry/sentry-go/http.(*Handler).Handle so that original sentry tracer does not duplicate the ochttp job.

package main

import (
	"log"
	"net/http"
	"time"

	"github.com/getsentry/sentry-go"
	"github.com/vearutop/ocsentry"
	"go.opencensus.io/plugin/ochttp"
	"go.opencensus.io/trace"
)

func main() {
	// Initialize Sentry.
	err := sentry.Init(sentry.ClientOptions{
		Dsn:        "https://abc123abc123abc123abc123@o123456.ingest.sentry.io/1234567",
		ServerName: "my-service",
		Release:    "v1.2.3",
	})
	if err != nil {
		log.Fatal(err)
	}

	defer func() {
		sentry.Flush(time.Second)
	}()

	// Setup OC sampling.
	trace.ApplyConfig(trace.Config{
		DefaultSampler: trace.ProbabilitySampler(0.01),
	})

	// Enable Sentry wrapper.
	trace.DefaultTracer = ocsentry.WrapTracer(trace.DefaultTracer)

	var h http.Handler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		_, err := w.Write([]byte("Hello, world!"))
		if err != nil {
			log.Print(err)

			return
		}
	})

	// Apply OpenCensus middleware and Sentry middlewares to your http.Handler.
	h = ocsentry.HTTPHandlerMiddleware(h)
	h = &ochttp.Handler{Handler: h}

	if err := http.ListenAndServe(":80", h); err != nil {
		log.Print(err)

		return
	}
}

Documentation

Overview

Package ocsentry provides OpenCensus instrumentation for Sentry.

Index

• func ErrorHandler(ctx context.Context, input interface{}, err error)
• func HTTPHandlerMiddleware(h http.Handler) http.Handler
• func OnPanic(ctx context.Context, rcv interface{})
• func WrapTracer(tracer trace.Tracer, options ...Option) trace.Tracer
• type Option
  • func SkipTransactionNames(names ...string) Option
• type Options

Examples

• WrapTracer

Functions

func ErrorHandler

func ErrorHandler(ctx context.Context, input interface{}, err error)

ErrorHandler is a handler for ErrorCatcher of github.com/swaggest/usecase.

func HTTPHandlerMiddleware

func HTTPHandlerMiddleware(h http.Handler) http.Handler

HTTPHandlerMiddleware prepares request context without creating sentry trace span for trace span is to be created by OpenCensus instrumentation.

func OnPanic

func OnPanic(ctx context.Context, rcv interface{})

OnPanic handles recovered panics.

func WrapTracer

func WrapTracer(tracer trace.Tracer, options ...Option) trace.Tracer

WrapTracer creates a tracer that manages Sentry spans together with OpenCensus spans.

Example

// Initialize Sentry.
err := sentry.Init(sentry.ClientOptions{
	Dsn:        "https://abc123abc123abc123abc123@o123456.ingest.sentry.io/1234567",
	ServerName: "my-service",
	Release:    "v1.2.3",
})
if err != nil {
	log.Fatal(err)
}

defer func() {
	sentry.Flush(time.Second)
}()

// Setup OC sampling.
trace.ApplyConfig(trace.Config{
	DefaultSampler: trace.ProbabilitySampler(0.01),
})

// Enable Sentry wrapper.
trace.DefaultTracer = ocsentry.WrapTracer(trace.DefaultTracer)

var h http.Handler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
	_, err := w.Write([]byte("Hello, world!"))
	if err != nil {
		log.Print(err)

		return
	}
})

// Apply OpenCensus middleware and Sentry middlewares to your http.Handler.
h = ocsentry.HTTPHandlerMiddleware(h)
h = &ochttp.Handler{Handler: h}

if err := http.ListenAndServe(":80", h); err != nil {
	log.Print(err)

	return
}

Types

type Option

type Option func(o *Options)

Option is a functional option.

func SkipTransactionNames

func SkipTransactionNames(names ...string) Option

SkipTransactionNames is an option to skip transactions with provided names from sentry collection.

Can be useful to filter out automated requests that do not bring value, e.g. "GET /health", "GET /metrics".

type Options

type Options struct {
	SkipTransactionNames []string
}

Options control trace wrapper.