文档章节

如何为 Go 设计一个通用的日志包

caixw
 caixw
发布于 2017/08/23 00:25
字数 780
阅读 12
收藏 0

需求

一个通用的日志包,应该满足以下几个需求:

兼容 log.Logger,标准库大量使用了 log.Logger 作为其错误内容的输出通道,比如 net/http.Server.ErrorLog,所以兼容 log.Logger 是首要的需求;

自定义配置,不同的运行环境,往往需要不同的日志输出配置,在不重新编译源码的情况下,就能改变配置也应该成为一项标配;

不同的输出类型,根据目前市面上大部分的日志库,我们把日志分为以下六种类型:INFOWARNDEBUGTRACEERROR 和 CRITICAL

对日志内容的自定义处理,比如将日志按时间段进行切割,或是重要内容发邮箱进行提醒等。

配置文件

根据以上的需求,我们可以拟定一个以下格式的 XML 配置文件:

<?xml version="1.0" encoding="utf-8"?>
<logs>
    <info prefix="INFO" flag="log.lstdflag" >
        <!-- 向控制台输出信息 -->
        <console output="stderr" foreground="red" background="blue" />
    </info>

    <error prefix="ERROR" flag="log.lstdflag" />
        <!-- 向控制台输出信息 -->
        <console output="stderr" foreground="red" background="blue" />

        <!-- 输出到 /var/logs/debug 目录下,如果大于 5M,则新建文件 -->
        <rotate dir="/var/logs/debug/" size="5M" />
    </error>

    <critical prefix="CRITICAL" flag="log.lstdflag" >
        <!-- 向指定的邮箱发送错误信息 -->
        <smtp username="u"
        password="p"
        host="smtp.example.com"
        subject="CRITICAL"
        sendTo="u1@example.com;u2@example.com" />
    </critical>
</logs>

顶级元素固定为 logs

二级元素为 INFO 和 WARN 等六种固定的类型,在加载时,将其初始为一个 *log.Logger 实例,初始化参数可以直接从 XML 的属性和子元素中获取;

二级以下的元素,统一初始化为 io.Writer 实例,当作 log.New() 的参数,用于初始化其父元素。用户可通过接口自定义这些元素,若有初始化参数,则从其 XML 属性值中获取。

这样就达到了一个自由度相对比较高的配置文件。

接口设计

根据以上要求,我们大致上可以确定下来接口的内容。

一个从配置文件进行初始化的接口:

func InitFromConfig(path string) error

以及各个输出类型的操作函数,最主要的就是获取 *log.Logger 的接口,以及一些常用的简化调用。以 INFO 类型为例,我们可以定义以下几个函数,其它类型也都相同,只是函数名不同。

func INFO() *log.Logger  // 返回与 INFO 类型对应的 *log.Logger 实例

// 针对 INFO 类型日志的一些常用操作进行封装
func Info(v ...interface{})                // 相当于 INFO().Println()
func Infof(format string, v...interface{}) // 相当于 INFO().Printf()

我们还需要公开一个注册接口,用于注册用户自定义的元素:

type Init func(args map[string]string)(io.Writer, error)

func Register(name string, fn Init)

使用

只要在 main() 中正确定加载了配置文件,之后随处都可以调用:

// main.go
func main() {
    err := logs.InitFromConfig("./config/logs.xml")
    if err !=nil {
        panic(err)
    }

    // do something
}

// file1.go
func h1(w http.ResponseWriter, r *http.Request) {
    if !auth() {
        logs.Infof("鉴权失败")
        w.WriteHeader(http.StatusUnauthorized)
        return
    }
}

// file2.go
func getServer(port string, h http.Handler) *http.Server {
    return &http.Server {
        Addr: port,
        Handler: h,
        ErrorLog: logs.INFO(),
    }
}

实现

完整的实现代码在:https://github.com/issue9/logs

本文转载自:https://caixw.io/posts/2017/how-to-design-log-package-with-go.html

caixw

caixw

粉丝 2
博文 5
码字总数 0
作品 2
丽水
私信 提问
整理更新本人所属 Java 与 C++ 开源项目

*** Java *** 1、Java 全能高效 MVC & REST 开发框架 Portal-Basic 2、Java 日志切割清理工具 Log-Cutter *** C++ *** 1、通用高性能 Windows Socket 组件 HP-Socket 2、Windows C++ 应用程序...

伤神小怪兽
2013/05/22
1K
10
更新本人的 Java 与 C++ 开源项目(2014.11)

*** Java *** 1、高效 Java Web 开发框架 JessMA 2、Java 日志切割清理工具 Log-Cutter *** C++ *** 1、通用高性能 Windows Socket 组件 HP-Socket 2、Windows C++ 应用程序通用日志组件 VC...

伤神小怪兽
2014/11/11
1K
12
整理更新本人所属 Java 与 C++ 开源项目(2014.09)

*** Java *** 1、高效 Java Web 开发框架 JessMA 2、Java 日志切割清理工具 Log-Cutter *** C++ *** 1、通用高性能 Windows Socket 组件 HP-Socket 2、Windows C++ 应用程序通用日志组件 VC...

伤神小怪兽
2014/09/28
1K
16
GoAccess:一个实时的 Web 日志分析器及交互式查看器

分析日志文件对于 Linux 管理员来说是一件非常令人头疼的事情,因为它记录了很多东西。大多数新手和初级管理员都不知道如何分析。如果你在分析日志方面拥有很多知识,那么你就成了 *NIX 系统...

作者: Vinoth Kumar
06/12
0
0
更新整理本人所有博文中提供的代码与工具(C++,2013.11)

  为了更方便地管理博文中涉及的各种代码与工具资源,现在把这些资源迁移到 Google Code 中,有兴趣者可前往下载。 C++ 1、《通用高性能 Windows Socket 组件 HP-Socket v3.0.2 正式发布》...

伤神小怪兽
2013/11/26
1K
19

没有更多内容

加载失败,请刷新页面

加载更多

JavaScript设计模式——适配器模式

  适配器模式是设计模式行为型模式中的一种模式;   定义:   适配器用来解决两个已有接口之间不匹配的问题,它并不需要考虑接口是如何实现,也不用考虑将来该如何修改;适配器不需要修...

有梦想的咸鱼前端
18分钟前
2
0
Andorid SQLite数据库开发基础教程(1)

Andorid SQLite数据库开发基础教程(1) Android数据库访问方式 SQLite是Android系统默认支持的文件数据库。该数据库支持SQL语言,适合开发人员上手。本教程将讲解如何开发使用SQLite的Andro...

大学霸
21分钟前
2
0
Handler简解

Handler 这里简化一下代码 以便理解 Handler不一定要在主线程建 但如Handler handler = new Handler(); 会使用当前的Looper的, 由于要更新UI 所以最好在主线程 new Handler() { mLooper = Lo...

shzwork
44分钟前
4
0
h5获取摄像头拍照功能

完整代码展示: <!DOCTYPE html> <head> <title>HTML5 GetUserMedia Demo</title> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum......

诗书易经
46分钟前
3
0
正向代理和反向代理

文章来源 运维公会:正向代理和反向代理 1、正向代理 (1)服务对象不同 正向代理服务器的服务对象是客户端,可以将客户端和代理服务器看作一个整体。 (2)配置方法不同 需要在客户端配置代...

运维团
今天
4
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部