跳到主要内容

参数

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

  • auth_config

    object


    身份认证配置。必须提供 auth_configauth_file 中的至少一个。

    • client_email

      string


      必填


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

    • private_key

      string


      必填


      Google Cloud 服务账户的私钥。该值在存储到 etcd 前会使用 AES 加密。

    • project_id

      string


      必填


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

    • token_uri

      string


      必填


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


      Google Cloud 服务账户的令牌 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_configauth_file 中的至少一个。

  • 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 会保留默认条目并在其上添加所配置的字段。当设置了 log_format 时,log_format_extra 会被忽略。自 API7 企业版 3.9.15 版本起可用。

  • 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 会保留默认条目并在其上添加所配置的字段。当设置了 log_format 时,log_format_extra 会被忽略。自 API7 企业版 3.9.15 版本起可用。

  • max_pending_entries

    integer


    有效值:

    大于或等于 1


    批处理器中允许的最大未处理条目数。当达到此限制时,将丢弃新条目,直到积压减少。这有助于防止在记录器缓慢或不可用时出现内存峰值。

    此参数自 API7 企业版 3.8.17 和 APISIX 3.15.0 起可用。