Пакет log. Логирование в приложении

• изучите пакет log стандартной библиотеки Go;
• познакомитесь со сторонними пакетами для более удобного и быстрого логирования;
• напишете полноценный веб-сервер, где реализуете промежуточное ПО со сторонним пакетом zap — одним из самых быстрых.

Стандартные и сторонние пакеты для логирования

Пакет log

package main

import (
  "log"
)

func main() {
  log.Print("Logging in Go!")
} 

$ go build basicLog.go
$ ./basicLog
2022/03/07 09:01:51 Logging in Go! 

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

package main

import (
    "log"
    "os"
)

func main() {
    // создаём файл info.log и обрабатываем ошибку, если что-то пошло не так
    file, err := os.OpenFile("info.log", os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
    if err != nil {
        log.Fatal(err)
    }
    // откладываем закрытие файла
    defer file.Close()

    // устанавливаем назначение вывода в файл info.log
    log.SetOutput(file)
    log.Print("Logging to a file in Go!")
} 

func main() {
    flog, err := os.OpenFile(`server.log`, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0644)
    if err != nil {
        log.Fatal(err)
    }
    defer flog.Close()
    mylog := log.New(flog, `serv `, log.LstdFlags|log.Lshortfile)
    mylog.Println(`Start server`)
    mylog.Println(`Finish server`)
} 

serv 2021/06/24 09:44:42 main.go:15: Start server
serv 2021/06/24 09:44:42 main.go:16: Finish server 

• В первом параметре указывается переменная интерфейсного типа io.Writer. В примере это открытый для записи файл flog, точнее указатель на объект os.File, который реализует интерфейс io.Writer.
• Второй параметр содержит префикс, который будет добавляться перед каждой записью в лог. В данном случае это префикс serv.
• В третьем параметре указываются флаги. Пакет log даёт возможность добавлять контекстную информацию, например имя файла, номер строки, дату и время, — это делается с помощью флагов логера. В примере указаны следующие флаги:
  • log.LstdFlags — добавляет вывод даты и времени;
  • log.Lshortfile — добавляет вывод имени файла и строки, в которой произошла запись в лог.

func main(){
    // создаём файл info.log и обрабатываем ошибку, если что-то пошло не так
    file, err := os.OpenFile("info.log", os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
    if err != nil {
        log.Fatal(err)
    }

    // откладываем закрытие файла
    defer file.Close()

    // устанавливаем назначение вывода в файл info.log 
    log.SetOutput(file)

    // добавляем флаги для вывода даты, времени, имени файла
    log.SetFlags(log.Ldate | log.Ltime | log.Lshortfile)
    log.Print("Logging to a file in Go!")
} 

$ ./logs 
$ cat info.log
2022/03/07 15:43:22 logs.go:17: Logging to a file in Go! 

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

• Fatal
  Fatal/Panic — это ошибки, которые вызывают аварийную ситуацию или приводят к выходу из программы. При таких ошибках дальнейшая работа программы невозможна. На этом уровне фиксируются события только с уровнем Fatal.
  Куда ставить? Такие логи нужно писать в начале работы вашего проекта — при запуске сервера, подключении к базе данных, инициализации конфигурации приложения. Ошибки должны выводиться тогда, когда продолжать работу нельзя: в случае непредвиденных ситуаций, которые ведут к полному отказу системы. Например, проект не смог запуститься, потому что недоступна база данных или неправильно подгрузилась конфигурация.
• Error
  Error — это ошибки, которые не ожидаются. Требуется выяснение причины и устранение этих ошибок. На этом уровне фиксируются события с уровнями Error и Fatal.
  Куда ставить? Нужно писать такие логи, когда фактический результат может не соответствовать ожидаемому. Например, запрос в базу данных упал с ошибкой синтаксиса, сторонний сервис отработал некорректно или нет обработки некорректных данных, которые поступили на сервер.
• Warning
  Warning — это предупреждения. Они не влияют на работу программы, но могут напомнить о причинах ошибок в будущем. На этом уровне фиксируются события с уровнями Warning, Error и Fatal.
  Куда ставить? Лучше никуда. Предполагается, что этим уровнем должно покрываться всё, на что стоит обратить внимание или что может вызвать ошибку. Но на практике этот уровень используется редко, так как он неоднозначен: можно перепутать с сообщением Info или ошибкой Error. Может так случиться, что вы зарегистрируете ошибку на уровне Warning и будете долго её искать, потому что это вроде как не ошибка, а предупреждение.
• Info
  Info — это информационные сообщения о возникающих событиях. На этом уровне фиксируются события с уровнями Info, Warning, Error и Fatal.
  Куда ставить? Уровень Info можно устанавливать везде, где хочется вставить информацию о работе приложения. Этот уровень тоже не рекомендуют из-за его неоднозначности, так как он может означать всё что угодно. Лучше использовать уровень Debug/Trace.
• Debug
  Debug — это служебная информация для отладки и настройки программы. На этом уровне фиксируются события с уровнями Debug, Info, Warning, Error и Fatal.
  Куда ставить? Debug/Trace стоит использовать там, где нужно показать больше информации о том, что происходит в проекте. Например, какие приходят запросы, как они обрабатываются, какие возвращаются ответы, какие значения имеют переменные на определённых уровнях бизнес-логики. Всё это может помочь в случае поломки (или непройденного автотеста) определить, как менялись данные и почему они имеют такие значения. Так как это отладочная информация, в продакшене уровень Debug лучше отключать.

Пакет logrus

go get github.com/sirupsen/logrus 

package main

import (
    "os"

    log "github.com/sirupsen/logrus"
)

func main() {
    // создаём файл info.log и обрабатываем ошибку
    file, err := os.OpenFile("info.log", os.O_CREATE|os.O_APPEND|os.O_WRONLY, 0644)
    if err != nil {
        log.Fatal(err)
    }

    // откладываем закрытие файла
    defer file.Close()

    // устанавливаем вывод логов в файл
    log.SetOutput(file)
    // устанавливаем вывод логов в формате JSON 
    log.SetFormatter(&log.JSONFormatter{})
    // устанавливаем уровень предупреждений
    log.SetLevel(log.WarnLevel)

    // определяем стандартные поля JSON
    log.WithFields(log.Fields{
        "genre": "metal",
        "name": "Rammstein",
    }).Info("Немецкая метал-группа, образованная в январе 1994 года в Берлине.")

    log.WithFields(log.Fields{
        "omg": true,
        "name": "Garbage",
    }).Warn("В 2021 году вышел новый альбом No Gods No Masters.")

    log.WithFields(log.Fields{
        "omg": true,
        "name": "Linkin Park",
    }).Fatal("Группа Linkin Park взяла паузу после смерти вокалиста Честера Беннингтона 20 июля 2017 года.")
} 

{"level":"warning","msg":"В 2021 году вышел новый альбом No Gods No Masters.","name":"Garbage","omg":true,"time":"2022-03-10T10:56:04-08:00"}
{"level":"fatal","msg":"Группа Linkin Park взяла паузу после смерти вокалиста Честера Беннингтона 20 июля 2017 года.","name":"Linkin Park","omg":true,"time":"2022-03-10T10:56:04-08:00"} 

Пакет zap

go get -u go.uber.org/zap 

package main

import (
    "go.uber.org/zap"
)

func main() {
    // добавляем предустановленный логер NewDevelopment
    logger, err := zap.NewDevelopment()
    if err != nil {
        // вызываем панику, если ошибка
        panic("cannot initialize zap")
    }
    // это нужно добавить, если логер буферизован
    // в данном случае не буферизован, но привычка хорошая
    defer logger.Sync()

    // для примера берём простой URL
    const url = "http://example.com"

    // делаем логер SugaredLogger
    sugar := logger.Sugar()

    // выводим сообщение уровня Info с парой "url": url в виде JSON, это SugaredLogger
    sugar.Infow(
        "Failed to fetch URL",
        "url", url,
    )

    // выводим сообщение уровня Info, но со строкой URL, это тоже SugaredLogger
    sugar.Infof("Failed to fetch URL: %s", url)
    // выводим сообщение уровня Error со строкой URL, и это SugaredLogger
    sugar.Errorf("Failed to fetch URL: %s", url)

    // переводим в обычный Logger
    plain := sugar.Desugar()

    // выводим сообщение уровня Info обычного регистратора (не SugaredLogger)
    plain.Info("Hello, Go!")
    // также уровня Warn (не SugaredLogger)
    plain.Warn("Simple warning")
    // и уровня Error, но добавляем строго типизированное поле "url" (не SugaredLogger)
    plain.Error("Failed to fetch URL", zap.String("url", url))
} 

go run main.go
2022-11-17T23:17:00.534+0300 INFO zap_logger/main.go:18 Failed to fetch URL {"url": "http://example.com"}
2022-11-17T23:17:00.534+0300 INFO zap_logger/main.go:23 Failed to fetch URL: http://example.com
2022-11-17T23:17:00.534+0300 ERROR zap_logger/main.go:24 Failed to fetch URL: http://example.com
main.main
 /Users/lekan/go/src/github.com/lekan-pvp/zap_logger/main.go:24
runtime.main
 /usr/local/go/src/runtime/proc.go:250
2022-11-17T23:17:00.534+0300 INFO zap_logger/main.go:26 Hello, Go!
2022-11-17T23:17:00.534+0300 WARN zap_logger/main.go:27 Simple warning
main.main
 /Users/lekan/go/src/github.com/lekan-pvp/zap_logger/main.go:27
runtime.main
 /usr/local/go/src/runtime/proc.go:250
2022-11-17T23:17:00.534+0300 ERROR zap_logger/main.go:28 Simple error {"url": "http://example.com"}
main.main
 /Users/lekan/go/src/github.com/lekan-pvp/zap_logger/main.go:28
runtime.main
 /usr/local/go/src/runtime/proc.go:250 

Дополнительные материалы

• go.dev/log — документация пакета log.
• go.dev/go.uber.org/zap — документация пакета zap.
• GitHub | zap — пакет zap.
• GitHub | logrus — пакет logrus.
• GitHub | Awesome Go | Logging — библиотеки для логирования.