zlogsentry

README

zerolog-sentry

Example

import (
	"errors"
	stdlog "log"
	"os"

	"github.com/archdx/zerolog-sentry"
	"github.com/rs/zerolog"
)

func main() {
	w, err := zlogsentry.New("http://e35657dcf4fb4d7c98a1c0b8a9125088@localhost:9000/2", zlogsentry.WithEnvironment("dev"), zlogsentry.WithRelease("1.0.0"))
	if err != nil {
		stdlog.Fatal(err)
	}

	defer w.Close()

	multi := zerolog.MultiLevelWriter(os.Stdout, w)
	logger := zerolog.New(multi).With().Timestamp().Logger()

	logger.Error().Err(errors.New("dial timeout")).Msg("test message")
}

Documentation

Index

• Variables
• type EventHintCallback
• type Writer
  • func New(dsn string, opts ...WriterOption) (*Writer, error)
  • func NewWithHub(hub *sentry.Hub, opts ...WriterOption) (*Writer, error)
  • func (w *Writer) Close() error
  • func (w *Writer) Write(data []byte) (n int, err error)
  • func (w *Writer) WriteLevel(level zerolog.Level, p []byte) (n int, err error)
• type WriterOption
  • func WithAttachStacktrace() WriterOption
  • func WithBeforeSend(beforeSend sentry.EventProcessor) WriterOption
  • func WithBreadcrumbs() WriterOption
  • func WithCaCerts(caCerts *x509.CertPool) WriterOption
  • func WithDebug() WriterOption
  • func WithDebugWriter(w io.Writer) WriterOption
  • func WithEnvironment(environment string) WriterOption
  • func WithHttpClient(httpClient *http.Client) WriterOption
  • func WithHttpProxy(proxy string) WriterOption
  • func WithHttpsProxy(proxy string) WriterOption
  • func WithIgnoreErrors(reList []string) WriterOption
  • func WithLevels(levels ...zerolog.Level) WriterOption
  • func WithMaxErrorDepth(maxErrorDepth int) WriterOption
  • func WithRelease(release string) WriterOption
  • func WithSampleRate(rate float64) WriterOption
  • func WithServerName(serverName string) WriterOption
  • func WithTracing() WriterOption
  • func WithTracingSampleRate(tsr float64) WriterOption

Variables

var ErrFlushTimeout = errors.New("zlogsentry flush timeout")

Types

type EventHintCallback

type EventHintCallback func(event *sentry.Event, hint *sentry.EventHint) *sentry.Event

type Writer

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

Writer is a sentry events writer with std io.Writer iface.

func New

func New(dsn string, opts ...WriterOption) (*Writer, error)

New creates writer with provided DSN and options.

func NewWithHub

func NewWithHub(hub *sentry.Hub, opts ...WriterOption) (*Writer, error)

NewWithHub creates a writer using an existing sentry Hub and options.

func (*Writer) Close

func (w *Writer) Close() error

Close forces client to flush all pending events. Can be useful before application exits.

func (*Writer) Write

func (w *Writer) Write(data []byte) (n int, err error)

Write handles zerolog's json and sends events to sentry.

func (*Writer) WriteLevel

func (w *Writer) WriteLevel(level zerolog.Level, p []byte) (n int, err error)

implements zerolog.LevelWriter

type WriterOption

type WriterOption interface {
	// contains filtered or unexported methods
}

WriterOption configures sentry events writer.

func WithAttachStacktrace

func WithAttachStacktrace() WriterOption

WithAttachStacktrace enabled AttachStacktrace.

func WithBeforeSend

func WithBeforeSend(beforeSend sentry.EventProcessor) WriterOption

WithBeforeSend sets a callback which is called before event is sent.

func WithBreadcrumbs

func WithBreadcrumbs() WriterOption

WithBreadcrumbs enables sentry client breadcrumbs.

func WithCaCerts

func WithCaCerts(caCerts *x509.CertPool) WriterOption

WithCaCerts enables sentry client tracing.

func WithDebug

func WithDebug() WriterOption

WithDebug enables sentry client debug logs.

func WithDebugWriter

func WithDebugWriter(w io.Writer) WriterOption

WithDebugWriter enables sentry client tracing.

func WithEnvironment

func WithEnvironment(environment string) WriterOption

WithEnvironment configures the environment to be sent with events.

func WithHttpClient

func WithHttpClient(httpClient *http.Client) WriterOption

WithHttpClient sets custom http client.

func WithHttpProxy

func WithHttpProxy(proxy string) WriterOption

WithHttpProxy enables sentry client tracing.

func WithHttpsProxy

func WithHttpsProxy(proxy string) WriterOption

WithHttpsProxy enables sentry client tracing.

func WithIgnoreErrors

func WithIgnoreErrors(reList []string) WriterOption

WithIgnoreErrors configures the list of regexp strings that will be used to match against event's message and if applicable, caught errors type and value. If the match is found, then a whole event will be dropped.

func WithLevels

func WithLevels(levels ...zerolog.Level) WriterOption

WithLevels configures zerolog levels that have to be sent to Sentry. Default levels are: error, fatal, panic.

func WithMaxErrorDepth

func WithMaxErrorDepth(maxErrorDepth int) WriterOption

WithMaxErrorDepth sets the max depth of error chain.

func WithRelease

func WithRelease(release string) WriterOption

WithRelease configures the release to be sent with events.

func WithSampleRate

func WithSampleRate(rate float64) WriterOption

WithSampleRate configures the sample rate as a percentage of events to be sent in the range of 0.0 to 1.0.

func WithServerName

func WithServerName(serverName string) WriterOption

WithServerName configures the server name field for events. Default value is OS hostname.

func WithTracing

func WithTracing() WriterOption

WithTracing enables sentry client tracing.

func WithTracingSampleRate

func WithTracingSampleRate(tsr float64) WriterOption

WithTracingSampleRate sets tracing sample rate.