Amazon S3 data input configuration fields
Description of the fields on the Amazon S3 data input configuration form.
Basic configuration
| Field | Description |
|---|---|
| Name | Name of the new data input. This field is required. |
| Description | Description of the data input. |
| Execute on | Option to select whether to use a specific MID Server or a MID Server cluster. This field is required. |
| MID |
(Only when the Execute on field is set to Specific MID Server) MID Server to which log data from Amazon S3 is pulled.Remarque : This field is required.
|
| MID Server Cluster | (Only when Execute on is set to Specific MID Server cluster.) The MID Server cluster to which the log data is pulled. This field is required.The data input runs on a single MID Server in the cluster until that MID Server fails. The system then moves all the data input tasks to the next available MID Server in the cluster according to the configured order. Remarque : For more information about MID Server clusters, see Configure a MID Server cluster.
|
| Service instance | The service instance to which to bind the log data. Remarque : This field is required.If no relevant
service instance exists, Create an service instance and add CIs to it. Set the status of the new service instance to
Operational. |
The following fields show read-only information:
| Field | Description |
|---|---|
| Status | Status of the data input. |
| Transport | Protocol used to stream the log data. This data input uses Amazon S3 to stream log data to your instance. |
| Sources count | The number of log sources this data input has created. |
| Disabled since | Time when the data input stopped or failed. |
| Last log time | Time when the last log streamed in the data input. |
| Error message | The streaming error. This field is populated automatically. It displays only when a streaming error has occurred. |
| Field | Description | Example |
|---|---|---|
| From/To | Starting and ending dates and time for reading the data.
|
From: Now -1 week To: 2300-01-01 15:59:59 |
| Bucket name | The Amazon S3 bucket to stream. This field is required. |
my-s3-bucket |
| Prefix | Prefix for the objects to be fetched. The data input fetches only objects that begin with this prefix. This field is typically used to fetch only specific folders in a bucket. | /only/this/folder/ |
| Include | File or object to include when the system performs pattern matching. | .*include-me.* |
| Exclude | File or object to exclude when the system performs pattern matching. | .*skip-me.* |
| Field | Description |
|---|---|
| AWS credentials | Field that refers to the AWS Credentials list (aws_credentials.list). The list contains the AWS access and secret access keys. |
| AWS region | The AWS region where the Amazon S3 bucket is located, for
example, us-west-1. For a list of AWS regions, see https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions This field is required. |
Advanced configuration
| Field | Description | Default value |
|---|---|---|
| Anonymous | Option to force accessing the Amazon S3 bucket without credentials, while ignoring default credentials if they exist. | False |
| Traverse | Option to access each directory in the bucket. | False |
| Object sorted by Last Modified Time | Option to fetch objects if the objects in the bucket are sorted by time. | False |
| Connection timeout | The number of milliseconds to wait before timing out the attempt to establish a connection to AWS. | 100 |
| Threadpool size | The number of concurrent threads that are downloading files from the bucket. | 1 |
| Buffer size | Size of the download buffer, in bytes. | 100MB |
| Socket timeout | The number of milliseconds to wait before timing out data transfer over an established connection. | 10000 |
| Max retry for file | The maximum number of times to retry file processing in case of failure. | 10 |
| Default timezone | The default timezone if the log doesn't include timezone information. | UTC |
| Sub sample drop ratio | The number of events to batch together, out of which one will be discarded. This setting is used to reduce the number of fetched events. | -1 |
| Sub sample receive ratio | The number of events to batch together, out of which all but one will be discarded. This setting is used to decrease the number of received events. | -1 |
| Rate limit | The maximum number of events per second that this data input processes. | -1 |
| Max length in bytes | The maximum length, in bytes, of events. | 32766 |
| Character encoding | The character encoding for this data input. | UTF-8 |
| Sleep interval | The interval, in seconds, to wait before querying again after a query has returned no events. | 60 |
| Polling interval | The interval, in seconds, to wait before polling for new events. | 0 |
| Drop if queue is full | Option to discard logs if there is a load on the MID Server. | False |