Splunk HTTP Event Collector (HEC)

Receive logs from Splunk

status: stable role: aggregator delivery: at-least-once egress: batch state: stateless output: log

Configuration

Example configurations

{
  "sources": {
    "my_source_id": {
      "type": "splunk_hec",
      "address": "0.0.0.0:8080",
      "token": "A94A8FE5CCB19BA61C4C08"
    }
  }
}
[sources.my_source_id]
type = "splunk_hec"
address = "0.0.0.0:8080"
token = "A94A8FE5CCB19BA61C4C08"
---
sources:
  my_source_id:
    type: splunk_hec
    address: 0.0.0.0:8080
    token: A94A8FE5CCB19BA61C4C08
{
  "sources": {
    "my_source_id": {
      "type": "splunk_hec",
      "address": "0.0.0.0:8080",
      "token": "A94A8FE5CCB19BA61C4C08"
    }
  }
}
[sources.my_source_id]
type = "splunk_hec"
address = "0.0.0.0:8080"
token = "A94A8FE5CCB19BA61C4C08"
---
sources:
  my_source_id:
    type: splunk_hec
    address: 0.0.0.0:8080
    tls: null
    token: A94A8FE5CCB19BA61C4C08

address

common optional string
The address to accept connections on.
default: 0.0.0.0:8080

tls

optional object
Configures the TLS options for incoming connections.

tls.ca_file

optional string literal
Absolute path to an additional CA certificate file, in DER or PEM format (X.509), or an in-line CA certificate in PEM format.

tls.crt_file

optional string literal
Absolute path to a certificate file used to identify this server, in DER or PEM format (X.509) or PKCS#12, or an in-line certificate in PEM format. If this is set, and is not a PKCS#12 archive, key_file must also be set. This is required if enabled is set to true.

tls.enabled

optional bool
Require TLS for incoming connections. If this is set, an identity certificate is also required.
default: false

tls.key_file

optional string literal
Absolute path to a private key file used to identify this server, in DER or PEM format (PKCS#8), or an in-line private key in PEM format.

tls.key_pass

optional string literal
Pass phrase used to unlock the encrypted key file. This has no effect unless key_file is set.

tls.verify_certificate

optional bool
If true, Vector will require a TLS certificate from the connecting host and terminate the connection if the certificate is not valid. If false (the default), Vector will not request a certificate from the client.
default: false

token

common optional string
If supplied, incoming requests must supply this token in the Authorization header, just as a client would if it was communicating with the Splunk HEC endpoint directly. If not supplied, the Authorization header will be ignored and requests will not be authenticated.

Output

Logs

event

A single event

Telemetry

Metrics

link

events_in_total

counter
The number of events accepted by this component either from tagged origin like file and uri, or cumulatively from other origins.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.
container_name optional
The name of the container from which the event originates.
file optional
The file from which the event originates.
mode optional
The connection mode used by the component.
peer_addr optional
The IP from which the event originates.
peer_path optional
The pathname from which the event originates.
pod_name optional
The name of the pod from which the event originates.
uri optional
The sanitized URI from which the event originates.

events_out_total

counter
The total number of events emitted by this component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.

http_request_errors_total

counter
The total number of HTTP request errors for this component.

requests_received_total

counter
The total number of requests received by this component.
component_kind required
The Vector component kind.
component_name required
The Vector component name.
component_type required
The Vector component type.

How it works

Context

By default, the splunk_hec source augments events with helpful context keys.

State

This component is stateless, meaning its behavior is consistent across each input.

Transport Layer Security (TLS)

Vector uses OpenSSL for TLS protocols. You can adjust TLS behavior via the tls.* options.