Промежуточное программное обеспечение журнала доступа для веб-платформы Iris обеспечивает подробную регистрацию входящих 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)

Использование ротации журналов

Для получения более подробной информации обратитесь к примеру ротации журналов.

Пользовательские поля и шаблон

Для получения более подробной информации обратитесь к примеру настраиваемых полей и шаблона.

Прослушивание и отображение журналов клиенту

Для получения более подробной информации обратитесь к примеру брокера журналов.

Заключение

Промежуточное ПО Accesslog для Iris — это мощный инструмент для регистрации HTTP-запросов и ответов. Благодаря гибким возможностям конфигурации и поддержке настраиваемых полей и форматов его можно адаптировать к потребностям любого приложения.

Дополнительные примеры и подробное описание использования см. в официальной документации Iris.