sentry

Documentation

Index

• func Hub(hub *sentry.Hub) zapcore.Field
• func StreamServerInterceptor(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, ...) error
• func UnaryServerInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, ...) (interface{}, error)
• type Config
  • func (c Config) InitializeSentry() error
  • func (c *Config) RegisterFlags(flags *pflag.FlagSet)
• type Core
  • func (c *Core) Check(ent zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry
  • func (c *Core) Sync() error
  • func (c *Core) With(fields []zapcore.Field) zapcore.Core
  • func (c *Core) Write(ent zapcore.Entry, fields []zapcore.Field) error
• type Middleware
  • func NewMiddleware() Middleware
  • func (m Middleware) HTTP(next http.Handler) http.Handler

Functions

func Hub

func Hub(hub *sentry.Hub) zapcore.Field

Hub attaches a Sentry hub to the logger such that if the logger ever logs an error, request context can be sent to Sentry.

func StreamServerInterceptor

func StreamServerInterceptor(srv interface{}, stream grpc.ServerStream, info *grpc.StreamServerInfo, handler grpc.StreamHandler) error

StreamServerInterceptor returns a new streaming server interceptor with the sentry hub placed in the context

func UnaryServerInterceptor

func UnaryServerInterceptor(ctx context.Context, req interface{}, info *grpc.UnaryServerInfo, handler grpc.UnaryHandler) (interface{}, error)

UnaryServerInterceptor returns a new unary server interceptor with the sentry hub placed in the context

Types

type Config

type Config struct {
	DSN         string
	Environment string
	AppVersion  string
}

Config defines the necessary configuration for instantiating a Sentry Reporter

func (Config) InitializeSentry

func (c Config) InitializeSentry() error

InitializeSentry Initializes the Sentry client. This function should be called as soon as possible after the application configuration is loaded so that sentry is setup.

func (*Config) RegisterFlags

func (c *Config) RegisterFlags(flags *pflag.FlagSet)

RegisterFlags registers Sentry flags with pflags

type Core

type Core struct {
	zapcore.LevelEnabler
	// contains filtered or unexported fields
}

Core Implements a zapcore.Core that sends logged errors to Sentry

func (*Core) Check

func (c *Core) Check(ent zapcore.Entry, ce *zapcore.CheckedEntry) *zapcore.CheckedEntry

Check must be called before calling Write. This determines whether or not logs are sent to Sentry

func (*Core) Sync

func (c *Core) Sync() error

Sync flushes any buffered logs

func (*Core) With

func (c *Core) With(fields []zapcore.Field) zapcore.Core

With adds structured context to the Sentry Core

func (*Core) Write

func (c *Core) Write(ent zapcore.Entry, fields []zapcore.Field) error

Write logs the entry and fields supplied at the log site and writes them to their destination. If a Sentry Hub field is present in the fields, that Hub will be used for reporting to Sentry, otherrwise the default Sentry Hub will be used.

type Middleware

type Middleware struct {
	// contains filtered or unexported fields
}

Middleware contains a Sentry handler

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware creates a new Sentry middleware object

func (Middleware) HTTP

func (m Middleware) HTTP(next http.Handler) http.Handler

This middleware is a wrapper around the sentry-go library's middleware that attaches a the Sentry hub that from the request context to the logger. That way, if the logger ever writes an error log, instead of just sending the log message and fields provided to the logger to Sentry, Sentry is able to capture the entire request context i.e. the request path, headers present, etc. If this middleware is attached after the tracing middleware, the corresponding Trace ID will be added to the Sentry scope.