README
¶
logboek — библиотека для организации структурированного и информативного вывода
Логер, каналы логирования и потоки вывода
При создании логера необходимо указать стримы, OutStream и ErrStream, которые должны подходить под интерфейс io.Writer (это может быть файл, стандартные потоки вывода, буфер или произвольная имплементация):
import "github.com/werf/logboek"
// NewLogger(outStream, errStream io.Writer) *Logger
l := logboek.NewLogger(os.Stdout, os.Stderr)
Настройки стримов позволяют задать параметры оформления, такие как префикс и тег, а также различные режимы работы. Они являются общими для OutStream и ErrStream, и, соответственно, для всех каналов, о которых пойдёт речь далее.
l.Streams()
Логер связан с каналами логирования Error, Warn, Default, Info и Debug. При использовании каналов Error и Warn все сообщения пишутся в ErrStream, а в случае с остальными в OutStream.
Каналы логирования позволяют организовать вывод для различных режимов работы приложения (подробный и дебаг режимы), ветвление и выполнение кода в случае того или иного активного канала (активация канала также включает вывод в нижестоящих каналах по приоритету):
import (
"github.com/werf/logboek"
"github.com/werf/logboek/pkg/level"
)
switch mode {
case "verbose":
l.SetAcceptedLevel(level.Info)
case "debug":
l.SetAcceptedLevel(level.Debug)
case "quiet":
l.SetAcceptedLevel(level.Error)
}
...
if l.Debug().IsAccepted() {
... // do and print something special
}
Если каналы не требуются, то можно ограничиться использованием канала Default, методы которого доступны на верхнем уровне логера:
l.LogLn() // l.Default().LogLn()
l.LogF() // l.Default().LogF()
...
Default Logger
По умолчанию библиотека инициализирует DefaultLogger с предустановленными стримами os.Stdout и os.Stderr. Для работы с логером можно использовать сам экземпляр или верхнеуровневые функции библиотеки, которые соответствуют всем доступным методам логера:
import "github.com/werf/logboek"
logboek.DefaultLogger()
logboek.Default() // logboek.DefaultLogger().Default()
logboek.LogLn() // logboek.DefaultLogger().LogLn()
logboek.Streams() // logboek.DefaultLogger().Streams()
...
Documentation
¶
Index ¶
- func AcceptedLevel() level.Level
- func Colorize(style color.Style, a ...interface{}) string
- func ColorizeF(style color.Style, format string, a ...interface{}) string
- func ColorizeLn(style color.Style, a ...interface{}) string
- func Context(ctx context.Context) types.LoggerInterface
- func Debug() types.ManagerInterface
- func Default() types.ManagerInterface
- func DefaultLogger() types.LoggerInterface
- func ErrStream() io.Writer
- func Error() types.ManagerInterface
- func FitText(text string, options types.FitTextOptions) string
- func Info() types.ManagerInterface
- func IsAcceptedLevel(lvl level.Level) bool
- func Log(a ...interface{})
- func LogBlock(headerOrFormat string, a ...interface{}) types.LogBlockInterface
- func LogDetails(a ...interface{})
- func LogF(format string, a ...interface{})
- func LogFDetails(format string, a ...interface{})
- func LogFHighlight(format string, a ...interface{})
- func LogFWithCustomStyle(style color.Style, format string, a ...interface{})
- func LogHighlight(a ...interface{})
- func LogLn(a ...interface{})
- func LogLnDetails(a ...interface{})
- func LogLnHighlight(a ...interface{})
- func LogLnWithCustomStyle(style color.Style, a ...interface{})
- func LogOptionalLn()
- func LogProcess(headerOrFormat string, a ...interface{}) types.LogProcessInterface
- func LogProcessInline(headerOrFormat string, a ...interface{}) types.LogProcessInlineInterface
- func LogWithCustomStyle(style color.Style, a ...interface{})
- func NewContext(ctx context.Context, logger types.LoggerInterface) context.Context
- func NewLogger(outStream, errStream io.Writer) types.LoggerInterface
- func NewSubLogger(outStream, errStream io.Writer) types.LoggerInterface
- func OutStream() io.Writer
- func Reset()
- func ResetModes()
- func ResetState()
- func SetAcceptedLevel(lvl level.Level)
- func Streams() types.StreamsInterface
- func Warn() types.ManagerInterface
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AcceptedLevel ¶
func ColorizeLn ¶ added in v0.5.0
func Debug ¶
func Debug() types.ManagerInterface
func Default ¶
func Default() types.ManagerInterface
func DefaultLogger ¶
func DefaultLogger() types.LoggerInterface
func Error ¶
func Error() types.ManagerInterface
func Info ¶
func Info() types.ManagerInterface
func IsAcceptedLevel ¶
func LogBlock ¶
func LogBlock(headerOrFormat string, a ...interface{}) types.LogBlockInterface
func LogDetails ¶ added in v0.5.0
func LogDetails(a ...interface{})
func LogFDetails ¶
func LogFDetails(format string, a ...interface{})
func LogFHighlight ¶
func LogFHighlight(format string, a ...interface{})
func LogFWithCustomStyle ¶
func LogHighlight ¶ added in v0.5.0
func LogHighlight(a ...interface{})
func LogLnDetails ¶
func LogLnDetails(a ...interface{})
func LogLnHighlight ¶
func LogLnHighlight(a ...interface{})
func LogLnWithCustomStyle ¶
func LogOptionalLn ¶
func LogOptionalLn()
func LogProcess ¶
func LogProcess(headerOrFormat string, a ...interface{}) types.LogProcessInterface
func LogProcessInline ¶
func LogProcessInline(headerOrFormat string, a ...interface{}) types.LogProcessInlineInterface
func LogWithCustomStyle ¶ added in v0.5.0
func NewContext ¶
func NewSubLogger ¶
func NewSubLogger(outStream, errStream io.Writer) types.LoggerInterface
func ResetModes ¶ added in v0.4.4
func ResetModes()
func ResetState ¶ added in v0.4.4
func ResetState()
func SetAcceptedLevel ¶
func Streams ¶
func Streams() types.StreamsInterface
func Warn ¶
func Warn() types.ManagerInterface
Types ¶
This section is empty.
Source Files
Directories