sqs
editsqs
editPull events from an Amazon Web Services Simple Queue Service (SQS) queue.
SQS is a simple, scalable queue system that is part of the Amazon Web Services suite of tools.
Although SQS is similar to other queuing systems like AMQP, it uses a custom API and requires that you have an AWS account. See http://aws.amazon.com/sqs/ for more details on how SQS works, what the pricing schedule looks like and how to setup a queue.
To use this plugin, you must:
- Have an AWS account
- Setup an SQS queue
- Create an identify that has access to consume messages from the queue.
The "consumer" identity must have the following permissions on the queue:
-
sqs:ChangeMessageVisibility
-
sqs:ChangeMessageVisibilityBatch
-
sqs:DeleteMessage
-
sqs:DeleteMessageBatch
-
sqs:GetQueueAttributes
-
sqs:GetQueueUrl
-
sqs:ListQueues
-
sqs:ReceiveMessage
Typically, you should setup an IAM policy, create a user and apply the IAM policy to the user. A sample policy is as follows:
{ "Statement": [ { "Action": [ "sqs:ChangeMessageVisibility", "sqs:ChangeMessageVisibilityBatch", "sqs:GetQueueAttributes", "sqs:GetQueueUrl", "sqs:ListQueues", "sqs:SendMessage", "sqs:SendMessageBatch" ], "Effect": "Allow", "Resource": [ "arn:aws:sqs:us-east-1:123456789012:Logstash" ] } ] }
See http://aws.amazon.com/iam/ for more details on setting up AWS identities.
Synopsis
editThis plugin supports the following configuration options:
Required configuration options:
sqs { queue => ... }
Available configuration options:
Setting | Input type | Required | Default value |
---|---|---|---|
No |
|||
No |
|
||
No |
|||
No |
|
||
No |
|||
No |
|||
No |
|
||
No |
|||
Yes |
|||
string, one of |
No |
|
|
No |
|||
No |
|||
No |
|||
No |
|||
No |
|
||
No |
Details
edit
access_key_id
edit- Value type is string
- There is no default value for this setting.
This plugin uses the AWS SDK and supports several ways to get credentials, which will be tried in this order:
-
Static configuration, using
access_key_id
andsecret_access_key
params in logstash plugin config -
External credentials file specified by
aws_credentials_file
-
Environment variables
AWS_ACCESS_KEY_ID
andAWS_SECRET_ACCESS_KEY
-
Environment variables
AMAZON_ACCESS_KEY_ID
andAMAZON_SECRET_ACCESS_KEY
- IAM Instance Profile (available when running inside EC2)
aws_credentials_file
edit- Value type is string
- There is no default value for this setting.
Path to YAML file containing a hash of AWS credentials.
This file will only be loaded if access_key_id
and
secret_access_key
aren’t set. The contents of the
file should look like this:
:access_key_id: "12345" :secret_access_key: "54321"
codec
edit- Value type is codec
-
Default value is
"json"
The codec used for input data. Input codecs are a convenient method for decoding your data before it enters the input, without needing a separate filter in your Logstash pipeline.
id_field
edit- Value type is string
- There is no default value for this setting.
Name of the event field in which to store the SQS message ID
md5_field
edit- Value type is string
- There is no default value for this setting.
Name of the event field in which to store the SQS message MD5 checksum
polling_frequency
edit- Value type is number
-
Default value is
20
Polling frequency, default is 20 seconds
proxy_uri
edit- Value type is string
- There is no default value for this setting.
URI to proxy server if required
queue
edit- This is a required setting.
- Value type is string
- There is no default value for this setting.
Name of the SQS Queue name to pull messages from. Note that this is just the name of the queue, not the URL or ARN.
region
edit-
Value can be any of:
us-east-1
,us-west-1
,us-west-2
,eu-central-1
,eu-west-1
,ap-southeast-1
,ap-southeast-2
,ap-northeast-1
,sa-east-1
,us-gov-west-1
,cn-north-1
-
Default value is
"us-east-1"
secret_access_key
edit- Value type is string
- There is no default value for this setting.
The AWS Secret Access Key
sent_timestamp_field
edit- Value type is string
- There is no default value for this setting.
Name of the event field in which to store the SQS message Sent Timestamp
session_token
edit- Value type is string
- There is no default value for this setting.
The AWS Session token for temporary credentials
tags
edit- Value type is array
- There is no default value for this setting.
Add any number of arbitrary tags to your event.
This can help with processing later.
type
edit- Value type is string
- There is no default value for this setting.
Add a type
field to all events handled by this input.
Types are used mainly for filter activation.
The type is stored as part of the event itself, so you can also use the type to search for it in Kibana.
If you try to set a type on an event that already has one (for example when you send an event from a shipper to an indexer) then a new input will not override the existing type. A type set at the shipper stays with that event for its life even when sent to another Logstash server.