Configure inputs for the Splunk Add-on for AWS
SQS-based S3 is the recommended input type for collecting a variety of pre-defined data types:
- CloudFront Access Logs
- ELB Access logs
- S3 Access Logs
- Custom data types.
Configure SQS-based S3 inputs to collect the data types that it supports.
Before you configure SQS-based S3 inputs, configure S3 to send notifications to SQS through SNS. This lets S3 notify the add-on that new events were written to the S3 bucket.
Keep the following in mind as you configure your inputs:
- The SQS-based S3 input only collects in AWS service logs that meet the following criteria:
- near-real time
- newly created
- stored into S3 buckets
- have event notifications sent to SQS
Events that occurred in the past or events with no notifications sent through SNS to SQS are not collected. To collect historical logs stored into S3 buckets, use the generic S3 input instead. The S3 input lets you set the initial scan time parameter (log start date) to collect data generated after a specified time in the past.
- To collect the same types of logs from multiple S3 buckets, even across regions, set up one input to collect data from all the buckets. To do this, configure these buckets to send notifications to the same SQS queue from which the SQS-based S3 input polls message.
- To achieve high throughput data ingestion from an S3 bucket, configure multiple SQS-based S3 inputs for the S3 bucket to scale out data collection.
- After configuring an SQS-based S3 input, you might need to wait for a few minutes before new events are ingested and can be searched. Also, a more verbose logging level causes longer data digestion time. Debug mode is extremely verbose and is not recommended on production systems.
- The SQS-based input allows you to ingest data from S3 buckets by optimizing the API calls made by the add-on and relying on SQS/SNS to collect events upon receipt of notification.
- The SQS-based S3 input is stateless, which means that when multiple inputs are collecting data from the same bucket, if one input goes down, the other inputs continue to collect data and take over the load from the failed input. This lets you enhance fault tolerance by configuring multiple inputs to collect data from the same bucket.
Input configuration overview
You can use the Splunk Add-on for AWS to collect data from AWS. For each supported data type, one or more input types are provided for data collection.
Follow these steps to plan and perform your AWS input configuration:
Users adding new inputs must have the
admin_all_objects role enabled.
- Click input type to go to the input configuration details.
- Follow the steps described in the input configuration details to complete the configuration.
Configure an SQS-based S3 input using Splunk Web
To configure inputs in Splunk Web, click Splunk Add-on for AWS in the left navigation bar on Splunk Web home, then choose one of the following menu paths depending on which data type you want to collect:
- Create New Input > CloudTrail > SQS-based S3
- Create New Input > CloudFront Access Log > SQS-based S3
- Create New Input > Config > SQS-based S3
- Create New Input > ELB Access Logs > SQS-based S3
- Create New Input > S3 Access Logs > SQS-based S3
- Create New Input > Others > SQS-based S3
You must have the
admin_all_objects role enabled in order to add new inputs.
Choose the menu path that corresponds to the data type you want to collect. The system will automatically set the source type and display relevant field settings in the subsequent configuration page.
|Argument||Corresponding Field in Splunk Web||Description|
||AWS Account||The AWS account or EC2 IAM role the Splunk platform uses to access the keys in your S3 buckets. In Splunk Web, select an account from the drop-down list. In |
Note: If the region of the AWS account you select is GovCloud, you may encounter errors like Failed to load options for S3 Bucket. You need to manually add AWS GovCloud Endpoint in the S3 Host Name field. See http://docs.aws.amazon.com/govcloud-us/latest/UserGuide/using-govcloud-endpoints.html for more information.
||Assume Role||The IAM role to assume, see Manage IAM roles.|
||AWS Region||AWS region that the SQS queue is in e.g. us-east-1.|
||SQS Queue||The SQL queue URL.|
||SQS Batch Size||The maximum number of messages to pull from the SQS queue in one batch. Enter an integer between 1 and 10 inclusive. Splunk recommends that you set a larger value for small files, and a smaller value for large files. The default SQS batch size is 10. If you are dealing with large files and your system memory is limited, set this to a smaller value.|
||S3 File Decoder||The decoder to use to parse the corresponding log files. The decoder is set according to the Data Type you select. If you select a Custom Data Type, choose one from |
||Source Type||The source type for the events to collect, automatically filled in based on the decoder chosen for the input.|
||Interval||The length of time in seconds between two data collection runs. The default is 300 seconds.|
||Index||The index name where the Splunk platform should put the SQS-based S3 data. The default is main.|
Configure an SQS-based S3 input using the configuration file
When you configure inputs manually in
inputs.conf, create a stanza using the following template and add it to
$SPLUNK_HOME/etc/apps/Splunk_TA_aws/local/inputs.conf. If the file or path does not exist, create it.
You can configure the parameters below.
[aws_sqs_based_s3://<stanza_name>] aws_account = <value> interval = <value> s3_file_decoder = <value> sourcetype = <value> sqs_batch_size = <value> sqs_queue_region = <value> sqs_queue_url = <value>
Valid values for
s3_file_decoder are: CloudTrail, Config, S3 Access Logs, ELB Access Logs, CloudFront Access Logs, and CustomLogs.
If you want to ingest custom logs other the natively supported AWS log types, you must set
s3_file_decoder = CustomLogs. This lets you ingest custom logs into Splunk but does not parse the data. To process custom logs into meaningful events, you need to perform additional configurations in
transforms.conf to parse the collected data to meet your specific requirements.
For more information on these settings, see
/README/inputs.conf.spec under your add-on directory.
Configure data collection on your Splunk Enterprise instance
Validate your data
This documentation applies to the following versions of Splunk® Enterprise: 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 8.0.0