Skip to content

Commit

Permalink
Merge pull request #213 from awonak/sentry-tags
Browse files Browse the repository at this point in the history
Sentry tags
  • Loading branch information
sirupsen committed Jul 7, 2015
2 parents cd321ca + afe474b commit 07d998d
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 2 deletions.
16 changes: 16 additions & 0 deletions hooks/sentry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,22 @@ func main() {
}
```

If you wish to initialize a SentryHook with tags, you can use the `NewWithTagsSentryHook` constructor to provide default tags:

```go
tags := map[string]string{
"site": "example.com",
}
levels := []logrus.Level{
logrus.PanicLevel,
logrus.FatalLevel,
logrus.ErrorLevel,
}
hook, err := logrus_sentry.NewWithTagsSentryHook(YOUR_DSN, tags, levels)

```


## Special fields

Some logrus fields have a special meaning in this hook,
Expand Down
15 changes: 13 additions & 2 deletions hooks/sentry/sentry.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ package logrus_sentry

import (
"fmt"
"time"
"net/http"
"time"

"github.com/Sirupsen/logrus"
"github.com/getsentry/raven-go"
Expand Down Expand Up @@ -68,7 +68,18 @@ type SentryHook struct {
// and initializes the raven client.
// This method sets the timeout to 100 milliseconds.
func NewSentryHook(DSN string, levels []logrus.Level) (*SentryHook, error) {
client, err := raven.NewClient(DSN, nil)
client, err := raven.New(DSN)
if err != nil {
return nil, err
}
return &SentryHook{100 * time.Millisecond, client, levels}, nil
}

// NewWithTagsSentryHook creates a hook with tags to be added to an instance
// of logger and initializes the raven client. This method sets the timeout to
// 100 milliseconds.
func NewWithTagsSentryHook(DSN string, tags map[string]string, levels []logrus.Level) (*SentryHook, error) {
client, err := raven.NewWithTags(DSN, tags)
if err != nil {
return nil, err
}
Expand Down
32 changes: 32 additions & 0 deletions hooks/sentry/sentry_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import (
"io/ioutil"
"net/http"
"net/http/httptest"
"reflect"
"strings"
"testing"

Expand Down Expand Up @@ -98,3 +99,34 @@ func TestSentryHandler(t *testing.T) {
}
})
}

func TestSentryTags(t *testing.T) {
WithTestDSN(t, func(dsn string, pch <-chan *raven.Packet) {
logger := getTestLogger()
tags := map[string]string{
"site": "test",
}
levels := []logrus.Level{
logrus.ErrorLevel,
}

hook, err := NewWithTagsSentryHook(dsn, tags, levels)
if err != nil {
t.Fatal(err.Error())
}

logger.Hooks.Add(hook)

logger.Error(message)
packet := <-pch
expected := raven.Tags{
raven.Tag{
Key: "site",
Value: "test",
},
}
if !reflect.DeepEqual(packet.Tags, expected) {
t.Errorf("message should have been %s, was %s", message, packet.Message)
}
})
}

0 comments on commit 07d998d

Please sign in to comment.