Hardware and software requirements for the Splunk Add-on for Amazon Kinesis Firehose
Splunk platform requirements
The Splunk Add-on for Amazon Kinesis Firehose requires Splunk platform version 6.6.X and higher.
This add-on is supported in the following Splunk platform environments:
- Paid Splunk Cloud
- Splunk Enterprise running in an AWS Virtual Private Cloud (VPC)
- Splunk Enterprise running in your own internal network with SSL certificates installed on each indexer. Self-signed certificates are not supported, you must use a CA-signed certificate.
This add-on is not supported in free trial Splunk Cloud at this time.
If you plan to run this add-on entirely in paid Splunk Cloud, there are no additional Splunk platform requirements.
If you plan to run this add-on in a self-managed AWS instance, see Splunk Enterprise, free trial in the Cloud for sizing considerations specific to AWS.
If you are running this add-on on Splunk Enterprise in your own internal network, see System Requirements in the Splunk Enterprise Installation Manual.
The field alias functionality is compatible with the current version of this add-on. The current version of this add-on does not support older field alias configurations.
For more information about the field alias configuration change, refer to the Splunk Enterprise Release Notes.
Amazon Kinesis Firehose requires HTTP Event Collector (HEC) endpoint to be terminated with a valid CA-signed certificate matching the DNS hostname used to connect to your HEC endpoint.
You must use a trusted CA-signed certificate. Self-signed certificates are not supported.
If you are sending data directly into Splunk Enterprise indexers in your own internal network or AWS VPC, a CA-signed certificate must be installed to each of the indexers. If you are using an ELB to send data, you must install a CA-signed certificate on the load balancer.
Paid Splunk Cloud users are provided an ELB with a proper CA-signed certificate and a hostname for each stack. For ELB users on distributed Splunk Enterprise deployments, see Configure an Elastic Load Balancer for the Splunk Add-on for Amazon Kinesis Firehose for information on how to configure an ELB with proper SSL certifications.
Splunk admin requirements
To install the Splunk Add-on for Amazon Kinesis Firehose, you must be a member of the admin or sc_admin role.
Amazon Kinesis Firehose requirements
The Splunk Add-on for Amazon Kinesis Firehose requires specific configuration in Amazon Kinesis Firehose. See What is Amazon Kinesis Firehose? in the AWS documentation.
Event formatting requirements
The Splunk Add-on for Amazon Kinesis Firehose supports data collection using either of the two HTTP Event Collector endpoint types: raw and event. If you collect data using the raw endpoint, no special formatting is required for most source types. The
aws:cloudwatchlogs:vpcflow contains a nested events JSON array that cannot be parsed by the HTTP Event Collector. Prepare this data for the Splunk platform using an AWS Lambda function that extracts the nested JSON events correctly into a newline-delimited set of events. All other source types can be sent directly to the raw endpoint without any preprocessing.
If you collect data using the event endpoint, format your events into the JSON format expected by HTTP Event Collector before sending them from Amazon Kinesis Firehose to the Splunk platform. You can apply an AWS Lambda blueprint to preprocess your events into the JSON structure and set event-specific fields, which allows you greater control over how your events are handled by the Splunk platform. For example, you can create and apply a Lambda blueprint that sends data from the same Firehose stream to different indexes depending on event type.
For information about the required JSON structure, see Format events for HTTP Event Collector.
Release history for the Splunk Add-on for Amazon Kinesis Firehose
Installation and configuration overview for the Splunk Add-on for Amazon Kinesis Firehose
This documentation applies to the following versions of Splunk® Supported Add-ons: released, released