Iris Web フレームワークのアクセスログ ミドルウェアは、受信 HTTP リクエストの詳細なログを提供します。このミドルウェアは高度に構成可能で、カスタム フィールドを含むリクエストとレスポンスのさまざまな側面をログに記録できます。

特徴

• リクエストとレスポンスの詳細をログに記録します。
• 複数の出力形式 (JSON、CSV、カスタム テンプレート) をサポートします。
• 複数の宛先にログを記録できます (ファイル、標準出力など)。
• 非同期ロギングのサポート。
• カスタマイズ可能なログフィールド。
• ミドルウェアは条件付きで適用できます。

インストール

アクセスログ ミドルウェアを使用するには、それを Iris アプリケーションにインポートする必要があります:

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

基本的な使い方

Iris アプリケーションでアクセスログ ミドルウェアを使用する基本的な例を次に示します:

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())

ミドルウェアの統合

アクセスログミドルウェアを他のミドルウェアと統合します:

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 の公式ドキュメントを参照してください。