Skip to content

Latest commit

 

History

History
165 lines (132 loc) · 5.76 KB

README.md

File metadata and controls

165 lines (132 loc) · 5.76 KB
Raw

logger

logger

logger wraps uber/zap and trace with opentelemetry

flowchart LR
logger -- openTelemetrySDK --> trace
trace -- http --> tempo

logger -- zap --> log
log-->loki

tempo-->grafana
loki-->grafana
Loading

Feature

  • 支持日志及切分
  • 支持追踪（基于 opentelemetry）
  • 支持 Debug,Info,Warn,Error,Fatal 日志等级
  • 支持异常自动恢复 defer logger.End(ctx)

Install

go get -u -v github.com/itmisx/logger

Usage

  • 配置项

    type Config struct {
    Debug              bool    `yaml:"debug" mapstructure:"debug"`               // 调试模式，默认仅记录错误
    Output             bool    `yaml:"output" mapstructure:"output"`             // 日志打印方式。none不打印日志，console打印到控制台，file输出到文件。默认为console
    File               string  `yaml:"file" mapstructure:"file"`                 // 日志文件路径
    MaxSize            int     `yaml:"max_size" mapstructure:"max_size"`         // 单个日志文件的大小限制，单位MB
    MaxBackups         int     `yaml:"max_backups" mapstructure:"max_backups"`   // 日志文件数据的限制
    MaxAge             int     `yaml:"max_age" mapstructure:"max_age"`           // 日志文件的保存天数
    Compress           bool    `yaml:"compress" mapstructure:"compress"`         // 日志文件压缩开关
    Rotate             string  `yaml:"rotate" mapstructure:"rotate"`             // 日志切分的时间，参考linux定时任务0 0 0  * * *，精确到秒
    EnableTrace        bool    `yaml:"enable_trace" mapstructure:"enable_trace"` // 日志追踪开关
    TracerProviderType string  `yaml:"tracer_provider_type" mapstructure:"tracer_provider_type"`// 追踪内容导出类型，默认为jaeger
    TraceSampleRatio   float64 `yaml:"trace_sample_ratio" mapstructure:"trace_sample_ratio"` // 追踪采样的频率, 0.0-1
    JaegerServer       string  `yaml:"jaeger_server" mapstructure:"jaeger_server"`// jaeger的URI地址
    JaegerUsername     string  `yaml:"jaeger_username" mapstructure:"jaeger_username"`// jaeger用户名
    JaegerPassword     string  `yaml:"jaeger_password" mapstructure:"jaeger_password"`// jaeger密码
}

  • 初始化

    // 初始化,配置参考logger.Config
// service.name为服务的名字
// service.version为版本
// logger.Init(config,attrs...logger.Field),更多的logger.Type参考logger下filed.go
logger.Init(conf,logger.String("service.name","service1"),logger.String("service.version","version"))

  • 基础使用

    // 在一个函数中启动一个span
// 并注册一个延迟结束（！！切记，缺少可能会导致内存泄露）
func foo(){
    // logger.Start(ctx,spanName,attrs...logger.Field)
    // 可以为一个span指定spanName以及额外的属性信息
    // attr支持logger.String("key","value") 形式,更多的logger.Type参考logger下filed.go
    ctx:=logger.Start(context,spanName,logger.String("key","value"))
    defer logger.End(ctx)
    // 正常记录日志
    // logger.Info(ctx,msg,attrs...logger.Field)
    // 记录msg信息及额外的信息
    // attr支持logger.String("key","value") 形式
    // 支持Debug,Info,Warn,Error,Fatal
    logger.Info(ctx,msg,logger.String("key","value"))
}

  • 追踪传递，就是传递 traceID 和 spanID

    gin 框架实例

    // 请求方
//
// 请求方调用request时，注入context trace信息
// post为封装的一个请求函数
func post(ctx context.Context){
    …… // request的请求
    // 注入context追踪信息
    // request类型为*http.Request
    logger.HttpInject(ctx,request)
    …… // 发送请求
}


// 接收方
// gin举例，初始化gin时，注册中间件
// sevice为当前后台服务的名称
router.Use(GinMiddleware("service"))
// 使用
func foo(c *gin.Context){
    ctx:=logger.Start(c.Request.Context(),spanName,logger.String("key","value"))
    defer logger.End(ctx)
    // 正常记录日志
    logger.Info(ctx,msg,logger.String("key","value"))
}

    手动传递

    // 对于不能通过函数或请求传递的，则需要手动传递
// 通过 指定traceID和spanID生成一个context
//
// 然后，logger.Start(ctx,"spanName"),其生成的span就为childspan
//
// 其中traceID和spanID可以利用logger.GenTraceID()和logger.GenSpanID()生成
// 也可以通过上个start返回的spanCtx中获得,logger.TraceID(spanCtx),logger.SpanID(spanCtx)
ctx, err := NewRootContext(traceID, spanID)

functions

  • Init(conf Config,applicationAttributes ...logger.Field) //初始化，配置及应用信息
  • Start(ctx context.Context,spanName string,spanStartOption ...logger.Field) context.Context //启动日志追踪,spanName 为追踪跨度的名称，spanStartOption 为跨度额外信息
  • Info(ctx context.Context,msg string,attributes ...logger.Field) // 普通日志
  • Warn(ctx context.Context,msg string,attributes ...logger.Field) // 警告日志
  • Error(ctx context.Context,msg string,attributes ...logger.Field) // 错误日志
  • End(ctx context.Context) //结束日志追踪
  • TraceID(ctx context.Context)string //获取 traceID
  • SpanID(ctx context.Context)string //获取 spanID
  • GenTraceID()string // 生成 traceID
  • GenSpanID()string // 生成 spanID

logger.Field 类型支持

  • bool
  • boolSlice
  • int
  • intSlice
  • int64
  • int64Slice
  • float64
  • float64Slice
  • string
  • stringSlice
  • stringer, interface{String()string{}}

基于 loki+tempo+grafana 的效果（日志查询+追踪）

image

License

Use of logger is governed by the Mit License