AccessLog Middleware untuk Iris

Perisian tengah accesslog untuk rangka kerja web Iris menyediakan pengelogan terperinci untuk permintaan HTTP yang masuk. Perisian tengah ini sangat boleh dikonfigurasikan dan boleh log pelbagai aspek permintaan dan respons, termasuk medan tersuai.

Ciri-ciri

• Butiran permintaan dan respons log.
• Menyokong berbilang format output (JSON, CSV, templat tersuai).
• Boleh log ke berbilang destinasi (fail, stdout, dll.).
• Sokongan pengelogan tak segerak.
• Medan log boleh disesuaikan.
• Perisian tengah boleh digunakan secara bersyarat.

Pemasangan

Untuk menggunakan perisian tengah accesslog, anda perlu mengimportnya dalam aplikasi Iris anda:

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

Penggunaan Asas

Berikut ialah contoh asas cara menggunakan perisian tengah accesslog dalam aplikasi 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")
}

Pilihan Konfigurasi

Destinasi Output

Anda boleh menetapkan destinasi output untuk log menggunakan Fail atau fungsi Baharu:

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

Format Log

Format log lalai ialah:

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

Anda boleh menyesuaikan format log menggunakan pemformat yang berbeza:

Pemformat JSON

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

Pemformat CSV

ac.SetFormatter(&accesslog.CSV{})

Pemformat Templat Tersuai

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

Medan Tersuai

Anda boleh menambah medan tersuai pada entri log:

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

Pengelogan Asynchronous

Dayakan pengelogan tak segerak untuk meningkatkan prestasi:

ac.Async = true

Pembalakan Bersyarat

Anda boleh melangkau pembalakan untuk laluan atau syarat tertentu:

app.UseRouter(accesslog.SkipHandler)

Penggunaan Lanjutan

Log masuk ke Berbilang Destinasi

Anda boleh log ke berbilang destinasi menggunakan io.MultiWriter:

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

Jam Tersuai

Anda boleh menetapkan jam tersuai untuk cap masa log, berguna untuk ujian:

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

Integrasi Middleware

Sepadukan perisian tengah accesslog dengan perisian tengah lain:

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

Contoh

Log Permintaan ke Fail JSON

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

Menggunakan Putaran Log

Rujuk contoh putaran log untuk butiran lanjut.

Medan dan Templat Tersuai

Rujuk medan tersuai dan contoh templat untuk butiran lanjut.

Dengar dan Render Log kepada Pelanggan

Rujuk contoh broker log untuk butiran lanjut.

Kesimpulan

Perisian tengah accesslog untuk Iris ialah alat yang berkuasa untuk mengelog permintaan dan respons HTTP. Dengan pilihan konfigurasi fleksibel dan sokongan untuk medan dan format tersuai, ia boleh disesuaikan untuk memenuhi keperluan mana-mana aplikasi.

Untuk lebih banyak contoh dan penggunaan terperinci, rujuk dokumentasi rasmi Iris.

Atas ialah kandungan terperinci AccessLog Middleware untuk Iris. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!