Parameters
See plugin common configurations for configuration options available to all plugins.
endpoint
Splunk HEC endpoint configurations.
uri
Splunk HEC event collector API endpoint.
token
Splunk HEC authentication token. API7 Gateway encrypts the value with AES at rest. APISIX encrypts it before etcd storage when
apisix.data_encryption.enable_encrypt_fieldsis enabled.channel
Splunk HEC send data channel identifier. For more information, see About HTTP Event Collector Indexer Acknowledgment.
timeout
Splunk HEC send data timeout in seconds.
keepalive_timeout
vaild vaule:
greater than or equal to 1000
Keepalive timeout in milliseconds.
ssl_verify
log_format
Custom log format using key-value pairs in JSON format. Values can reference built-in variables.
In APISIX from 3.15.0, log format nested structures are supported up to five levels deep. In API7 Enterprise, only flat key-value structures are supported; nested structures are not yet supported.
You can also configure log format on a global scale using the plugin metadata, which configures the log format for all
splunk-hec-loggingplugin instances. If the log format configured on the individual plugin instance differs from the log format configured on plugin metadata, the log format configured on the individual plugin instance takes precedence. See the example for more details.log_format_extra
Additional fields to add to the default log entry, using key-value pairs in JSON format. Values can reference built-in variables. A configured field does not overwrite an existing default field. A plugin instance takes precedence over plugin metadata; setting an empty object on the instance disables the metadata value. When
log_formatis configured,log_format_extrais ignored. Introduced in API7 Enterprise 3.9.15 and 3.10.2, and APISIX 3.18.0.name
Unique identifier of the plugin for the batch processor.
batch_max_size
vaild vaule:
greater than 0
The number of log entries allowed in one batch. Once reached, the batch will be sent to Splunk HEC. Setting this parameter to 1 means immediate processing.
inactive_timeout
vaild vaule:
greater than 0
The maximum time in seconds to wait for new logs before sending the batch to the logging service. The value should be smaller than
buffer_duration.buffer_duration
vaild vaule:
greater than 0
The maximum time in seconds from the earliest entry allowed before sending the batch to the logging service.
retry_delay
vaild vaule:
greater than or equal to 0
The time interval in seconds to retry sending the batch to the logging service if the batch was not successfully sent.
max_retry_count
vaild vaule:
greater than or equal to 0
The maximum number of unsuccessful retries allowed before dropping the log entries.
Plugin Metadata
log_format
Custom log format using key-value pairs in JSON format. Values can reference built-in variables.
In APISIX from 3.15.0, log format nested structures are supported up to five levels deep. In API7 Enterprise, only flat key-value structures are supported; nested structures are not yet supported.
log_format_extra
Additional fields to add to the default log entry, using key-value pairs in JSON format. Values can reference built-in variables. A configured field does not overwrite an existing default field. A plugin instance takes precedence over plugin metadata; setting an empty object on the instance disables the metadata value. When
log_formatis configured,log_format_extrais ignored. Introduced in API7 Enterprise 3.9.15 and 3.10.2, and APISIX 3.18.0.max_pending_entries
vaild vaule:
greater than or equal to 1
Maximum number of entries waiting in the batch processor. New entries are discarded when the backlog reaches the limit.
Introduced in API7 Enterprise 3.8.17 and APISIX 3.15.0.
The default changed to
8192in APISIX 3.18.0 and in API7 Enterprise 3.9.19 on the 3.9 line and 3.10.6 on the 3.10 line. In API7 Enterprise 3.9.18 and 3.10.5, and in earlier APISIX versions, omitting the parameter leaves the backlog unlimited.See Batch Processor for sizing and verification guidance.