golang_es_coverage.png

原文地址mojotv.cn

1. 背景

不廢話,
Golang 日志查看疼點

1. linux查看日志,一般開發(fā)者對linux命令不是很熟悉, 搜索日志更加難上加難
2. JAVA生態(tài) ELKB 日志收集搭建復(fù)雜,
3. 需要的是一個快速查看搜索,客戶端來搜索日志

1.1 前期準(zhǔn)備

我們可以使用logrus hook 快速的輸出日志到Elastic Search 在使用Chrome Elastic Search GUI插件快速的定位你想用的日志.

1. 收集日志: https://github.com/sirupsen/logrus
2. 日志保存: docker elastic-search 數(shù)據(jù)庫 : docker run -d --name es.dev -p 9201:9200 -p 9301:9300 -e "discovery.type=single-node" elastic/elasticsearch:6.7.1
3. ES客戶端: chrome插件 Chrome Plugin ElasticSearch Head

2. 安裝ES數(shù)據(jù)庫

你可以去網(wǎng)上搜搜索 es數(shù)據(jù)庫安裝,在本教程中我們就來安裝一個 docker es 單節(jié)點 (處理golang日志性能足夠)

• 拉取鏡像 docker pull elasticsearch:6.7.0
• 安裝docker docker run -d --name mojocn.es -p 9201:9200 -p 9301:9300 -e "discovery.type=single-node" elastic/elasticsearch:6.7.1

這樣就您就啟動了一個 名字為 mojocn.es 端口 9201的單節(jié)點數(shù)據(jù)庫.

3. 編寫實現(xiàn) logrus HOOK interface (核心代碼)

main.go 完整代碼: https://github.com/mojocn/eslogrushook

package main

import (
    "context"
    "fmt"
    "github.com/olivere/elastic"
    "github.com/sirupsen/logrus"
    "log"
    "os"
    "strings"
    "time"
)

//cfg 配置文件
type cfg struct {
    LogLvl     string   // 日志級別
    EsAddrs    []string //ES addr
    EsUser     string   //ES user
    EsPassword string   //ES password
}

//setupLogrus 初始化logrus 同時把logrus的logger var 引用到這個common.Logger
func setupLogrus(cc cfg) error {
    //logFileName := fmt.Sprintf("%s_%s.log", os.Args[1], time.Now().Format("06_01_02T15_04_05"))
    //
    //f, err := os.Create(logFileName)
    //if err != nil {
    //  return err
    //}

    logLvl, err := logrus.ParseLevel(cc.LogLvl)
    if err != nil {
        return err
    }
    logrus.SetLevel(logLvl)
    //logrus.SetReportCaller(true)
    //logrus.SetFormatter(&logrus.JSONFormatter{})
    //使用console默認(rèn)輸出

    //logrus.SetOutput(f)

    logrus.SetReportCaller(true)
    //開啟 logrus ES hook
    esh := newEsHook(cc)
    logrus.AddHook(esh)
    fmt.Printf(">= error 級別,查看日志 %#v  中的logrus* 索引\n", cc.EsAddrs)

    return nil
}
func main() {
    cc := cfg{
        LogLvl:     "error",
        EsAddrs:    []string{"http://es.felix.mojotv.cn:9202/"},
        EsUser:     "",
        EsPassword: "",
    }
    err := setupLogrus(cc)
    if err != nil {
        log.Fatal(err)
    }
    logrus.WithField("URI", "mojotv.cn").Error("I love my son Felix")
    //等待日志發(fā)送到ES
    time.Sleep(time.Second * 10)
}

//esHook 自定義的ES hook
type esHook struct {
    cmd    string // 記錄啟動的命令
    client *elastic.Client
}

//newEsHook 初始化
func newEsHook(cc cfg) *esHook {
    es, err := elastic.NewClient(
        elastic.SetURL(cc.EsAddrs...),
        elastic.SetBasicAuth(cc.EsUser, cc.EsPassword),
        elastic.SetSniff(false),
        elastic.SetHealthcheckInterval(15*time.Second),
        elastic.SetErrorLog(log.New(os.Stderr, "ES:", log.LstdFlags)),
        //elastic.SetInfoLog(log.New(os.Stdout, "ES:", log.LstdFlags)),
    )

    if err != nil {
        log.Fatal("failed to create Elastic V6 Client: ", err)
    }
    return &esHook{client: es, cmd: strings.Join(os.Args, " ")}
}

//Fire logrus hook interface 方法
func (hook *esHook) Fire(entry *logrus.Entry) error {
    doc := newEsLog(entry)
    doc["cmd"] = hook.cmd
    go hook.sendEs(doc)
    return nil
}

//Levels logrus hook interface 方法
func (hook *esHook) Levels() []logrus.Level {
    return []logrus.Level{
        logrus.PanicLevel,
        logrus.FatalLevel,
        logrus.ErrorLevel,
    }
}

//sendEs 異步發(fā)送日志到es
func (hook *esHook) sendEs(doc appLogDocModel) {
    defer func() {
        if r := recover(); r != nil {
            fmt.Println("send entry to es failed: ", r)
        }
    }()
    _, err := hook.client.Index().Index(doc.indexName()).Type("_doc").BodyJson(doc).Do(context.Background())
    if err != nil {
        log.Println(err)
    }

}

//appLogDocModel es model
type appLogDocModel map[string]interface{}

func newEsLog(e *logrus.Entry) appLogDocModel {
    ins := map[string]interface{}{}
    for kk, vv := range e.Data {
        ins[kk] = vv
    }
    ins["time"] = time.Now().Local()
    ins["lvl"] = e.Level
    ins["message"] = e.Message
    ins["caller"] = fmt.Sprintf("%s:%d  %#v", e.Caller.File, e.Caller.Line, e.Caller.Func)
    return ins
}

// indexName es index name 時間分割
func (m *appLogDocModel) indexName() string {
    return "mojocn-cn-" + time.Now().Local().Format("2006-01-02")
}

go run main.go 日志輸出

>= error 級別,查看日志 []string{"http://i.love.mojotv.cn:9202/"}  中的logrus* 索引
time="2020-07-17T17:26:03+08:00" level=error msg=lld func=main.main file="D:/GolandProjects/logrusEsHook/main.go:59" URI=mojotv.cn

4. Chrome 插件 ElasticSearch Head 日志查看

1. 配置ES 連接地址
2. 查看/搜索 logrus日志

logrus_es_hook.png