Splunk HTTP Event Collector (HEC)
Receive logs from Splunk
/services/collector/event
, /services/collector/raw
, and /services/collector/health
.Configuration
Example configurations
{
"sources": {
"my_source_id": {
"type": "splunk_hec"
}
}
}
[sources.my_source_id]
type = "splunk_hec"
sources:
my_source_id:
type: splunk_hec
{
"sources": {
"my_source_id": {
"type": "splunk_hec",
"address": "0.0.0.0:8088",
"valid_tokens": [
"A94A8FE5CCB19BA61C4C08"
]
}
}
}
[sources.my_source_id]
type = "splunk_hec"
address = "0.0.0.0:8088"
valid_tokens = [ "A94A8FE5CCB19BA61C4C08" ]
sources:
my_source_id:
type: splunk_hec
address: 0.0.0.0:8088
valid_tokens:
- A94A8FE5CCB19BA61C4C08
acknowledgements
optional objectsplunk_hec
source.acknowledgements.ack_idle_cleanup
optional boolWhether or not to remove channels after idling for max_idle_time
seconds.
A channel is idling if it is not used for sending data or querying acknowledgement statuses.
false
acknowledgements.enabled
optional boolacknowledgements.max_idle_time
optional uintThe amount of time, in seconds, a channel is allowed to idle before removal.
Channels can potentially idle for longer than this setting but clients should not rely on such behavior.
Minimum of 1
.
300
acknowledgements.max_number_of_ack_channels
optional uintThe maximum number of Splunk HEC channels clients can use with this source.
Minimum of 1
.
1e+06
acknowledgements.max_pending_acks
optional uintThe maximum number of acknowledgement statuses pending query across all channels.
Equivalent to the max_number_of_acked_requests_pending_query
Splunk HEC setting.
Minimum of 1
.
1e+07
acknowledgements.max_pending_acks_per_channel
optional uintThe maximum number of acknowledgement statuses pending query for a single channel.
Equivalent to the max_number_of_acked_requests_pending_query_per_ack_channel
Splunk HEC setting.
Minimum of 1
.
1e+06
address
optional string literalThe socket address to listen for connections on.
The address must include a port.
0.0.0.0:8088
store_hec_token
optional boolWhether or not to forward the Splunk HEC authentication token with events.
If set to true
, when incoming requests contain a Splunk HEC token, the token used is kept in the
event metadata and preferentially used if the event is sent to a Splunk HEC sink.
false
tls
optional objecttls.alpn_protocols
optional [string]Sets the list of supported ALPN protocols.
Declare the supported ALPN protocols, which are used during negotiation with peer. They are prioritized in the order that they are defined.
tls.ca_file
optional string literalAbsolute path to an additional CA certificate file.
The certificate must be in the DER or PEM (X.509) format. Additionally, the certificate can be provided as an inline string in PEM format.
tls.crt_file
optional string literalAbsolute path to a certificate file used to identify this server.
The certificate must be in DER, PEM (X.509), or PKCS#12 format. Additionally, the certificate can be provided as an inline string in PEM format.
If this is set, and is not a PKCS#12 archive, key_file
must also be set.
tls.enabled
optional boolWhether or not to require TLS for incoming or outgoing connections.
When enabled and used for incoming connections, an identity certificate is also required. See tls.crt_file
for
more information.
tls.key_file
optional string literalAbsolute path to a private key file used to identify this server.
The key must be in DER or PEM (PKCS#8) format. Additionally, the key can be provided as an inline string in PEM format.
tls.key_pass
optional string literalPassphrase used to unlock the encrypted key file.
This has no effect unless key_file
is set.
tls.verify_certificate
optional boolEnables certificate verification.
If enabled, certificates must not be expired and must be issued by a trusted issuer. This verification operates in a hierarchical manner, checking that the leaf certificate (the certificate presented by the client/server) is not only valid, but that the issuer of that certificate is also valid, and so on until the verification process reaches a root certificate.
Relevant for both incoming and outgoing connections.
Do NOT set this to false
unless you understand the risks of not verifying the validity of certificates.
tls.verify_hostname
optional boolEnables hostname verification.
If enabled, the hostname used to connect to the remote host must be present in the TLS certificate presented by the remote host, either as the Common Name or as an entry in the Subject Alternative Name extension.
Only relevant for outgoing connections.
Do NOT set this to false
unless you understand the risks of not verifying the remote hostname.
token
optional string literalOptional authorization token.
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 is ignored and requests are not authenticated.
valid_tokens
optional [string]A list of valid authorization tokens.
If supplied, incoming requests must supply one of these tokens 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 is ignored and requests are not authenticated.
Outputs
<component_id>
Output Data
Logs
Warning
Event
2019-02-13T19:48:34+00:00 [info] Started GET "/" for 127.0.0.1
splunk_hec
X-Splunk-Request-Channel
header or channel
query parameter, in that order of precedence.2020-10-10T17:07:36.452332Z
2020-10-10T17:07:36.452332Z
Telemetry
Metrics
linkcomponent_discarded_events_total
counterfilter
transform, or false if due to an error.component_errors_total
countercomponent_received_bytes_total
countercomponent_received_event_bytes_total
countercomponent_received_events_count
histogramA histogram of the number of events passed in each internal batch in Vector’s internal topology.
Note that this is separate than sink-level batching. It is mostly useful for low level debugging performance issues in Vector due to small internal batches.
component_received_events_total
countercomponent_sent_event_bytes_total
countercomponent_sent_events_total
counterhttp_server_handler_duration_seconds
histogramhttp_server_requests_received_total
counterhttp_server_responses_sent_total
counterrequests_received_total
countersource_lag_time_seconds
histogramHow it works
Indexer Acknowledgements
Transport Layer Security (TLS)
tls.*
options and/or via an
OpenSSL configuration file. The file location defaults to
/usr/local/ssl/openssl.cnf
or can be specified with the OPENSSL_CONF
environment variable.