logger v0.0.1,集成日志及追踪功能

smally84 · · 729 次点击 · 开始浏览    置顶
这是一个创建于 的主题,其中的信息可能已经有所发展或是发生改变。

# logger 项目地址: https://github.com/itmisx/logger #### logger logger wraps uber/zap and trace with opentelemetry #### Feature - [X] 支持日志及切分 - [X] 支持追踪(基于 `opentelemetry`) - [X] 支持 Debug,Info,Warn,Error,Fatal 日志等级 - [X] 支持异常自动恢复 `defer logger.End(ctx)` #### Install ```text go get -u -v github.com/itmisx/logger ``` #### Usage - 配置项 ```go type Config struct { // 调试模式,默认仅记录错误 Debug bool `yaml:"debug" mapstructure:"debug"` // 日志文件记录开关 EnableLog bool `yaml:"enable_log" mapstructure:"enable_log"` // 日志追踪开关 EnableTrace bool `yaml:"enable_trace" mapstructure:"enable_trace"` // 日志文件路径 File string `yaml:"file" mapstructure:"file"` // 单个日志文件的大小限制,单位MB MaxSize int `yaml:"max_size" mapstructure:"max_size"` // 日志文件数据的限制 MaxBackups int `yaml:"max_backups" mapstructure:"max_backups"` // 日志文件的保存天数 MaxAge int `yaml:"max_age" mapstructure:"max_age"` // 日志文件压缩开关 Compress bool `yaml:"compress" mapstructure:"compress"` // 日志切分的时间,参考linux定时任务0 0 0 * * *,精确到秒 Rotate string `yaml:"rotate" mapstructure:"rotate"` // 追踪内容导出类型,默认为jaeger TracerProviderType string `yaml:"tracer_provider_type" mapstructure:"tracer_provider_type"` // 追踪采样的频率, 0.0-1 TraceSampleRatio float64 `yaml:"trace_sample_ratio" mapstructure:"trace_sample_ratio"` // jaeger的URI地址 JaegerServer string `yaml:"jaeger_server" mapstructure:"jaeger_server"` // jaeger用户名 JaegerUsername string `yaml:"jaeger_username" mapstructure:"jaeger_username"` // jaeger密码 JaegerPassword string `yaml:"jaeger_password" mapstructure:"jaeger_password"` } ``` - 初始化 ```go // 初始化,配置参考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")) ``` - 基础使用 ```go // 在一个函数中启动一个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 框架实例 ```go // 请求方 // // 请求方调用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")) } ``` > 手动传递 ```go // 对于不能通过函数或请求传递的,则需要手动传递 // 通过 指定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](https://user-images.githubusercontent.com/5791324/147378026-42819fbb-5abf-46b9-8bba-a3ec7bfbcc81.png) #### License Use of logger is governed by the Mit License

有疑问加站长微信联系(非本文作者)

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:692541889

729 次点击  
加入收藏 微博
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传