README
¶
Kitex zap (This is a community driven project)
Introduction
This is a logger library that uses zap to implement the Kitex logger interface, work together with kitex obs-opentelemetry
Usage
Download and install it:
go get github.com/kitex-contrib/obs-opentelemetry/logging/zap
Import it in your code:
import kitexzap github.com/kitex-contrib/obs-opentelemetry/logging/zap
Set logger impl
package main
import (
"github.com/cloudwego/kitex/pkg/klog"
kitexzap "github.com/kitex-contrib/obs-opentelemetry/logging/zap"
)
func main() {
klog.SetLogger(kitexzap.NewLogger())
klog.SetLevel(klog.LevelDebug)
}
We provide some methods to help you customize logger
| Configuration | Description |
|---|---|
| WithCoreEnc | zapcore Encoder |
| WithCoreWs | zapcore WriteSyncer |
| WithCoreLevel | zap AtomicLevel |
| WithZapOptions | zap Option |
| WithTraceErrorSpanLevel | trace error span level option |
| WithRecordStackTraceInSpan | record stack track option |
Log with context
// Echo implements the Echo interface.
func (s *EchoImpl) Echo(ctx context.Context, req *api.Request) (resp *api.Response, err error) {
klog.CtxDebugf(ctx, "echo called: %s", req.GetMessage())
return &api.Response{Message: req.Message}, nil
}
View log
{
"level": "info",
"ts": 1667619647.1459548,
"msg": "hello world",
"trace_id": "c77e46c0fb590ee80b6d78ed6682768e",
"span_id": "b42c96c6dd01ceaf",
"trace_flags": "01"
}
For some reason, zap will not log extra context info.
Documentation
¶
Index ¶
- func OtelSeverityText(lv zapcore.Level) string
- type ExtraKey
- type Logger
- func (l *Logger) CtxDebugf(ctx context.Context, format string, v ...interface{})
- func (l *Logger) CtxErrorf(ctx context.Context, format string, v ...interface{})
- func (l *Logger) CtxFatalf(ctx context.Context, format string, v ...interface{})
- func (l *Logger) CtxInfof(ctx context.Context, format string, v ...interface{})
- func (l *Logger) CtxKVLog(ctx context.Context, level klog.Level, format string, kvs ...interface{})
- func (l *Logger) CtxLogf(level klog.Level, ctx context.Context, format string, kvs ...interface{})
- func (l *Logger) CtxNoticef(ctx context.Context, format string, v ...interface{})
- func (l *Logger) CtxTracef(ctx context.Context, format string, v ...interface{})
- func (l *Logger) CtxWarnf(ctx context.Context, format string, v ...interface{})
- func (l *Logger) Debug(v ...interface{})
- func (l *Logger) Debugf(format string, v ...interface{})
- func (l *Logger) Error(v ...interface{})
- func (l *Logger) Errorf(format string, v ...interface{})
- func (l *Logger) Fatal(v ...interface{})
- func (l *Logger) Fatalf(format string, v ...interface{})
- func (l *Logger) GetExtraKeys() []ExtraKey
- func (l *Logger) Info(v ...interface{})
- func (l *Logger) Infof(format string, v ...interface{})
- func (l *Logger) Log(level klog.Level, kvs ...interface{})
- func (l *Logger) Logf(level klog.Level, format string, kvs ...interface{})
- func (l *Logger) Logger() *zap.Logger
- func (l *Logger) Notice(v ...interface{})
- func (l *Logger) Noticef(format string, v ...interface{})
- func (l *Logger) PutExtraKeys(keys ...ExtraKey)
- func (l *Logger) SetLevel(level klog.Level)
- func (l *Logger) SetOutput(writer io.Writer)
- func (l *Logger) Trace(v ...interface{})
- func (l *Logger) Tracef(format string, v ...interface{})
- func (l *Logger) Warn(v ...interface{})
- func (l *Logger) Warnf(format string, v ...interface{})
- type Option
- func WithCoreEnc(enc zapcore.Encoder) Option
- func WithCoreLevel(lvl zap.AtomicLevel) Option
- func WithCoreWs(ws zapcore.WriteSyncer) Option
- func WithCustomFields(kv ...interface{}) Option
- func WithExtraKeyAsStr() Option
- func WithExtraKeys(keys []ExtraKey) Option
- func WithRecordStackTraceInSpan(recordStackTraceInSpan bool) Option
- func WithTraceErrorSpanLevel(level zapcore.Level) Option
- func WithZapOptions(opts ...zap.Option) Option
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func OtelSeverityText ¶
OtelSeverityText convert zapcore level to otel severityText ref to https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md#severity-fields
Types ¶
type Logger ¶
type Logger struct {
*zap.SugaredLogger
// contains filtered or unexported fields
}
func (*Logger) CtxNoticef ¶
func (*Logger) GetExtraKeys ¶
GetExtraKeys get extraKeys from logger config
func (*Logger) PutExtraKeys ¶
PutExtraKeys add extraKeys after init
type Option ¶
type Option interface {
// contains filtered or unexported methods
}
func WithCustomFields ¶
func WithCustomFields(kv ...interface{}) Option
WithCustomFields record log with the key-value pair.
func WithExtraKeyAsStr ¶
func WithExtraKeyAsStr() Option
WithExtraKeyAsStr convert extraKey to a string type when retrieving value from context Not recommended for use, only for compatibility with certain situations
For more information, refer to the documentation at `https://pkg.go.dev/context#WithValue`
func WithExtraKeys ¶
WithExtraKeys allow you log extra values from context
func WithRecordStackTraceInSpan ¶
WithRecordStackTraceInSpan record stack track option
func WithTraceErrorSpanLevel ¶
WithTraceErrorSpanLevel trace error span level option
func WithZapOptions ¶
WithZapOptions add origin zap option
Source Files