google-cloud-logging

摘要

定义

google-cloud-logging 插件用于将 Apache APISIX 的请求日志发送到 Google Cloud Logging Service。

该插件提供了将请求的日志数据以批处理队列的形式推送到谷歌云日志服务的功能。

有关 Apache APISIX 的 Batch-Processor 的更多信息，请参考： Batch-Processor

属性列表

名称是否必需默认值描述
auth_config半可选必须配置 auth_config 或 auth_file 之一
auth_config.private_key必选谷歌服务帐号的私钥参数
auth_config.project_id必选谷歌服务帐号的项目ID
auth_config.token_uri可选https://oauth2.googleapis.com/token请求谷歌服务帐户的令牌的URI
auth_config.entries_uri可选https://logging.googleapis.com/v2/entries:write谷歌日志服务写入日志条目的API
auth_config.scopes可选[“https://www.googleapis.com/auth/logging.read","https://www.googleapis.com/auth/logging.write","https://www.googleapis.com/auth/logging.admin","https://www.googleapis.com/auth/cloud-platform“]谷歌服务账号的访问范围, 参考: OAuth 2.0 Scopes for Google APIs
auth_file半可选谷歌服务账号JSON文件的路径（必须配置 auth_config 或 auth_file 之一）
ssl_verify可选true启用 SSL 验证, 配置根据 OpenResty文档 选项
resource可选{“type”: “global”}谷歌监控资源，参考： MonitoredResource
log_id可选apisix.apache.org%2Flogs谷歌日志ID，参考： LogEntry
max_retry_count可选0从处理管道中移除之前的最大重试次数
retry_delay可选1如果执行失败，流程执行应延迟的秒数
buffer_duration可选60必须先处理批次中最旧条目的最大期限（以秒为单位）
inactive_timeout可选5刷新缓冲区的最大时间（以秒为单位）
batch_max_size可选1000每个批处理队列可容纳的最大条目数

如何开启

下面例子展示了如何为指定路由开启 google-cloud-logging 插件。

完整配置

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "plugins": {
  4.         "google-cloud-logging": {
  5.             "auth_config":{
  6.                 "project_id":"apisix",
  7.                 "private_key":"-----BEGIN RSA PRIVATE KEY-----your private key-----END RSA PRIVATE KEY-----",
  8.                 "token_uri":"https://oauth2.googleapis.com/token",
  9.                 "scopes":[
  10.                     "https://www.googleapis.com/auth/logging.admin"
  11.                 ],
  12.                 "entries_uri":"https://logging.googleapis.com/v2/entries:write"
  13.             },
  14.             "resource":{
  15.                 "type":"global"
  16.             },
  17.             "log_id":"apisix.apache.org%2Flogs",
  18.             "inactive_timeout":10,
  19.             "max_retry_count":0,
  20.             "max_retry_count":0,
  21.             "buffer_duration":60,
  22.             "retry_delay":1,
  23.             "batch_max_size":1
  24.         }
  25.     },
  26.     "upstream": {
  27.         "type": "roundrobin",
  28.         "nodes": {
  29.             "127.0.0.1:1980": 1
  30.         }
  31.     },
  32.     "uri": "/hello"
  33. }'

最小化配置

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "plugins": {
  4.         "google-cloud-logging": {
  5.             "auth_config":{
  6.                 "project_id":"apisix",
  7.                 "private_key":"-----BEGIN RSA PRIVATE KEY-----your private key-----END RSA PRIVATE KEY-----"
  8.             }
  9.         }
  10.     },
  11.     "upstream": {
  12.         "type": "roundrobin",
  13.         "nodes": {
  14.             "127.0.0.1:1980": 1
  15.         }
  16.     },
  17.     "uri": "/hello"
  18. }'

测试插件

  • 向配置 google-cloud-logging 插件的路由发送请求
  1. $ curl -i http://127.0.0.1:9080/hello
  2. HTTP/1.1 200 OK
  3. ...
  4. hello, world
  • 登录谷歌云日志服务，查看日志

Google Cloud Logging Service

禁用插件

禁用 google-cloud-logging 插件非常简单，只需将 google-cloud-logging 对应的 JSON 配置移除即可。

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/hello",
  4.     "plugins": {},
  5.     "upstream": {
  6.         "type": "roundrobin",
  7.         "nodes": {
  8.             "127.0.0.1:1980": 1
  9.         }
  10.     }
  11. }'