faultfixer

README

faultfixer-go (Go)

FaultFixer error monitoring for Go. Drop-in wrapper around the open-source sentry-go (MIT).

go get github.com/fault-fixer/faultfixer-go

package main

import (
	"time"

	faultfixer "github.com/fault-fixer/faultfixer-go"
)

func main() {
	faultfixer.Init(faultfixer.Options{Dsn: "<YOUR_DSN>"})
	defer faultfixer.Flush(2 * time.Second)

	if err := doWork(); err != nil {
		faultfixer.CaptureException(err)
	}
}

Attribution

Wraps sentry-go under the MIT License. See NOTICE.md. "Sentry" is a trademark of Functional Software, Inc.; this package is not affiliated with Sentry.

Documentation

Overview

Package faultfixer is the FaultFixer error monitoring SDK for Go.

It is a thin wrapper around the open-source sentry-go SDK (MIT, (c) 2019 Sentry). See NOTICE.md for full upstream attribution.

Index

• func Flush(timeout time.Duration) bool
• func Init(options Options) error
• type EventID
  • func CaptureException(err error) *EventID
  • func CaptureMessage(message string) *EventID
  • func Recover() *EventID
• type Options

Functions

func Flush

func Flush(timeout time.Duration) bool

Flush waits until buffered events are sent, up to the given timeout.

func Init

func Init(options Options) error

Init initializes FaultFixer. Set Options.Dsn to your project DSN.

Types

type EventID

type EventID = sentry.EventID

EventID re-exports the underlying event identifier type.

func CaptureException

func CaptureException(err error) *EventID

CaptureException reports an error to FaultFixer.

func CaptureMessage

func CaptureMessage(message string) *EventID

CaptureMessage reports a message to FaultFixer.

func Recover

func Recover() *EventID

Recover captures a panic. Use with defer.

type Options

type Options = sentry.ClientOptions

Options re-exports sentry-go client options so callers never import Sentry.