Skip to main content
Version: 3.9

loggly

描述#

loggly 插件可用于将日志转发到 SolarWinds Loggly 进行分析和存储。

当启用插件时，APISIX 会将请求上下文信息序列化为符合 Loggly Syslog 的数据格式，即具有 RFC5424 兼容标头的 Syslog。

属性#

名称类型必选项默认值描述
customer_tokenstring是将日志发送到 Loggly 时使用的唯一标识符，以确保将日志发送到正确的组织帐户。
severitystring (enum)否INFOSyslog 日志事件的严重性级别。包括：DEBUG、INFO、NOTICE、WARNING、ERR、CRIT、ALERT 和 EMEGR。
severity_mapobject否nil一种将上游 HTTP 响应代码映射到 Syslog 中的方法。 key-value，其中 key 是 HTTP 响应代码，value是 Syslog 严重级别。例如{"410": "CRIT"}。
tagsarray否元数据将包含在任何事件日志中，以帮助进行分段和过滤。
log_formatobject否
include_req_bodyboolean否false当设置为 true 时，包含请求体。注意：如果请求体无法完全存放在内存中，由于 NGINX 的限制，APISIX 无法将它记录下来。
include_req_body_exprarray否当 include_req_body 属性设置为 true 时的过滤器。只有当此处设置的表达式求值为 true 时，才会记录请求体。有关更多信息，请参阅 lua-resty-expr 。
include_resp_bodyboolean否false当设置为 true 时，包含响应体。
include_resp_body_exprarray否当 include_resp_body 属性设置为 true 时进行过滤响应体，并且只有当此处设置的表达式计算结果为 true 时，才会记录响应体。更多信息，请参考 lua-resty-expr。

该插件支持使用批处理器来聚合并批量处理条目（日志或数据）。这样可以避免插件频繁地提交数据，默认设置情况下批处理器会每 5 秒钟或队列中的数据达到 1000 条时提交数据，如需了解批处理器相关参数设置，请参考 Batch-Processor。

如果要生成用户令牌，请在 Loggly 系统中的 <your assigned subdomain>/loggly.com/tokens 设置，或者在系统中单击 Logs > Source setup > Customer tokens。

默认日志格式示例#

<10>1 2024-01-06T06:50:51.739Z 127.0.0.1 apisix 58525 - [token-1@41058 tag="apisix"] {"service_id":"","server":{"version":"3.7.0","hostname":"localhost"},"apisix_latency":100.99985313416,"request":{"url":"http://127.0.0.1:1984/opentracing","headers":{"content-type":"application/x-www-form-urlencoded","user-agent":"lua-resty-http/0.16.1 (Lua) ngx_lua/10025","host":"127.0.0.1:1984"},"querystring":{},"uri":"/opentracing","size":155,"method":"GET"},"response":{"headers":{"content-type":"text/plain","server":"APISIX/3.7.0","transfer-encoding":"chunked","connection":"close"},"size":141,"status":200},"route_id":"1","latency":103.99985313416,"upstream_latency":3,"client_ip":"127.0.0.1","upstream":"127.0.0.1:1982","start_time":1704523851634}

插件元数据设置#

你还可以通过插件元数据配置插件。详细配置如下：

名称类型必选项默认值有效值描述
hoststring否"logs-01.loggly.com"发送日志的主机的端点。
portinteger否514要连接的 Loggly 端口。仅用于 syslog 协议。
timeoutinteger否5000发送数据请求超时时间（以毫秒为单位）。
protocolstring否"syslog"[ "syslog", "http", "https" ]将日志发送到 Loggly 的协议。
log_formatobject否nil以 JSON 格式的键值对来声明日志格式。对于值部分，仅支持字符串。如果是以 $ 开头，则表明是要获取 APISIX 变量 或 NGINX 内置变量。

APISIX 支持 Syslog、HTTP/S（批量端点）协议将日志事件发送到 Loggly。默认情况下 protocol 的值为 syslog。该协议允许你通过一些细粒度的控制（基于上游 HTTP 响应代码的日志严重性映射）发送符合 RFC5424 的系统日志事件。但是 HTTP/S 批量端点非常适合以更快的传输速度发送更大量的日志事件。

注意

Syslog 协议允许你发送符合 RFC5424 的 syslog 事件并进行细粒度控制。但是在以快速传输速度发送大量日志时，使用 HTTP/S 批量端点会更好。你可以通过以下方式更新元数据以更新使用的协议：

curl http://127.0.0.1:9180/apisix/admin/plugin_metadata/loggly \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
   "protocol": "http"
}'

启用插件#

以下示例展示了如何在指定路由上启用该插件：

完整配置

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "plugins":{
        "loggly":{
            "customer_token":"0e6fe4bf-376e-40f4-b25f-1d55cb29f5a2",
            "tags":["apisix", "testroute"],
            "severity":"info",
            "severity_map":{
                "503": "err",
                "410": "alert"
            },
            "buffer_duration":60,
            "max_retry_count":0,
            "retry_delay":1,
            "inactive_timeout":2,
            "batch_max_size":10
        }
    },
    "upstream":{
        "type":"roundrobin",
        "nodes":{
            "127.0.0.1:80":1
        }
    },
    "uri":"/index.html"
}'

最小化配置

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "plugins":{
        "loggly":{
            "customer_token":"0e6fe4bf-376e-40f4-b25f-1d55cb29f5a2",
        }
    },
    "upstream":{
        "type":"roundrobin",
        "nodes":{
            "127.0.0.1:80":1
        }
    },
    "uri":"/index.html"
}'

测试插件#

你可以通过以下命令向 APISIX 发出请求：

curl -i http://127.0.0.1:9080/index.html

发出请求后，你就可以在 Loggly 仪表盘上查看相关日志：

删除插件#

当你需要删除该插件时，可以通过如下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
    "uri": "/index.html",
    "plugins": {},
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:80": 1
        }
    }
}'