Files
poseidon/pkg/logging/sentry_hook.go
Maximilian Paß 75f2f9b290 Add Sentry Stack Traces
and exceptions for logs containing errors.
2023-07-25 21:07:02 +01:00

73 lines
2.1 KiB
Go

package logging
import (
"context"
"errors"
"github.com/getsentry/sentry-go"
"github.com/openHPI/poseidon/pkg/dto"
"github.com/sirupsen/logrus"
)
// SentryHook is a simple adapter that converts logrus entries into Sentry events.
// Consider replacing this with a more feature rich, additional dependency: https://github.com/evalphobia/logrus_sentry
type SentryHook struct{}
var ErrorHubInvalid = errors.New("the hub is invalid")
// Fire is triggered on new log entries.
func (hook *SentryHook) Fire(entry *logrus.Entry) error {
var hub *sentry.Hub
if entry.Context != nil {
hub = sentry.GetHubFromContext(entry.Context)
// This might overwrite valid data when not the request context is passed.
entry.Data[dto.KeyRunnerID] = entry.Context.Value(dto.ContextKey(dto.KeyRunnerID))
entry.Data[dto.KeyEnvironmentID] = entry.Context.Value(dto.ContextKey(dto.KeyEnvironmentID))
}
if hub == nil {
hub = sentry.CurrentHub()
}
client, scope := hub.Client(), hub.Scope()
if client == nil || scope == nil {
return ErrorHubInvalid
}
scope.SetContext("Poseidon Details", entry.Data)
if runnerID, ok := entry.Data[dto.KeyRunnerID].(string); ok {
scope.SetTag(dto.KeyRunnerID, runnerID)
}
if environmentID, ok := entry.Data[dto.KeyEnvironmentID].(string); ok {
scope.SetTag(dto.KeyEnvironmentID, environmentID)
}
event := client.EventFromMessage(entry.Message, sentry.Level(entry.Level.String()))
event.Timestamp = entry.Time
// Add Exception when an error was passed.
if data, ok := entry.Data["error"]; ok {
err, ok := data.(error)
if ok {
entry.Data["error"] = err.Error()
const maxErrorDepth = 10
event.SetException(err, maxErrorDepth)
}
}
hub.CaptureEvent(event)
return nil
}
// Levels returns all levels this hook should be registered to.
func (hook *SentryHook) Levels() []logrus.Level {
return []logrus.Level{
logrus.PanicLevel,
logrus.FatalLevel,
logrus.ErrorLevel,
logrus.WarnLevel,
}
}
func StartSpan(op, description string, ctx context.Context, callback func(context.Context)) {
span := sentry.StartSpan(ctx, op)
span.Description = description
defer span.Finish()
callback(span.Context())
}