You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
115 lines
3.1 KiB
115 lines
3.1 KiB
// Copyright (c) 2020 Proton Technologies AG |
|
// |
|
// This file is part of ProtonMail Bridge. |
|
// |
|
// ProtonMail Bridge is free software: you can redistribute it and/or modify |
|
// it under the terms of the GNU General Public License as published by |
|
// the Free Software Foundation, either version 3 of the License, or |
|
// (at your option) any later version. |
|
// |
|
// ProtonMail Bridge is distributed in the hope that it will be useful, |
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of |
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
|
// GNU General Public License for more details. |
|
// |
|
// You should have received a copy of the GNU General Public License |
|
// along with ProtonMail Bridge. If not, see <https://www.gnu.org/licenses/>. |
|
|
|
package sentry |
|
|
|
import ( |
|
"errors" |
|
"runtime" |
|
"time" |
|
|
|
"github.com/getsentry/sentry-go" |
|
log "github.com/sirupsen/logrus" |
|
) |
|
|
|
var ( |
|
skippedFunctions = []string{} //nolint[gochecknoglobals] |
|
) |
|
|
|
// ReportSentryCrash reports a sentry crash. |
|
func ReportSentryCrash(clientID, appVersion, userAgent string, reportErr error) error { |
|
SkipDuringUnwind() |
|
if reportErr == nil { |
|
return nil |
|
} |
|
|
|
tags := map[string]string{ |
|
"OS": runtime.GOOS, |
|
"Client": clientID, |
|
"Version": appVersion, |
|
"UserAgent": userAgent, |
|
"UserID": "", |
|
} |
|
|
|
var reportID string |
|
sentry.WithScope(func(scope *sentry.Scope) { |
|
SkipDuringUnwind() |
|
scope.SetTags(tags) |
|
eventID := sentry.CaptureException(reportErr) |
|
if eventID != nil { |
|
reportID = string(*eventID) |
|
} |
|
}) |
|
|
|
if !sentry.Flush(time.Second * 10) { |
|
log.WithField("error", reportErr).Error("Failed to report sentry error") |
|
return errors.New("failed to report sentry error") |
|
} |
|
|
|
log.WithField("error", reportErr).WithField("id", reportID).Warn("Sentry error reported") |
|
return nil |
|
} |
|
|
|
// SkipDuringUnwind removes caller from the traceback. |
|
func SkipDuringUnwind() { |
|
pcs := make([]uintptr, 2) |
|
n := runtime.Callers(2, pcs) |
|
if n == 0 { |
|
return |
|
} |
|
|
|
frames := runtime.CallersFrames(pcs) |
|
frame, _ := frames.Next() |
|
if isFunctionFilteredOut(frame.Function) { |
|
return |
|
} |
|
|
|
skippedFunctions = append(skippedFunctions, frame.Function) |
|
} |
|
|
|
// EnhanceSentryEvent swaps type with value and removes panic handlers from the stacktrace. |
|
func EnhanceSentryEvent(event *sentry.Event, hint *sentry.EventHint) *sentry.Event { |
|
for idx, exception := range event.Exception { |
|
exception.Type, exception.Value = exception.Value, exception.Type |
|
if exception.Stacktrace != nil { |
|
exception.Stacktrace.Frames = filterOutPanicHandlers(exception.Stacktrace.Frames) |
|
} |
|
event.Exception[idx] = exception |
|
} |
|
return event |
|
} |
|
|
|
func filterOutPanicHandlers(frames []sentry.Frame) []sentry.Frame { |
|
newFrames := []sentry.Frame{} |
|
for _, frame := range frames { |
|
// Sentry splits runtime.Frame.Function into Module and Function. |
|
function := frame.Module + "." + frame.Function |
|
if !isFunctionFilteredOut(function) { |
|
newFrames = append(newFrames, frame) |
|
} |
|
} |
|
return newFrames |
|
} |
|
|
|
func isFunctionFilteredOut(function string) bool { |
|
for _, skipFunction := range skippedFunctions { |
|
if function == skipFunction { |
|
return true |
|
} |
|
} |
|
return false |
|
}
|
|
|