splunk-hec-logging | 支流科技文档

参数

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

endpoint
object[object]
required
Splunk HEC 端点配置。
- url
  string
  required
  Splunk HEC 事件收集器 API 端点。
- token
  string
  required
  Splunk HEC 认证令牌。
- channel
  string
  Splunk HEC 发送数据通道标识符。有关更多信息，请参阅关于 HTTP 事件收集器索引器确认。
- timeout
  integer
  default: 10
  Splunk HEC 发送数据超时时间（秒）。
- keepalive_timeout
  integer
  default: 60000
  vaild vaule:
  大于或等于 1000
  Keepalive 超时时间（毫秒）。
ssl_verify
boolean
default: true
启用 SSL 验证。
log_format
object
使用 JSON 格式的键值对自定义日志格式。值可以引用内置变量。
从 APISIX 3.15.0 开始，支持最多 5 层深度的嵌套日志格式结构。在 API7 企业版中，仅支持扁平键值结构；暂不支持嵌套结构。
你还可以使用插件元数据全局配置日志格式，这将为所有 splunk-hec-logging 插件实例配置日志格式。如果单个插件实例上配置的日志格式与插件元数据上配置的日志格式不同，则以单个插件实例上配置的日志格式为准。有关更多详细信息，请参阅示例。
name
string
default: splunk-hec-logging
批处理器的插件唯一标识符。
batch_max_size
integer
default: 1000
vaild vaule:
大于 0
每个批次允许的最大日志条目数。一旦达到该数量，批次将被发送到 Splunk HEC/日志服务端点。将此参数设置为 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
允许的最大重试次数，超过此次数将丢弃日志条目。

插件元数据

log_format
object
使用 JSON 格式的键值对自定义日志格式。值可以引用内置变量。
从 APISIX 3.15.0 开始，支持最多 5 层深度的嵌套日志格式结构。在 API7 企业版中，仅支持扁平键值结构；暂不支持嵌套结构。
max_pending_entries
integer
vaild vaule:
大于或等于 1
批处理器中允许的最大未处理条目数。当达到此限制时，新条目将被丢弃，直到积压减少。这有助于防止在记录器缓慢或不可用时出现内存峰值。
此参数在 API7 企业版 3.8.17 及更高版本和 APISIX 3.15.0 及更高版本中可用。

参数​

插件元数据​

参数

插件元数据