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中文网其他相关文章！