access-log

插件信息

名称字段属性
access-logaccess_log可观测性

功能描述

能够记录到达网关的http请求的访问日志,通过配置的输出器将筛选后的信息输出到特定的地方。

备注:输出器的教程点此进行跳转。

配置参数说明

参数名说明是否必填默认值值可能性
output输出器id数组string_array

Open API 请求示例

配置输出器(以文件输出器为例)
curl -X POST 'http://127.0.0.1:9400/api/output' -H 'Content-Type:application/json' \
-d '{
  "name": "demo_file",
  "driver": "file",
  "dir": "/var/log",
  "file": "demo",
  "period": "day",
  "expire": 1,
  "type": "line",
  "formatter": {
    "fields": ["$request_id", "$request", "$status", "@time", "@proxy", "$response_time"],
    "time": ["$msec", "$time_iso8601", "$time_local"],
    "proxy": ["$proxy_uri", "$proxy_scheme", "$proxy_addr"]
  }
}'

返回的输出器id为demo_file@output

output示例说明:访问日志将输出到/var/log目录下的demo.log文件,每天生成一个新的日志文件,旧日志文件保留一天后删除。日志格式为line,输出的变量如配置所示。

全局配置
curl -X POST  'http://127.0.0.1:9400/api/setting/plugin' \
-H 'Content-Type:application/json' \
-d '{
    "plugins":[{
        "id":"eolinker.com:apinto:access_log",
        "name":"my_access_log",
        "status":"enable"
    }]
}'
配置带有access-log插件的服务

全局插件具体配置点此进行跳转

备注:匿名服务配置的是apinto官方示例接口,将返回请求的相关信息。

curl -X POST  'http://127.0.0.1:9400/api/service' \
-H 'Content-Type:application/json' \
-d '{
  "name": "access_log_service",
  "driver": "http",
  "timeout": 3000,
  "retry": 3,
  "scheme": "http",
  "nodes": ["demo-apinto.eolink.com:8280"],
  "balance": "round-robin",
  "plugins": {
    "my_access_log": {
    "disable": false,
    "config": {
      "output": ["demo_file@output"]
    }
   }
  }
}' 
绑定路由
curl -X POST  'http://127.0.0.1:9400/api/router' \
-H 'Content-Type:application/json' \
-d '{
    "name":"access_log_router",
    "driver":"http",
    "listen":8099,
    "rules":[{
        "location":"/demo/access_log"
    }],
    "target":"access_log_service@service"
}'
接口请求示例
curl -i -X GET 'http://127.0.0.1:8099/demo/access_log'
访问日志示例
a72e12f9-e33a-4425-b7c2-7e48b0b598bf    GET /demo HTTP/1.1      200     "1640601794 2021-12-27T18:43:14.294+08:00 2021-12-27 18:43:14"  "http://demo-apinto.eolink.com:8280/demo http demo-apinto.eolink.com:8280"  1389