Error Log Logger | API 网关文档

参数

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

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

插件元数据

tcp
object
TCP 服务器配置。
- host
  string
  required
  TCP 服务器的 IP 地址或主机名。
- port
  integer
  required
  vaild vaule:
  大于或等于 0
  目标上游端口。
- tls
  boolean
  default: false
  如果为 true，则执行 SSL 验证。
- tls_server_name
  string
  default: 新 TLS 扩展 SNI 的服务器名称。
skywalking
object
Skywalking 服务器配置。
- endpoint_addr
  string
  default: http://127.0.0.1:12900/v3/logs
  SkyWalking 服务器地址。
- service_name
  string
  default: APISIX
  SkyWalking 报告器的服务名称。
- service_instance_name
  string
  default: APISIX 实例名称
  SkyWalking 报告器的服务实例名称。设置为 $hostname 以获取本地主机名。
clickhouse
object
ClickHouse 服务器配置。
- endpoint_addr
  string
  default: http://127.0.0.1:8123
  ClickHouse 端点。
- user
  string
  default: default
  ClickHouse 用户名。
- password
  string
  ClickHouse 密码。
  密码在存储到 etcd 之前使用 AES 加密。
- database
  string
  存储日志的数据库名称。
- logtable
  string
  存储日志的表名。该表应具有一个 data 列，插件将日志推送到该列。
kafka
object
Kafka 服务器配置。
- brokers
  array
  required
  vaild vaule:
  大于 0
  Kafka broker 节点列表。
  host
  string
  required
  Kafka broker 的主机。
  port
  string
  required
  Kafka broker 的端口。
  sasl_config
  string
  Kafka broker 的 SASL 配置。
  mechanism
  string
  default: PLAIN
  vaild vaule:
  PLAIN
  SASL 配置的机制。
  user
  string
  required
  SASL 配置的用户。
  password
  string
  required
  SASL 配置的密码。
- kafka_topic
  string
  required
  推送日志的目标 topic。
- producer_type
  string
  default: async
  vaild vaule:
  async or sync
  生产者类型。
- required_acks
  integer
  vaild vaule:
  -1 or 1
  生产者认为请求完成所需的确认数。这控制发送记录的持久性。有关更多信息，请参阅 Kafka 文档。尚不支持 acks=0。
- key
  string
  用于为消息分配分区的键。
- cluster_name
  integer
  default: 1
  vaild vaule:
  大于或等于 0
  集群名称。当有两个或更多 Kafka 集群时使用。仅当 producer_type 设置为 async 时有效。
- meta_refresh_interval
  integer
  default: 30
  vaild vaule:
  大于或等于 1
  自动刷新元数据的时间间隔。与 lua-resty-kafka 中的 refresh_interval 参数相同，但以秒为单位。
timeout
integer
default: 3
vaild vaule:
大于 0
发送请求后保持连接存活的时间。
keepalive
integer
default: 30
vaild vaule:
大于或等于 1
发送数据后保持连接存活的时间，以秒为单位。
level
string
default: WARN
vaild vaule:
STDERR, EMERG, ALERT, CRIT, ERR, ERROR, WARN, NOTICE, INFO, or DEBUG
过滤错误日志的严重级别。请注意，ERR 与 ERROR 相同。
name
string
default: error-log-logger
批处理器的插件唯一标识符。如果你使用 Prometheus 监控 APISIX 指标，则名称将导出到 apisix_batch_process_entries 中。
batch_max_size
integer
default: 1000
vaild vaule:
大于 0
一个批次中允许的最大日志条目数。一旦达到上限，批次将被发送到配置的日志服务或远程服务器。将此参数设置为 1 意味着立即处理。
inactive_timeout
integer
default: 5
vaild vaule:
大于 0
在将批次发送到日志服务之前等待新日志的最长时间（秒）。该值应小于 buffer_duration。
buffer_duration
integer
default: 60
vaild vaule:
大于 0
发送批次到日志服务之前，允许的最早条目的最长时间（秒）。
retry_delay
integer
default: 1
vaild vaule:
大于或等于 0
如果批次发送不成功，重试发送到日志服务的时间间隔（秒）。
max_retry_count
integer
default: 60
vaild vaule:
大于或等于 0
丢弃日志条目之前允许的最大不成功重试次数。

参数​

插件元数据​

参数

插件元数据