# Error Log Logger 配置选项

error-log-logger 插件将错误日志分批发送到 TCP、Apache SkyWalking、Apache Kafka 或 ClickHouse 服务器，并支持按严重级别筛选。<!-- --> <!-- -->配置涵盖插件元数据。

## 参数[​](#参数 "参数的��直接链接")

请参阅插件[通用配置](https://docs.apiseven.com/apisix/reference/plugin-common-configurations.md)，了解所有插件通用的配置选项。

此插件没有可在路由或服务上配置的参数。

## 插件元数据[​](#插件元数据 "插件元数据的直接链接")

* tcp

  object

  ***

  TCP 服务器配置。

  * host

    string

    必填

    ***

    TCP 服务器的 IP 地址或主机名。

  * port

    integer

    必填

    有效值：

    大于或等于 0

    ***

    目标上游端口。

  * tls

    boolean

    默认值：`false`

    ***

    如果为 true，则使用 TLS 加密 TCP 连接。系统不会验证接收端的证书。

  * tls\_server\_name

    string

    ***

    当 `tcp.tls` 为 `true` 时，通过 TLS 服务器名称指示（SNI）扩展发送的服务器名称。这不会启用证书验证。

* skywalking

  object

  ***

  Skywalking 服务器配置。

  * endpoint\_addr

    string

    默认值：`http://127.0.0.1:12900/v3/logs`

    ***

    SkyWalking 服务器地址。

  * service\_name

    string

    默认值：`APISIX`

    ***

    SkyWalking 报告器的服务名称。

  * service\_instance\_name

    string

    默认值：`APISIX Service Instance`

    ***

    SkyWalking 报告器的服务实例名称。设置为 `$hostname` 以获取本地主机名。

* clickhouse

  object

  ***

  ClickHouse 服务器配置。配置此区块时，必须提供所有子字段。

  * endpoint\_addr

    string

    必填

    默认值：`http://127.0.0.1:8123`

    ***

    ClickHouse 端点。

  * user

    string

    必填

    默认值：`default`

    ***

    ClickHouse 用户名。

  * password

    string

    必填

    ***

    ClickHouse 密码。

    密码在存储到 etcd 之前使用 AES 加密。

  * database

    string

    必填

    ***

    存储日志的数据库名称。

  * logtable

    string

    必填

    ***

    存储日志的表名。该表应具有一个 `data` 列，插件将日志推送到该列。

* kafka

  object

  ***

  Kafka 服务器配置。

  * brokers

    array

    必填

    有效值：

    大于 0

    ***

    Kafka broker 节点列表。

    * host

      string

      必填

      ***

      Kafka broker 的主机。

    * port

      integer

      必填

      ***

      Kafka broker 的端口。

    * sasl\_config

      object

      ***

      Kafka broker 的 SASL 配置。

      * mechanism

        string

        默认值：`PLAIN`

        有效值：

        `PLAIN`

        ***

        SASL 配置的机制。

      * user

        string

        必填

        ***

        SASL 配置的用户。

      * password

        string

        必填

        ***

        Kafka SASL 配置的密码。启用数据加密时，该值会在[存储前加密](https://docs.apiseven.com/apisix/production/security/data-encryption-with-keyring.md)。

  * tls

    object

    ***

    连接 Kafka Broker 的 TLS 配置。设置此对象后，插件会通过 TLS 连接；省略该对象则使用明文连接。自 APISIX 3.18.0 起引入。

    * verify

      boolean

      默认值：`false`

      ***

      如果为 true，则使用配置的受信任 CA 存储验证 Kafka Broker 的 TLS 证书。默认值为 `false`，因此启用 `tls` 会加密连接，但不会对 Broker 进行身份认证。生产环境中请将其设置为 `true`。

  * kafka\_topic

    string

    必填

    ***

    推送日志的目标 topic。

  * producer\_type

    string

    默认值：`async`

    有效值：

    `async` 或 `sync`

    ***

    推送日志以进行组织的目标主题。

  * required\_acks

    integer

    默认值：`1`

    有效值：

    -1、0 或 1

    ***

    生产者认为请求完成前，分区 leader 需要收到的确认数。这控制发送记录的持久性。有关更多信息，请参阅 [Kafka 文档](https://kafka.apache.org/documentation/#producerconfigs_acks)。

  * key

    string

    ***

    用于为消息分配分区的键。

  * cluster\_name

    integer

    默认值：`1`

    有效值：

    大于或等于 1

    ***

    集群名称。当有两个或更多 Kafka 集群时使用。仅当 `producer_type` 设置为 `async` 时有效。

  * meta\_refresh\_interval

    integer

    默认值：`30`

    有效值：

    大于或等于 1

    ***

    自动刷新元数据的时间间隔。与 [lua-resty-kafka](https://github.com/doujiang24/lua-resty-kafka) 中的 `refresh_interval` 参数相同，但以秒为单位。

* timeout

  integer

  默认值：`3`

  有效值：

  大于 0

  ***

  连接到已配置的日志服务并发送数据的超时时间（秒）。

* keepalive

  integer

  默认值：`30`

  有效值：

  大于或等于 1

  ***

  发送数据后保持连接存活的时间，以秒为单位。

* level

  string

  默认值：`WARN`

  有效值：

  `STDERR`、`EMERG`、`ALERT`、`CRIT`、`ERR`、`ERROR`、`WARN`、`NOTICE`、`INFO` 或 `DEBUG`

  ***

  过滤错误日志的严重级别。请注意，`ERR` 与 `ERROR` 相同。

* name

  string

  默认值：`error-log-logger`

  ***

  批处理器的插件唯一标识符。如果你使用 [Prometheus](https://docs.apiseven.com/hub/prometheus.md) 监控 APISIX 指标，则名称将导出到 `apisix_batch_process_entries` 中。

* batch\_max\_size

  integer

  默认值：`1000`

  有效值：

  大于 0

  ***

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

* inactive\_timeout

  integer

  默认值：`3`

  有效值：

  大于 0

  ***

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

* buffer\_duration

  integer

  默认值：`60`

  有效值：

  大于 0

  ***

  发送批次到日志服务之前，允许的最早条目的最长时间（秒）。

* retry\_delay

  integer

  默认值：`1`

  有效值：

  大于或等于 0

  ***

  如果批次发送不成功，重试发送到日志服务的时间间隔（秒）。

* max\_retry\_count

  integer

  默认值：`0`

  有效值：

  大于或等于 0

  ***

  丢弃日志条目之前允许的最大不成功重试次数。
