logdoc

logdoc-go-appender

Logdoc Go Appender v0.0.18

Структурированные логи в GoLang

sirupsen/logrus — один из самых популярных пакетов логирования, использующий структурированные логи JSON. uber-go/zap — супербыстрый логгер со структурированными логами JSON. rs/zerolog — очень быстрые структурированные логи в формате JSON.

Рассмотрим подробнее sirupsen/logrus и uber-go/zap

Это две популярные библиотеки логирования для языка программирования Go.

logrus - это библиотека с открытым исходным кодом, предназначенная для логирования в Go. Она предоставляет множество функций для логирования, таких как логирование на уровне отладки, информации, предупреждения и ошибок. Она также поддерживает различные форматы логирования, такие как JSON, текст и т.д. Logrus также имеет множество плагинов, которые позволяют настраивать логирование под конкретные нужды.

Zap - это библиотека с открытым исходным кодом, которая была разработана Uber для логирования в Go. Она была создана для обеспечения высокой производительности и эффективности. Она предоставляет множество функций для логирования, таких как логирование на уровне отладки, информации, предупреждения и ошибок. Она также поддерживает различные форматы логирования, такие как JSON, текст и т.д. Zap также имеет множество плагинов, которые позволяют настраивать логирование под конкретные нужды.

Использование логгеров

плагин logdoc-go-appender в данный момент использует logrus и zap, для передачи логов на LogDoc server, используя LogDoc Native Protocol

Как подключить в свой проект, пример с logrus

В раздел import добавляем пакет logrusld "github.com/LogDoc-org/logdoc-go-appender/logrus", запускаем sync библиотек из среды разработки, в терминале go get -u github.com/LogDoc-org/logdoc-go-appender или вводим в терминале go mod tidy (tidy удостоверяется, что go.mod соответствует исходному коду в модуле. Он добавляет все недостающие модули, необходимые для построения пакетов и зависимостей текущего модуля, и удаляет неиспользуемые модули, которые не предоставляют никаких соответствующих пакетов. Он также добавляет все недостающие записи в go.sum и удаляет ненужные)

Далее, в main.go, в начале приложения инициализируем подсистему логирования LogDoc:

import logrusld "github.com/LogDoc-org/logdoc-go-appender/logrus"

...

// Создаем подсистему логгирования LogDoc
	conn, err := LDSubsystemInit()
	logger := logrusld.GetLogger()
	if err == nil {
		logger.Info(fmt.Sprintf(
			"LogDoc subsystem initialized successfully@@source=%s:%d",
			logdoc.GetSourceName(runtime.Caller(0)), // фреймы не скипаем, не exception
			logdoc.GetSourceLineNum(runtime.Caller(0)),
		))
	}

	c := *conn
	if c != nil {
		defer c.Close()
	} else {
		logger.Error("Error LogDoc subsystem initialization")
	}
...
func LDSubsystemInit() (*net.Conn, error) {
	conf := config.GetConfig()
	conn, err := logrusld.Init(
		conf.GetString("ld.proto"),
		conf.GetString("ld.host")+":"+conf.GetString("ld.port"),
		conf.GetString("ld.app"),
	)
	return &conn, err
}

Здесь я использую конфигурацию приложения с использованием HOCON и библиотеки "github.com/gurkankaymak/hocon", но здесь вы можете использовать любую конфигурацию, главное - инициализировать LogDoc:

conn, err := logrusld.Init("tcp или udp","host:port", "название вашего приложения")

Далее в любом модуле необходимо получить логгер: logger := logrusld.GetLogger() и пользоваться им, как обычным logrus:

logger.Error("Тут возникла ошибка", err)
logger.Debug("Отладочное сообщение")