README
¶
logs-go
logs-go is a logging library wrapped around zerolog.
It sacrifices a bit of zerolog's advantage of low allocation and instead improves usability. In most cases, it can be used as-is, but in situations where performance must be pursued, it is also possible to call zerolog's API.
Usage
Global logger
Source:
package main
import logs "github.com/rtkym/logs-go"
func main() {
logs.Set("key", "val")
logs.V("foo", "1").Info("hoge")
logs.V("bar", "2").Info("fuga")
}
Output:
{"level":"info","key":"val","foo":"1","time":"2022-08-16T14:05:47.215002900+09:00","message":"hoge"}
{"level":"info","key":"val","bar":"2","time":"2022-08-16T14:05:47.263814600+09:00","message":"fuga"}
Logger
Source:
package main
import logs "github.com/rtkym/logs-go"
func main() {
logger := logs.New()
logger.Set("key", "val")
logger.V("foo", "1").Info("hoge")
logger.V("bar", "2").Info("fuga")
}
Output:
{"level":"info","key":"val","foo":"1","time":"2022-08-16T14:10:41.535728100+09:00","message":"hoge"}
{"level":"info","key":"val","bar":"2","time":"2022-08-16T14:10:41.575108000+09:00","message":"fuga"}
With context
ctx := context.Background()
logCtx := &optctx.OptCtx{ /* some configuration options */}
ctx = optctx.NewContext(ctx, logCtx)
logger := optctx.NewLogger(ctx)
Environments
LOG_LEVEL
Supported values for the environment variable LOG_LEVEL are trace, debug, info, warning, error and fatal. default value is info.
LOG_FORMAT
Supported values for the environment variable LOG_FORMAT are json and console. default value is json.
Layout (writer)
JSON
logger := logs.New()
logger := logs.NewWithOption()
logger := logs.NewWithOption(logs.OptionWriter("json"))
logger := logs.NewWithOption(logs.OptionJSONWriter())
Console
logger := logs.NewWithOption(logs.OptionWriter("console"))
logger := logs.NewWithOption(logs.OptionConsoleWriter())
Other
buf := &bytes.Buffer{}
logger := logs.NewWithOption(func(opt *logs.Option) { opt.Writer = buf })
Documentation
¶
Index ¶
- Constants
- Variables
- func Debug(msg string)
- func Error(msg string)
- func Fatal(msg string)
- func Info(msg string)
- func InitGlobalLogger()
- func Set(key string, value interface{})
- func SetWithZC(fn func(zc ZC) ZC)
- func Trace(msg string)
- func Warn(msg string)
- func With() zerolog.Context
- type LogEntry
- func (x *LogEntry) Debug(msg string)
- func (x *LogEntry) E(err error) *LogEntry
- func (x *LogEntry) Error(msg string)
- func (x *LogEntry) Fatal(msg string)
- func (x *LogEntry) Info(msg string)
- func (x *LogEntry) Trace(msg string)
- func (x *LogEntry) V(key string, value interface{}) *LogEntry
- func (x *LogEntry) Warn(msg string)
- type Logger
- func (x *Logger) Debug(msg string)
- func (x *Logger) E(err error) *LogEntry
- func (x *Logger) Entry() *LogEntry
- func (x *Logger) Error(msg string)
- func (x *Logger) Fatal(msg string)
- func (x *Logger) Info(msg string)
- func (x *Logger) Set(key string, value interface{})
- func (x *Logger) SetWithZC(fn func(zc ZC) ZC)
- func (x *Logger) Trace(msg string)
- func (x *Logger) V(key string, value interface{}) *LogEntry
- func (x *Logger) Warn(msg string)
- func (x *Logger) With() zerolog.Context
- type Option
- type OptionFunc
- type ZC
Constants ¶
const DefaultDatetimeFormat = "2006-01-02T15:04:05.000000000Z07:00"
Variables ¶
var ( // GlobalLoggerOptions is gLogger configurations options. GlobalLoggerOptions []OptionFunc // nolint:gochecknoglobals )
Functions ¶
func Set ¶
func Set(key string, value interface{})
Set saves key and value to logger. The key and value are output permanently
Types ¶
type LogEntry ¶
type LogEntry struct {
// contains filtered or unexported fields
}
LogEntry is one record of logging.
type Logger ¶
type Logger struct {
// contains filtered or unexported fields
}
Logger provides basic logging functionality.
func NewWithOption ¶
func NewWithOption(opts ...OptionFunc) *Logger
NewWithOption returns a new Logger with options.
func (*Logger) Set ¶
Set saves key and value attribute to logger. The attribute are output permanently.
func (*Logger) SetWithZC ¶
SetWithZC saves key and value to logger. The key and value are output permanently
type OptionFunc ¶
type OptionFunc func(opt *Option)
func OptionConsoleWriter ¶
func OptionConsoleWriter() OptionFunc
OptionConsoleWriter returns an OptionFunc for configuring console format.
func OptionJSONWriter ¶
func OptionJSONWriter() OptionFunc
OptionJSONWriter returns an OptionFunc for configuring json format.
func OptionLevel ¶
func OptionLevel(level string) OptionFunc
OptionLevel returns an OptionFunc for configuring log levels.
func OptionWriter ¶
func OptionWriter(format string) OptionFunc
OptionWriter returns an OptionFunc for configuring log format.
Source Files
Directories