参数
请参阅插件通用配置,了解所有插件通用的配置选项。
此插件没有可在路由或服 务上配置的参数。
插件元数据
tcp
object
TCP 服务器配置。
host
string
必填
TCP 服务器的 IP 地址或主机名。
port
integer
必填
有效值:
大于或等于 0
目标上游端口。
tls
boolean
默认值:
false如果为 true,则执行 SSL 验证。
tls_server_name
string
新 TLS 扩展 SNI 的服务器名称。
skywalking
object
Skywalking 服务器配置。
endpoint_addr
string
默认值:
http://127.0.0.1:12900/v3/logsSkyWalking 服务器地址。
service_name
string
默认值:
APISIXSkyWalking 报告器的服务名称。
service_instance_name
string
默认值:
APISIX Service InstanceSkyWalking 报告器的服务实例名称。设置为
$hostname以获取本地主机名。
clickhouse
object
ClickHouse 服务器配置。
endpoint_addr
string
默认值:
http://127.0.0.1:8123ClickHouse 端点。
user
string
默认值:
defaultClickHouse 用户名。
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有效值:
PLAINSASL 配置的机制。
user
string
必填
SASL 配置的用户。
password
string
必填
SASL 配置的密码。
kafka_topic
string
必填
推送日志的目标 topic。
producer_type
string
默认值:
async有效值:
async或sync生产者类型。
required_acks
key
string
用于为消息分配分区的键。
cluster_name
integer
默认值:
1有效值:
大于或等于 1
集群名称。当有两个或更多 Kafka 集群时使用。仅当
producer_type设置为async时有效。meta_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 监控 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
丢弃日志条目之前允许的最大不成功重试次数。