sglogger

SGLogger

Простая и гибкая система логирования для Go-приложений с поддержкой структурированного логирования и множественных провайдеров.

Особенности

• 🎯 Множественные провайдеры - одновременная запись в разные источники (консоль, файлы, удаленные системы)
• 📊 Структурированное логирование - поддержка дополнительных полей для удобства анализа
• 🚀 Гибкая конфигурация - настраиваемые уровни логирования и форматы вывода
• 🔒 Потокобезопасность - готово к использованию в concurrent-средах
• 📝 Богатый API - различные методы для разных сценариев логирования

Установка

go get github.com/SergeiKhanlarov/seri-go-logger

Быстрый старт

Простое использование

package main

import (
    "context"
    "github.com/your-username/sglogger"
)

func main() {
    ctx := context.Background()
    
    // Создание логгера с настройками по умолчанию
    logger := sglogger.NewLoggerDefault(sglogger.ProviderConfig{
        LoggerConfig: sglogger.LoggerConfig{},
        level:       sglogger.LevelInfo,
    }, sglogger.NewFieldsHandler())
    
    // Логирование с разными уровнями
    logger.Info(ctx, "Приложение запущено")
    logger.Debug(ctx, "Отладочная информация: %s", "значение")
    logger.Warning(ctx, "Нештатная ситуация")
    logger.Error(ctx, "Произошла ошибка: %s", "описание ошибки")
}

Использование с контекстом и полями

package main

import (
    "context"
    "errors"
    "github.com/your-username/sglogger"
)

func main() {
    // Добавление trace_id в контекст
    ctx := context.WithValue(context.Background(), sglogger.TraceIDKey, "trace-123")
    
    logger := sglogger.NewLoggerDefault(sglogger.ProviderConfig{
        level: sglogger.LevelDebug,
    }, sglogger.NewFieldsHandler())
    
    // Логирование с ошибками
    err := errors.New("файл не найден")
    logger.ErrorErr(ctx, err, "Не удалось обработать запрос")
    
    // Логирование с дополнительными полями
    fields := sglogger.Fields{
        "user_id":    12345,
        "operation":  "file_upload",
        "file_size":  1024000,
    }
    logger.InfoWithFields(ctx, fields, "Файл успешно загружен")
    
    // Комбинированное использование
    logger.ErrorErrWithFields(ctx, err, fields, "Ошибка при загрузке файла")
}

Расширенное использование

Создание кастомного логгера с несколькими провайдерами

package main

import (
    "context"
    "github.com/your-username/sglogger"
)

func main() {
    ctx := context.Background()
    
    // Создание нескольких провайдеров
    consoleProvider := sglogger.NewFmtProvider(sglogger.ProviderConfig{
        level: sglogger.LevelDebug, // Все сообщения
    })
    
    fileProvider := sglogger.NewFmtProvider(sglogger.ProviderConfig{
        level: sglogger.LevelWarn, // Только предупреждения и выше
    })
    
    // Кастомный логгер с несколькими провайдерами
    logger := sglogger.NewLogger(
        sglogger.LoggerConfig{},
        sglogger.NewFieldsHandler(),
        consoleProvider,
        fileProvider,
    )
    
    logger.Info(ctx, "Это сообщение будет в консоли")
    logger.Warning(ctx, "Это сообщение будет в консоли и файле")
}

Уровни логирования

LevelDebug - Детальная отладочная информация
LevelInfo - Общая информация о работе приложения
LevelWarn - Нештатные ситуации, которые не приводят к ошибкам
LevelError - Ошибки, влияющие на работу приложения
LevelFatal - Критические ошибки, приводящие к остановке приложения

Основные методы логирования

Каждый уровень логирования поддерживает несколько вариантов методов:

// Базовое логирование
logger.Info(ctx, format, args...)

// Логирование с ошибкой
logger.ErrorErr(ctx, err, format, args...)

// Логирование с дополнительными полями
logger.InfoWithFields(ctx, fields, format, args...)

// Комбинированное использование
logger.ErrorErrWithFields(ctx, err, fields, format, args...)

Fields (Дополнительные поля)

fields := sglogger.Fields{
    "user_id":    123,
    "request_id": "abc-123",
    "duration":   150.5,
}

Создание собственных провайдеров

Для создания собственного провайдера необходимо реализовать интерфейс LoggerProvider:

type LoggerProvider interface {
    Write(ctx context.Context, level Level, message string, fields Fields) error
    ShouldLog(ctx context.Context, level Level) bool
    Close(ctx context.Context) error
}

Пример кастомного провайдера

type CustomProvider struct {
    config ProviderConfig
}

func NewCustomProvider(config ProviderConfig) LoggerProvider {
    return &CustomProvider{config: config}
}

func (p *CustomProvider) Write(ctx context.Context, level Level, message string, fields Fields) error {
    // Ваша реализация логирования
    return nil
}

func (p *CustomProvider) ShouldLog(ctx context.Context, level Level) bool {
    return level >= p.config.level
}

func (p *CustomProvider) Close(ctx context.Context) error {
    // Очистка ресурсов
    return nil
}

Конфигурация

LoggerConfig

Базовая конфигурация для всех логгеров и провайдеров.

ProviderConfig

Расширяет LoggerConfig специфичными для провайдера настройками:

config := ProviderConfig{
    LoggerConfig: LoggerConfig{},
    level:       LevelInfo,
}

Best Practices

Передавайте контекст - используйте context для сквозной идентификации запросов
Используйте структурированное логирование - поля упрощают поиск и анализ логов
Настраивайте уровни логирования - разные среды требуют разной детализации
Комбинируйте провайдеры - используйте разные провайдеры для разных целей
Обрабатывайте ошибки в провайдерах - избегайте падения приложения из-за проблем с логированием

📄 Лицензия

MIT License - смотрите файл LICENSE для деталей.

Copyright (c) 2025 Ханларов Сергей