diff --git a/adapter/console/console.go b/adapter/console/console.go index 53296c6..5293aed 100644 --- a/adapter/console/console.go +++ b/adapter/console/console.go @@ -1,6 +1,14 @@ // (c) 2022 Jacek Olszak // This code is licensed under MIT license (see LICENSE for details) +// Package console provides yala adapters capable of logging using simplified console logger. This logger is meant +// to be used for development purposes only. It does not provide any knobs and switches. If you need customization, then +// please use real production-ready logger like zap, logrus or zerolog with appropriate adapter. +// +// The format of message produced by console adapters is: +// +// LEVEL message key=value key=value error=error +// package console import ( diff --git a/adapter/glogadapter/glog.go b/adapter/glogadapter/glog.go index 2e57fb3..50c9db9 100644 --- a/adapter/glogadapter/glog.go +++ b/adapter/glogadapter/glog.go @@ -1,6 +1,7 @@ // (c) 2022 Jacek Olszak // This code is licensed under MIT license (see LICENSE for details) +// Package glogadapter provides yala adapter which leverages glog package (https://github.com/golang/glog). package glogadapter import ( diff --git a/adapter/logrusadapter/logrus.go b/adapter/logrusadapter/logrus.go index e0291cd..31fc173 100644 --- a/adapter/logrusadapter/logrus.go +++ b/adapter/logrusadapter/logrus.go @@ -1,6 +1,7 @@ // (c) 2022 Jacek Olszak // This code is licensed under MIT license (see LICENSE for details) +// Package logrusadapter provides yala adapter which leverages logrus module (https://github.com/sirupsen/logrus). package logrusadapter import ( diff --git a/adapter/printer/printer.go b/adapter/printer/printer.go index 3214b67..05fe1db 100644 --- a/adapter/printer/printer.go +++ b/adapter/printer/printer.go @@ -16,6 +16,7 @@ import ( // This adapter prints fields and error in logfmt format. For example: // // message key=value error=message +// type Adapter struct { Printer Printer } diff --git a/adapter/zapadapter/zapadapter.go b/adapter/zapadapter/zapadapter.go index 6bac73d..909b066 100644 --- a/adapter/zapadapter/zapadapter.go +++ b/adapter/zapadapter/zapadapter.go @@ -1,6 +1,7 @@ // (c) 2022 Jacek Olszak // This code is licensed under MIT license (see LICENSE for details) +// Package zapadapter provides yala adapter which leverages zap module (https://github.com/uber-go/zap). package zapadapter import ( diff --git a/adapter/zerologadapter/zerolog.go b/adapter/zerologadapter/zerolog.go index cd20b7d..3a41fc3 100644 --- a/adapter/zerologadapter/zerolog.go +++ b/adapter/zerologadapter/zerolog.go @@ -1,6 +1,7 @@ // (c) 2022 Jacek Olszak // This code is licensed under MIT license (see LICENSE for details) +// Package zerologadapter provides yala adapter which leverages zerolog module (https://github.com/rs/zerolog). package zerologadapter import ( diff --git a/logger/logger.go b/logger/logger.go index 423c76c..7c53391 100644 --- a/logger/logger.go +++ b/logger/logger.go @@ -1,6 +1,8 @@ // (c) 2022 Jacek Olszak // This code is licensed under MIT license (see LICENSE for details) +// Package logger provides tiny structured logging abstraction or facade for various logging libraries, allowing the end +// user to plug in the desired logging library in main.go. package logger import (