跳到主要内容

syslog

syslog 插件将请求和响应日志作为 JSON 对象分批推送到 syslog 服务器，并支持自定义日志格式。

示例​

以下示例展示了如何在不同场景下配置 syslog 插件。

要跟随示例操作，你应该有一个运行中的 syslog 服务器，或者在 Docker 中启动一个示例 rsyslog 服务器：

docker run -d -p 514:514 --name example-rsyslog-server rsyslog/syslog_appliance_alpine

推送日志到 Syslog 服务器​

以下示例展示了如何在路由上启用 syslog 插件，该插件记录客户端对路由的请求并将日志推送到 syslog 服务器。

创建一个路由并在其上启用 syslog：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_KEY}" \
  -d '{
    "id": "syslog-route",
    "uri": "/anything",
    "plugins": {
      "syslog": {
        // Annotate 1
        "host" : "172.0.0.1",
        // Annotate 2
        "port" : 514,
        // Annotate 3
        "flush_limit" : 1
      }
    },
    "upstream": {
      "nodes": {
        "httpbin.org:80": 1
      },
      "type": "roundrobin"
    }
  }'

❶ host: 替换为你的 syslog 服务器地址。

❷ port: 替换为你的 syslog 服务器端口。

❸ flush_limit: 设置为 1 以立即将日志推送到 syslog 服务器。

发送一个请求到该路由：

curl -i "http://127.0.0.1:9080/anything"

你应该收到 HTTP/1.1 200 OK 响应。

在 syslog 服务器中，你应该看到类似以下的日志条目：

{
  "response": {
    "status": 200,
    "headers": {
      "access-control-allow-credentials": "true",
      "connection": "close",
      "date": "Sat, 02 Mar 2024 00:14:19 GMT",
      "access-control-allow-origin": "*",
      "server": "APISIX/3.8.0",
      "content-type": "application/json",
      "content-length": "387"
    },
    "size": 614
  },
  "service_id": "",
  "client_ip": "172.19.0.1",
  "server": {
    "hostname": "eff61bf7be4d",
    "version": "3.8.0"
  },
  "upstream": "35.171.123.176:80",
  "apisix_latency": 13.999900817871,
  "request": {
    "method": "GET",
    "url": "http://127.0.0.1:9080/anything",
    "querystring": {},
    "size": 86,
    "uri": "/anything",
    "headers": {
      "host": "127.0.0.1:9080",
      "accept": "*/*",
      "user-agent": "curl/7.29.0"
    }
  },
  "route_id": "syslog-route",
  "upstream_latency": 165,
  "latency": 178.99990081787,
  "start_time": 1709334859598
}

使用插件元数据自定义日志格式​

以下示例展示了如何使用 插件元数据 自定义日志格式。在插件元数据中配置的日志格式将应用于所有 syslog 插件实例。

创建一个启用 syslog 插件的路由：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_KEY}" \
  -d '{
    "id": "syslog-route",
    "uri": "/anything",
    "plugins": {
      "syslog": {
        "host" : "172.0.0.1",
        "port" : 514,
        "flush_limit" : 1
      }
    },
    "upstream": {
      "nodes": {
        "httpbin.org:80": 1
      },
      "type": "roundrobin"
    }
  }'

配置 syslog 的插件元数据：

curl "http://127.0.0.1:9180/apisix/admin/plugin_metadata/syslog" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_KEY}" \
  -d '{
    "log_format": {
      "host": "$host",
      "@timestamp": "$time_iso8601",
      "route_id": "$route_id",
      "client_ip": "$remote_addr",
      "resp_content_type": "$sent_http_Content_Type"
    }
  }'

发送一个请求到该路由：

curl -i "http://127.0.0.1:9080/anything"

在 syslog 服务器中，你应该看到类似以下的日志条目：

{
  "@timestamp": "2024-03-02T00:00:31+00:00",
  "resp_content_type": "application/json",
  "host": "127.0.0.1",
  "route_id": "syslog-route",
  "client_ip": "172.19.0.1"
}

有条件地记录请求体​

以下示例展示了如何有条件地记录请求体。

创建一个启用 syslog 插件的路由如下：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_KEY}" \
  -d '{
    "id": "syslog-route",
    "uri": "/anything",
    "plugins": {
      "syslog": {
        "host" : "172.0.0.1",
        "port" : 514,
        "flush_limit" : 1,
        // Annotate 1
        "include_req_body": true,
        // Annotate 2
        "include_req_body_expr": [["arg_log_body", "==", "yes"]]
      }
    },
    "upstream": {
      "nodes": {
        "httpbin.org:80": 1
      },
      "type": "roundrobin"
    }
  }'

❶ include_req_body: 设置为 true 以包含请求体。

❷ include_req_body_expr: 仅当 URL 查询字符串 log_body 为 yes 时包含请求体。

发送一个满足条件的请求到该路由：

curl -i "http://127.0.0.1:9080/anything?log_body=yes" -X POST -d '{"env": "dev"}'

你应该看到请求体被记录：

{
  "response": {
    "status": 200,
    "headers": {
      "connection": "close",
      "server": "APISIX/3.8.0",
      "date": "Sat, 02 Mar 2024 00:46:04 GMT",
      "access-control-allow-origin": "*",
      "access-control-allow-credentials": "true",
      "content-type": "application/json",
      "content-length": "545"
    },
    "size": 772
  },
  "service_id": "",
  "client_ip": "172.19.0.1",
  "server": {
    "hostname": "eff61bf7be4d",
    "version": "3.8.0"
  },
  "upstream": "35.171.123.176:80",
  "apisix_latency": 0,
  "request": {
    "method": "POST",
    "url": "http://127.0.0.1:9080/anything?log_body=yes",
    "querystring": {
      "log_body": "yes"
    },
    "size": 183,
    "body": "{\"env\": \"dev\"}",
    "uri": "/anything?log_body=yes",
    "headers": {
      "accept": "*/*",
      "user-agent": "curl/7.29.0",
      "host": "127.0.0.1:9080",
      "content-type": "application/x-www-form-urlencoded",
      "content-length": "14"
    }
  },
  "route_id": "syslog-route",
  "upstream_latency": 165,
  "latency": 164.99996185303,
  "start_time": 1709340364390
}

发送一个不带 URL 查询字符串的请求到该路由：

curl -i "http://127.0.0.1:9080/post" -X POST -d '{"env": "dev"}'

你不应该在日志中看到请求体。

信息

如果你在设置 include_req_body 或 include_resp_body 为 true 的同时自定义了 log_format，插件将不会在日志中包含这些内容。

作为变通方法，你可以在日志格式中使用 NGINX 变量 $request_body，例如：

{
  "sislog": {
    ...,
    "log_format": {"body": "$request_body"}
  }
}