跳到主要内容

参数​

请参阅插件通用配置，了解所有插件通用的配置选项。

  • auth_config

    object

    直接配置在插件实例上的服务账号密钥字段。请配置 auth_config 或 auth_file 其中之一。插件不使用 Google 应用默认凭据。如果部署可通过密钥管理系统挂载密钥，请优先使用 auth_file。

    • client_email

      string

      必填

      Google Cloud 服务账号的电子邮件地址。

    • private_key

      string

      必填

      Google Cloud 服务账号的私钥。启用 APISIX 数据加密时，此字段会被标记为加密存储。请保护声明式文件和密钥交付流程中的明文值。

    • project_id

      string

      必填

      Google Cloud 服务账号中的项目 ID。

    • token_uri

      string

      必填

      默认值：https://oauth2.googleapis.com/token

      Google Cloud 服务账号的 Token URI。

    • entries_uri

      string

      默认值：https://logging.googleapis.com/v2/entries:write

      Google Cloud Logging 服务 API。

    • scope

      array[string]

      默认值：["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"]

      Google Cloud 服务账号的访问范围。请参阅 Google API 的 OAuth 2.0 范围。也可以使用 scopes 指定此字段。

  • auth_file

    string

    已挂载的 Google Cloud 服务账号 JSON 密钥路径。请配置 auth_config 或 auth_file 其中之一。文件必须包含插件使用的顶层 entries_uri。省略 scope 时，插件使用 https://www.googleapis.com/auth/cloud-platform。每个网关实例中都必须存在相同路径。

  • ssl_verify

    boolean

    默认值：true

    如果设置为 true，验证服务器的 SSL 证书。

  • resource

    object

    默认值：{"type": "global"}

    Google 受监控资源由 type 和可选的 labels 组成，例如：

    {
  "type": "gce_instance",
  "labels": {
    "project_id": "my-project",
    "instance_id": "12345678901234",
    "zone": "us-central1-a"
  }
}

    有关更多详细信息，请参阅 MonitoredResource。

  • log_id

    string

    默认值：apisix.apache.org%2Flogs

    Google Cloud 日志 ID。有关详细信息，请参阅 LogEntry。

  • log_format

    object

    使用 JSON 格式的键值对自定义日志格式。值可以引用内置变量。

    从 APISIX 3.15.0 开始，日志格式支持最多 5 层深度的嵌套结构。在 API7 企业版中，仅支持扁平的键值对结构，暂不支持嵌套结构。

    你也可以通过配置插件元数据来全局配置日志格式，这将对所有 google-cloud-logging 插件实例生效。如果单个插件实例配置的日志格式与插件元数据中配置的日志格式不同，则单个插件实例的配置优先级更高。

  • log_format_extra

    object

    用于向默认日志条目添加额外字段，使用 JSON 格式的键值对。值可引用内置变量。已配置的字段不会覆盖现有默认字段。插件实例优先于插件元数据；在实例上设置空对象会禁用元数据值。配置 log_format 时，log_format_extra 会被忽略。

    使用插件元数据为所有 google-cloud-logging 实例配置其他字段。详情请参阅示例。

    自 API7 企业版 3.9.15、3.10.2 和 APISIX 3.18.0 起引入。

  • name

    string

    默认值：google-cloud-logging

    批处理器的唯一标识符。如果你使用 Prometheus 监控 APISIX 指标，该名称将导出在 apisix_batch_process_entries 中。

  • batch_max_size

    integer

    默认值：1000

    有效值：

    大于 0

    每一批次允许的最大日志条目数。一旦达到该数值，批次将被发送到日志服务。将此参数设置为 1 意味着立即处理。

  • inactive_timeout

    integer

    默认值：5

    有效值：

    大于 0

    在将批次发送到日志服务之前，等待新日志的最长时间（以秒为单位）。该值应小于 buffer_duration。

  • buffer_duration

    integer

    默认值：60

    有效值：

    大于 0

    批次中最旧条目在发送到日志服务之前允许保留的最长时间（以秒为单位）。

  • retry_delay

    integer

    默认值：1

    有效值：

    大于或等于 0

    如果批次发送失败，重试发送到日志服务的时间间隔（以秒为单位）。

  • max_retry_count

    integer

    默认值：0

    有效值：

    大于或等于 0

    在丢弃日志条目之前允许的最大失败重试次数。

插件元数据​

  • log_format

    object

    使用 JSON 格式的键值对自定义日志格式。值可以引用内置变量。

    从 APISIX 3.15.0 开始，日志格式支持最多 5 层深度的嵌套结构。在 API7 企业版中，仅支持扁平的键值对结构，暂不支持嵌套结构。

  • log_format_extra

    object

    用于向默认日志条目添加额外字段，使用 JSON 格式的键值对。值可引用内置变量。已配置的字段不会覆盖现有默认字段。插件实例优先于插件元数据；在实例上设置空对象会禁用元数据值。配置 log_format 时，log_format_extra 会被忽略。

    自 API7 企业版 3.9.15、3.10.2 和 APISIX 3.18.0 起引入。

  • max_pending_entries

    integer

    默认值：8192

    有效值：

    大于或等于 1

    批处理器中等待处理的最大条目数。当积压达到此限制时，新条目会被丢弃。

    此参数在 API7 企业版 3.8.17 和 APISIX 3.15.0 中引入。

    在 APISIX 3.18.0、API7 企业版 3.9 分支的 3.9.19 以及 3.10 分支的 3.10.6 中，默认值变更为 8192。在 API7 企业版 3.9.18、3.10.5 及更早的 APISIX 版本中，省略该参数会使积压队列不设上限。

    有关容量规划和验证指南，请参见批处理器。