README
¶
A simple structured logging
In general, this is another "bike" for logging with blackjack.
package log
import (
"os"
"time"
"github.com/mdigger/log"
)
func main() {
log.Info("info message")
log.With("time", time.Now()).Debug("debug")
log.Warn("warn", "time", time.Now(), "state", true)
}
Documentation
¶
Index ¶
- func Debug(msg string, fields ...interface{})
- func Error(msg string, fields ...interface{})
- func Fatal(msg string, fields ...interface{})
- func Flag() flag.Value
- func Info(msg string, fields ...interface{})
- func IsTTY() bool
- func Log(lvl Level, msg string, fields ...interface{})
- func SetFormat(enc Encoder)
- func SetLevel(lvl Level)
- func SetOutput(w io.Writer)
- func StdLog(lvl Level, name string, fields ...interface{}) *log.Logger
- func Trace(msg string, fields ...interface{})
- func Warn(msg string, fields ...interface{})
- type Color
- type Console
- type Encoder
- type Entry
- type Field
- type Fields
- type Handler
- type JSON
- type Level
- type Logger
- func (l *Logger) Debug(msg string, fields ...interface{})
- func (l *Logger) Error(msg string, fields ...interface{})
- func (l *Logger) Fatal(msg string, fields ...interface{})
- func (l *Logger) Info(msg string, fields ...interface{})
- func (l *Logger) Log(lvl Level, msg string, fields ...interface{})
- func (l *Logger) New(name string, fields ...interface{}) *Logger
- func (l *Logger) StdLog(lvl Level) *log.Logger
- func (l *Logger) Trace(msg string, fields ...interface{})
- func (l *Logger) Warn(msg string, fields ...interface{})
- func (l *Logger) With(fields ...interface{}) *Logger
- type Source
- type StackError
- type Writer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Debug ¶
func Debug(msg string, fields ...interface{})
Debug выводит отладочное сообщение в лог по умолчанию.
func Error ¶
func Error(msg string, fields ...interface{})
Error выводит сообщение об ошибке в лог по умолчанию.
func Fatal ¶
func Fatal(msg string, fields ...interface{})
Fatal выводит сообщение о критической ошибке в лог по умолчанию.
func Flag ¶
Flag возвращает лог по умолчанию в качестве значения для установки через параметры приложения.
func Info ¶
func Info(msg string, fields ...interface{})
Info выводит информационное сообщение в лог по умолчанию.
func SetFormat ¶
func SetFormat(enc Encoder)
SetFormat переопределяет настройки формата вывода лога по умолчанию. Изначально из настроек задан только формат временной метки "2006-01-02 15:04:05". Все остальные настройки оставлены по умолчанию.
func SetLevel ¶
func SetLevel(lvl Level)
SetLevel изменяет уровень фильтра для вывода сообщений в лог по умолчанию. Изначально фильтр установлен в DEBUG.
func SetOutput ¶
SetOutput переопределяет вывод лога по умолчанию. Изначально используется os.Stderr.
Types ¶
type Color ¶
type Color struct {
Levels map[Level]string // переопределение строк для вывода уровня
KeyIndent int // отступ от значения дополнительного параметра
NewLine bool // выводить атрибуты с новой строки
}
Color выводит лог в более удобном для чтения в консоли виде, используя цветовые выделения и помещая параметры на новую строку.
type Console ¶
type Console struct {
TimeFormat string // формат вывода даты и времени
UTC bool // вывод даты и времени в UTC
Levels map[Level]string // переопределение строк для вывода уровня
}
Console поддерживает текстовое представление лога.
type Encoder ¶
Encoder описывает интерфейс для форматирования записей лога. Используется Writer для задания формата. Данная библиотека содержит поддержку двух форматов логов: Console и JSON.
type Entry ¶
type Entry struct {
Timestamp time.Time // временная метка
Level Level // уровень
Category string // название раздела
Message string // текст
Fields []Field // дополнительные поля
}
Entry описывает запись в лог.
type Field ¶
type Field struct {
Name string
Value interface{}
}
Field описывает дополнительное именованное поле лога.
type Level ¶
type Level int8
Level задает уровень записи лога.
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger описывает именованный раздел лога.
func With ¶
func With(fields ...interface{}) *Logger
With возвращает новую запись в лог с дополнительными параметрами.
func (*Logger) New ¶
New возвращает новый именованный раздел лога. Новое имя будет добавлено к имени предыдущего раздела лога с разделителем ".".
func (*Logger) StdLog ¶
StdLog возвращает обертку лога в стандартный. В качестве параметров указывается уровень сообщений, который будет использоваться по умолчанию для всех записей лога.
func (*Logger) With ¶
With возвращает запись лога с частично заполненными дополнительными полями. В качестве именованных параметров можно использовать последовательное перечисление имен (строк) и соответствующих значений или непосредственно список имен со значениями в виде Field. Отдельно обрабатываются ошибки, которые тоже могут быть переданы без имени параметра: в этом случае будет использовано имя "error", если ошибка не пустая. Если вы ошиблись и для последнего элемента не задали значение, то такой элемент будет проигнорирован. Эти правила действительны и для всех методов Logger.
type Source ¶
type Source struct {
Pkg string // библиотека
Func string // название функции
File string // имя файла
Line int // номер строки
}
Source описывает информацию об исходном файле с кодом.
type StackError ¶
StackError описывает стандартную ошибку с добавлением информации о стеке вызовов.
func NewError ¶
func NewError(err error) *StackError
NewError формирует новую ошибку, добавляя информацию о стеке вызовов.
func (*StackError) Error ¶
func (e *StackError) Error() string
Error возвращает строковое описание ошибки.
type Writer ¶
type Writer struct {
Logger
// contains filtered or unexported fields
}
Writer описывает обработчик лога, записывающего в файл, консоль или другой поток.
func (*Writer) SetOutput ¶
SetOutput переопределяет вывод лога. Если nil, то лог выводиться не будет.
Source Files