splunk_hec

This feature requires an Enterprise license. To upgrade, contact Redpanda sales.

Publishes messages to a Splunk HTTP Endpoint Collector (HEC).

Introduced in version 4.30.0.

  • Common

  • Advanced

# Common config fields, showing default values
output:
  label: ""
  splunk_hec:
    url: https://foobar.splunkcloud.com/services/collector/event # No default (required)
    token: "" # No default (required)
    gzip: false
    event_host: "" # No default (optional)
    event_source: "" # No default (optional)
    event_sourcetype: "" # No default (optional)
    event_index: "" # No default (optional)
    max_in_flight: 64
    batching:
      count: 0
      byte_size: 0
      period: ""
      check: ""
# All config fields, showing default values
output:
  label: ""
  splunk_hec:
    url: https://foobar.splunkcloud.com/services/collector/event # No default (required)
    token: "" # No default (required)
    gzip: false
    event_host: "" # No default (optional)
    event_source: "" # No default (optional)
    event_sourcetype: "" # No default (optional)
    event_index: "" # No default (optional)
    skip_cert_verify: false
    max_in_flight: 64
    batching:
      count: 0
      byte_size: 0
      period: ""
      check: ""
      processors: [] # No default (optional)

Performance

This output benefits from sending multiple messages in flight in parallel for improved performance. You can tune the max number of in flight messages (or message batches) with the field max_in_flight.

This output benefits from sending messages as a batch for improved performance. Batches can be formed at both the input and output level. You can find out more in this doc.

Fields

url

Full HTTP Endpoint Collector (HEC) URL.

Type: string

# Examples

url: https://foobar.splunkcloud.com/services/collector/event

token

A bot token used for authentication.

This field contains sensitive information that usually shouldn’t be added to a config directly, read our secrets page for more info.

Type: string

gzip

Enable gzip compression

Type: bool

Default: false

event_host

Set the host value to assign to the event data. Overrides existing host field if present.

Type: string

event_source

Set the source value to assign to the event data. Overrides existing source field if present.

Type: string

event_sourcetype

Set the sourcetype value to assign to the event data. Overrides existing sourcetype field if present.

Type: string

event_index

Set the index value to assign to the event data. Overrides existing index field if present.

Type: string

skip_cert_verify

Whether to skip server side certificate verification.

Type: bool

Default: false

max_in_flight

The maximum number of messages to have in flight at a given time. Increase this to improve throughput.

Type: int

Default: 64

batching

Allows you to configure a batching policy.

Type: object

# Examples

batching:
  byte_size: 5000
  count: 0
  period: 1s

batching:
  count: 10
  period: 1s

batching:
  check: this.contains("END BATCH")
  count: 0
  period: 1m

batching.count

A number of messages at which the batch should be flushed. If 0 disables count based batching.

Type: int

Default: 0

batching.byte_size

An amount of bytes at which the batch should be flushed. If 0 disables size based batching.

Type: int

Default: 0

batching.period

A period in which an incomplete batch should be flushed regardless of its size.

Type: string

Default: ""

# Examples

period: 1s

period: 1m

period: 500ms

batching.check

A Bloblang query that should return a boolean value indicating whether a message should end a batch.

Type: string

Default: ""

# Examples

check: this.type == "end_of_transaction"

batching.processors

A list of processors to apply to a batch as it is flushed. This allows you to aggregate and archive the batch however you see fit. Please note that all resulting messages are flushed as a single batch, therefore splitting the batch into smaller batches using these processors is a no-op.

Type: array

# Examples

processors:
  - archive:
      format: concatenate

processors:
  - archive:
      format: lines

processors:
  - archive:
      format: json_array