Skip to content

chadsr/logrus-sentry

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Sentry hook for Logrus logger

Tests codecov

Sentry hook for Logrus logger.

Examples

Basic:

import (
    "github.com/sirupsen/logrus"
    "github.com/getsentry/sentry-go"

    sentryhook "github.com/chadsr/logrus-sentry"
)

func main() {
    if err := sentry.Init(sentry.ClientOptions{Dsn: "aDSN"}); err != nil {
        log.Fatal(err)
    }
    
    logger := logrus.New()
    logger.AddHook(sentryhook.New([]logrus.Level{logrus.PanicLevel, logrus.FatalLevel, logrus.ErrorLevel}))
    
    logger.Fatal("the error would be sent to sentry")
}

Customize Sentry event:

import (
    "github.com/sirupsen/logrus"
    "github.com/getsentry/sentry-go"

    sentryhook "github.com/chadsr/logrus-sentry"
)

func main() {
    if err := sentry.Init(sentry.ClientOptions{Dsn: "aDSN"}); err != nil {
        log.Fatal(err)
    }
    
    logger := logrus.New()
    logger.AddHook(sentryhook.New(
        []logrus.Level{logrus.PanicLevel, logrus.FatalLevel, logrus.ErrorLevel},
        sentryhook.WithConverter(newConverter()),
    ))
    
    logger.
        WithField("corr_id", "aCorrId").
        WithField("user_id", "aUserId").
        Fatal("the error would be sent to sentry")
}

func newConverter() sentryhook.Converter {
    return func(entry *logrus.Entry, hub *sentry.Hub) *sentry.Event {
        event := sentryhook.DefaultConverter(entry, hub)

        if pkg, ok := entry.Data["pkg"].(string); ok {
            event.Logger = pkg
        }

        if corrID, ok := entry.Data["corr_id"].(string); ok {
            event.Tags["corr_id"] = corrID
        }

        if userID, ok := entry.Data["user_id"]; ok {
            event.Tags["user_id"] = fmt.Sprintf("%v", userID)
        }

        return event
    }
}

About

Sentry hook for Logrus

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Go 100.0%