Syslog

Syslog

本文原文链接：https://docs.konghq.com/hub/kong-inc/syslog/

将请求和响应数据记录到Syslog。

术语

plugin: 在请求被代理到上游API之前或之后，在Kong内部执行操作的插件。
Service: 表示外部 upstream API或微服务的Kong实体。
Route: 表示将下游请求映射到上游服务的方法的Kong实体。
Consumer: 代表使用API的开发人员或机器的Kong实体。当使用Kong时，Consumer 仅与Kong通信，其代理对所述上游API的每次调用。
Credential: 与Consumer关联的唯一字符串，也称为API密钥。
upstream service: 这是指位于Kong后面的您自己的 API/service，转发客户端请求。

配置

此插件与具有以下协议的请求兼容：

http
https
grpc
grpcs

此插件与无DB模式兼容。

在 Service 上启用插件

使用数据库：

通过发出以下请求在Service上配置此插件：

$ curl -X POST http://kong:8001/services/{service}/plugins \
    --data "name=syslog"

不使用数据库：

通过添加此部分在服务上配置此插件执行声明性配置文件：

plugins:
- name: syslog
  service: {service}
  config:

在这两种情况下，{service}是此插件配置将定位的 Service 的id或name。

在 Route 上启用插件

使用数据库：

通过发出以下请求在 Route 上配置此插件：

$ curl -X POST http://kong:8001/routes/{route}/plugins \
    --data "name=syslog"

不使用数据库：

通过添加此部分在 Route 上配置此插件执行声明性配置文件：

plugins:
- name: syslog
  route: {route}
  config:

在这两种情况下，，{route}是此插件配置将定位的 route 的id或name。

在 Consumer 上启用插件

使用数据库：

您可以使用http://localhost:8001/plugins在特定的Consumers上启用此插件:

$ curl -X POST http://kong:8001/consumers/{consumer}/plugins \
    --data "name=syslog" \

不使用数据库：

通过添加此部分在Consumer上配置此插件执行声明性配置文件：

plugins:
- name: syslog
  consumer: {consumer}
  config:

在这两种情况下，{consumer}都是此插件配置将定位的Consumer的id或username。
您可以组合consumer_id和service_id 。在同一个请求中，进一步缩小插件的范围。

全局插件

使用数据库： 可以使用http://kong:8001/plugins/配置所有插件。
不使用数据库： 可以通过plugins: 配置所有插件：声明性配置文件中的条目。

与任何 Service ，Route 或 Consumer （或API，如果您使用旧版本的Kong）无关的插件被视为“全局”，并将在每个请求上运行。有关更多信息，请阅读插件参考和插件优先级部分。

参数

以下是可在此插件配置中使用的所有参数的列表：

参数	默认值	描述
`name`		要使用的插件的名称，在本例中为`ip-restriction`
`service_id`		此插件将定位的 Service 的ID。
`route_id`		此插件将定位的 Route 的ID。
`enabled`	`true`	是否将应用此插件。
`consumer_id`		此插件将定位的Consumer的id
`config.successful_severity` optional	`info`	分配给所有成功请求的可选日志记录严重性，响应状态代码小于400。
`config.client_errors_severity` optional	`info`	可选的日志记录严重性，分配给所有响应状态代码为400或更高但小于500的失败请求。。
`config.server_errors_severity` optional	`info`	可选的日志严重性分配给所有失败的请求与响应状态代码500或更高。
`config.log_level` optional	`info`	可选的日志记录严重性，具有相同或更高严重性的任何请求都将记录到系统日志中。。

日志格式

每个请求都将以SYSLOG标准记录到系统日志中，消息组件的格式如下：

{
    "request": {
        "method": "GET",
        "uri": "/get",
        "url": "http://httpbin.org:8000/get",
        "size": "75",
        "querystring": {},
        "headers": {
            "accept": "*/*",
            "host": "httpbin.org",
            "user-agent": "curl/7.37.1"
        },
        "tls": {
            "version": "TLSv1.2",
            "cipher": "ECDHE-RSA-AES256-GCM-SHA384",
            "supported_client_ciphers": "ECDHE-RSA-AES256-GCM-SHA384",
            "client_verify": "NONE"
        }
    },
    "upstream_uri": "/",
    "response": {
        "status": 200,
        "size": "434",
        "headers": {
            "Content-Length": "197",
            "via": "kong/0.3.0",
            "Connection": "close",
            "access-control-allow-credentials": "true",
            "Content-Type": "application/json",
            "server": "nginx",
            "access-control-allow-origin": "*"
        }
    },
    "tries": [
        {
            "state": "next",
            "code": 502,
            "ip": "127.0.0.1",
            "port": 8000
        },
        {
            "ip": "127.0.0.1",
            "port": 8000
        }
    ],
    "authenticated_entity": {
        "consumer_id": "80f74eef-31b8-45d5-c525-ae532297ea8e",
        "id": "eaa330c0-4cff-47f5-c79e-b2e4f355207e"
    },
    "route": {
        "created_at": 1521555129,
        "hosts": null,
        "id": "75818c5f-202d-4b82-a553-6a46e7c9a19e",
        "methods": null,
        "paths": [
            "/example-path"
        ],
        "preserve_host": false,
        "protocols": [
            "http",
            "https"
        ],
        "regex_priority": 0,
        "service": {
            "id": "0590139e-7481-466c-bcdf-929adcaaf804"
        },
        "strip_path": true,
        "updated_at": 1521555129
    },
    "service": {
        "connect_timeout": 60000,
        "created_at": 1521554518,
        "host": "example.com",
        "id": "0590139e-7481-466c-bcdf-929adcaaf804",
        "name": "myservice",
        "path": "/",
        "port": 80,
        "protocol": "http",
        "read_timeout": 60000,
        "retries": 5,
        "updated_at": 1521554518,
        "write_timeout": 60000
    },
    "workspaces": [
        {
            "id":"b7cac81a-05dc-41f5-b6dc-b87e29b6c3a3",
            "name": "default"
        }
    ],
    "consumer": {
        "username": "demo",
        "created_at": 1491847011000,
        "id": "35b03bfc-7a5b-4a23-a594-aa350c585fa8"
    },
    "latencies": {
        "proxy": 1430,
        "kong": 9,
        "request": 1921
    },
    "client_ip": "127.0.0.1",
    "started_at": 1433209822425
}

关于上述JSON对象的一些注意事项：

request 包含有关客户端发送的请求的属性
response 包含有关发送到客户端的响应的属性
tries 包含负载均衡器为此请求进行的（或重新）尝试（成功和失败）列表
route 包含有关所请求的特定 route 的Kong属性
service 包含与所请求的 Route 相关联的 service 的Kong属性
authenticated_entity 包含有关经过身份验证的凭据的Kong属性（如果已启用身份验证插件）
workspaces 包含与请求的路由关联的工作空间的Kong属性。仅限Kong Enterprise版本> = 0.34
consumer 包含经过身份验证的使用者（如果已启用身份验证插件）
latencies 包含一些有关延迟的数据：
- proxy 是最终服务处理请求所花费的时间
- kong 是运行所有插件所需的内部Kong延迟
- request 是从客户端读取的第一个字节之间以及最后一个字节发送到客户端之间经过的时间。用于检测慢速客户端。
client_ip 包含原始客户端IP地址。
started_at 包含开始处理请求的UTC时间戳。

记录

确保Syslog守护程序正在实例上运行，并且其日志记录级别的严重性等于或低于设置的config.log_level。

Kong Process Errors

此日志记录插件将仅记录HTTP请求和响应数据。如果要查找Kong进程错误文件（即nginx错误文件），则可以在以下路径中找到它：$KONG_PREFIX/logs/error.log，其中$ KONG_PREFIX表示配置的前缀。