README
¶
Package sentry
Пакет sentry предоставляет интеграцию с Sentry SDK для централизованного сбора и отправки ошибок и событий, с возможностью обогащения контекста через context.Context и функции обогащения событий.
Types
Config
Конфигурация для sentry
Fields:
Enable bool
Флаг включения Sentry.
Dsn string
DSN Sentry.
ModuleName string
Имя сервиса/модуля.
ModuleVersion string
Версия модуля.
Environment string
Окружение (например, prod, dev).
InstanceId string
Уникальный ID инстанса.
Tags map[string]string
Дополнительные произвольные теги.
Hub
Интерфейс Hub для отправки ошибок и событий.
Methods:
CatchError(ctx context.Context, err error, level log.Level)
Отправить ошибку с уровнем логирования.
CatchEvent(ctx context.Context, event *sentry.Event)
Отправить события напрямую.
Flush()
Подождать отправки всех событий.
EventEnrichment
Функция обогащения события — добавляет произвольные данные в sentry.Event.
Logger
-
Проксирует все методы логгера.
-
Автоматически отправляет события в Sentry, если уровень лога присутствует в
supportedLevels. -
Добавляет в событие:
- уровень логирования,
requestIdиз контекста (если есть),- ошибку (если передана в лог),
- данные обогащения из контекста.
Реализации Hub
SdkHub
Реальная обёртка над sentry.Hub. Отправляет события в Sentry SDK.
NoopHub
Заглушка, которая ничего не делает. Используется, если Sentry отключён.
Functions
func NewHubFromConfiguration(config Config) (Hub, error)
Создаёт Hub на основе конфигурации. Возвращает NoopHub, если Enable == false.
func EnrichEvent(ctx context.Context, enrichment EventEnrichment) context.Context
Добавляет функцию обогащения события в контекст. Используется для динамического расширения sentry.Event в Logger.
func WrapLogger(logger log.Logger, hub Hub, supportedLevels []log.Level) Logger
Оборачивает логгер, чтобы автоматически отправлять события в Sentry на указанных уровнях (supportedLevels).
func WrapErrorLogger(logger log.Logger, hub Hub) Logger
Упрощённый вариант WrapLogger, логирует только ошибки (log.LevelError).
Usage
Оборачивание логгера
wrappedLogger := sentry.WrapLogger(baseLogger, hub, []log.Level{log.LevelError, log.LevelFatal})
Обогащение событий
ctx = sentry.EnrichEvent(ctx, func(event *sentry.Event) {
event.Extra["user_id"] = 12345
})
Использование с контекстом
hub.CatchError(ctx, err, log.LevelError)
Ошибка будет автоматически дополнена requestId и пользовательскими полями из EnrichEvent.
Documentation
¶
Index ¶
- Constants
- func EnrichEvent(ctx context.Context, enrichment EventEnrichment) context.Context
- func EventFromLog(level sentry.Level, ctx context.Context, message any, fields ...log.Field) *sentry.Event
- func SetException(e *sentry.Event, exception error)
- type Config
- type EventEnrichment
- type Hub
- type Logger
- func (s Logger) Debug(ctx context.Context, message any, fields ...log.Field)
- func (s Logger) Error(ctx context.Context, message any, fields ...log.Field)
- func (s Logger) Info(ctx context.Context, message any, fields ...log.Field)
- func (s Logger) Warn(ctx context.Context, message any, fields ...log.Field)
- type NoopHub
- type SdkHub
Constants ¶
const (
RequestIdKey = "requestId"
)
Variables ¶
This section is empty.
Functions ¶
func EnrichEvent ¶
func EnrichEvent(ctx context.Context, enrichment EventEnrichment) context.Context
func EventFromLog ¶
func SetException ¶
SetException Compare to sentry.Event.SetException, we don't add local stacktrace if there is no stack in error
Types ¶
type EventEnrichment ¶
type Hub ¶
type Hub interface {
CatchError(ctx context.Context, err error, level log.Level)
CatchEvent(ctx context.Context, event *sentry.Event)
Flush()
}
func NewHubFromConfiguration ¶
nolint:ireturn
type NoopHub ¶
type NoopHub struct {
}
func NewNoopHub ¶
func NewNoopHub() NoopHub
func (NoopHub) CatchError ¶
type SdkHub ¶
type SdkHub struct {
// contains filtered or unexported fields
}
Source Files