Iris 的 AccessLog 中介軟體

Iris Web 框架的 accesslog 中間件提供傳入 HTTP 請求的詳細日誌記錄。此中間件具有高度可配置性，可記錄請求和回應的各個方面，包括自訂欄位。

特徵

• 記錄請求和回應詳細資料。
• 支援多種輸出格式（JSON、CSV、自訂範本）。
• 可以登入多個目的地（檔案、標準輸出等）。
• 非同步日誌記錄支援。
• 可自訂的日誌欄位。
• 中間件可以有條件地應用。

安裝

要使用accesslog中間件，您需要將其匯入到您的Iris應用程式中：

import (
    "github.com/kataras/iris/v12"
    "github.com/kataras/iris/v12/middleware/accesslog"
)

基本用法

以下是如何在 Iris 應用程式中使用 accesslog 中間件的基本範例：

package main

import (
    "github.com/kataras/iris/v12"
    "github.com/kataras/iris/v12/middleware/accesslog"
)

func makeAccessLog() *accesslog.AccessLog {
    ac := accesslog.File("./access.log")

    ac.Delim = '|'
    ac.TimeFormat = "2006-01-02 15:04:05"
    ac.Async = false
    ac.IP = true
    ac.BytesReceivedBody = true
    ac.BytesSentBody = true
    ac.BytesReceived = false
    ac.BytesSent = false
    ac.RequestBody = true
    ac.ResponseBody = false
    ac.KeepMultiLineError = true
    ac.PanicLog = accesslog.LogHandler

    ac.SetFormatter(&accesslog.JSON{
        Indent:    "  ",
        HumanTime: true,
    })

    return ac
}

func main() {
    ac := makeAccessLog()
    defer ac.Close()

    app := iris.New()
    app.UseRouter(ac.Handler)

    app.Get("/", func(ctx iris.Context) {
        ctx.WriteString("OK")
    })

    app.Listen(":8080")
}

配置選項

輸出目的地

您可以使用檔案或新功能設定日誌的輸出目的地：

ac := accesslog.File("./access.log")
// or
ac := accesslog.New(os.Stdout)

日誌格式

預設日誌格式為：

Time|Latency|Code|Method|Path|IP|Path Params Query Fields|Bytes Received|Bytes Sent|Request|Response|

您可以使用不同的格式化程式自訂日誌格式：

JSON 格式化程式

ac.SetFormatter(&accesslog.JSON{
    Indent:    "  ",
    HumanTime: true,
})

CSV 格式化程式

ac.SetFormatter(&accesslog.CSV{})

自訂模板格式化程序

ac.SetFormatter(&accesslog.Template{Text: "{{.Code}}"})

自訂字段

您可以為日誌條目新增自訂欄位：

ac.AddFields(func(ctx iris.Context, f *accesslog.Fields) {
    for k, v := range ctx.Request().Header {
        value := strings.Join(v, ", ")
        f.Set("request.header."+k, value)
    }
})

非同步日誌記錄

啟用非同步日誌記錄以提高效能：

ac.Async = true

條件日誌記錄

您可以跳過特定路線或條件的記錄：

app.UseRouter(accesslog.SkipHandler)

進階用法

記錄到多個目的地

您可以使用 io.MultiWriter 登入多個目的地：

ac.SetOutput(io.MultiWriter(os.Stdout, accesslog.File("./access.log")))

客製化時鐘

您可以為日誌時間戳記設定自訂時鐘，這對於測試很有用：

ac.Clock = accesslog.TClock(time.Now())

中介軟體集成

將 accesslog 中介軟體與其他中間件整合：

app.UseRouter(ac.Handler)
app.UseRouter(otherMiddleware)

範例

將請求記錄到 JSON 文件

ac := accesslog.File("access_log.json")
ac.SetFormatter(&accesslog.JSON{
    Indent:    "  ",
    HumanTime: true,
})
app.UseRouter(ac.Handler)

使用日誌輪轉

請參閱日誌輪替範例以了解更多詳細資訊。

自訂欄位和模板

請參閱自訂欄位和範本範例以了解更多詳細資訊。

監聽日誌並將其呈現給客戶端

請參閱日誌代理程式範例以了解更多詳細資訊。

結論

Iris 的 accesslog 中間件是一個用來記錄 HTTP 請求和回應的強大工具。憑藉其靈活的配置選項以及對自訂欄位和格式的支持，它可以進行自訂以滿足任何應用程式的需求。

更多範例和詳細使用方法，請參考Iris官方文件。

以上是Iris 的 AccessLog 中介軟體的詳細內容。更多資訊請關注PHP中文網其他相關文章！