Golang高效收集Web应用统计信息的中间件插件库stats的使用

stats是一个用于Golang的net/http处理程序，可以报告关于Web应用程序的各种指标。

兼容性

该中间件目前支持以下框架：

• negroni
• martini
• gocraft/web
• Gin
• Goji
• Beego
• HTTPRouter

如果你的框架不在列表中，可以提交PR或创建issue请求实现。

安装

1. 确保已安装Go语言编译器(>=1.3)和git
2. 确保系统PATH中有以下依赖：bzr、svn、hg、git
3. 确保GOPATH设置正确
4. 下载安装：

go get github.com/thoas/stats

使用示例

基本net/http使用

package main

import (
    "net/http"
    "github.com/thoas/stats"
)

func main() {
    h := http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        w.Header().Set("Content-Type", "application/json")
        w.Write([]byte("{\"hello\": \"world\"}"))
    })

    handler := stats.New().Handler(h)
    http.ListenAndServe(":8080", handler)
}

Negroni框架使用

package main

import (
    "net/http"
    "github.com/codegangsta/negroni"
    "github.com/thoas/stats"
    "encoding/json"
)

func main() {
    middleware := stats.New()

    mux := http.NewServeMux()

    mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
        w.Header().Set("Content-Type", "application/json")
        w.Write([]byte("{\"hello\": \"world\"}"))
    })

    mux.HandleFunc("/stats", func(w http.ResponseWriter, r *http.Request) {
        w.Header().Set("Content-Type", "application/json")

        stats := middleware.Data()

        b, _ := json.Marshal(stats)

        w.Write(b)
    })

    n := negroni.Classic()
    n.Use(middleware)
    n.UseHandler(mux)
    n.Run(":3000")
}

HTTPRouter框架使用

package main

import (
    "encoding/json"
    "github.com/julienschmidt/httprouter"
    "github.com/thoas/stats"
    "net/http"
)

func main() {
    router := httprouter.New()
    s := stats.New()
    router.GET("/stats", func(w http.ResponseWriter, _ *http.Request, _ httprouter.Params) {
        w.Header().Set("Content-Type", "application/json; charset=utf-8")
        s, err := json.Marshal(s.Data())
        if err != nil {
            http.Error(w, err.Error(), http.StatusInternalServerError)
        }
        w.Write(s)
    })
    http.ListenAndServe(":8080", s.Handler(router))
}

Martini框架使用

package main

import (
    "encoding/json"
    "github.com/go-martini/martini"
    "github.com/thoas/stats"
    "net/http"
)

func main() {
    middleware := stats.New()

    m := martini.Classic()
    m.Get("/", func(w http.ResponseWriter, r *http.Request) {
        w.Header().Set("Content-Type", "application/json")
        w.Write([]byte("{\"hello\": \"world\"}"))
    })
    m.Get("/stats", func(w http.ResponseWriter, r *http.Request) {
        w.Header().Set("Content-Type", "application/json")

        stats := middleware.Data()

        b, _ := json.Marshal(stats)

        w.Write(b)
    })

    m.Use(func(c martini.Context, w http.ResponseWriter, r *http.Request) {
        beginning, recorder := middleware.Begin(w)

        c.Next()

        middleware.End(beginning, stats.WithRecorder(recorder))
    })
    m.Run()
}

输出示例

运行服务后，访问/stats端点会返回如下JSON格式的统计信息：

{
    "total_response_time": "1.907382ms",
    "average_response_time": "86.699µs",
    "average_response_time_sec": 8.6699e-05,
    "count": 1,
    "pid": 99894,
    "status_code_count": {
        "200": 1
    },
    "time": "2015-03-06 17:23:27.000677896 +0100 CET",
    "total_count": 22,
    "total_response_time_sec": 0.0019073820000000002,
    "total_status_code_count": {
        "200": 22
    },
    "unixtime": 1425659007,
    "uptime": "4m14.502271612s",
    "uptime_sec": 254.502271612
}

实现原理

该中间件实现了每秒重置请求数的计时器，未来还将添加更多功能。它最初由Antoine Imbert开发用于go-json-rest，后被Florent Messa移植为一个简单的Golang处理程序，以便在各种框架中使用。