Sqs output plugin v7.1.8
editSqs output plugin v7.1.8
edit- A component of the aws integration plugin
- Integration version: v7.1.8
- Released on: 2024-07-26
- Changelog
For other versions, see the overview list.
To learn more about Logstash, see the Logstash Reference.
Getting help
editFor questions about the plugin, open a topic in the Discuss forums. For bugs or feature requests, open an issue in Github. For the list of Elastic supported plugins, please consult the Elastic Support Matrix.
Description
editPush events to an Amazon Web Services (AWS) 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 such as Advanced Message Queuing Protocol (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.
The "consumer" identity must have the following permissions on the queue:
-
sqs:GetQueueUrl
-
sqs:SendMessage
-
sqs:SendMessageBatch
Typically, you should setup an IAM policy, create a user and apply the IAM policy to the user. See http://aws.amazon.com/iam/ for more details on setting up AWS identities. A sample policy is as follows:
{ "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "sqs:GetQueueUrl", "sqs:SendMessage", "sqs:SendMessageBatch" ], "Resource": "arn:aws:sqs:us-east-1:123456789012:my-sqs-queue" } ] }
Batch Publishing
editThis output publishes messages to SQS in batches in order to optimize event
throughput and increase performance. This is done using the
[SendMessageBatch
](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/APIReference/API_SendMessageBatch.html)
API. When publishing messages to SQS in batches, the following service limits
must be respected (see
[Limits in Amazon SQS](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-messages.html)):
- The maximum allowed individual message size is 256KiB.
- The maximum total payload size (i.e. the sum of the sizes of all individual messages within a batch) is also 256KiB.
This plugin will dynamically adjust the size of the batch published to SQS in order to ensure that the total payload size does not exceed 256KiB.
This output cannot currently handle messages larger than 256KiB. Any single message exceeding this size will be dropped.
Sqs Output Configuration Options
editThis plugin supports the following configuration options plus the Common options described later.
Setting | Input type | Required |
---|---|---|
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
Yes |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
||
No |
Also see Common options for a list of options supported by all output plugins.
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"
batch_events
edit- Value type is number
-
Default value is
10
The number of events to be sent in each batch. Set this to 1
to disable
the batch sending of messages.
endpoint
edit- Value type is string
- There is no default value for this setting.
The endpoint to connect to. By default it is constructed using the value of region
.
This is useful when connecting to S3 compatible services, but beware that these aren’t
guaranteed to work correctly with the AWS SDK.
message_max_size
edit- Value type is bytes
-
Default value is
"256KiB"
The maximum number of bytes for any message sent to SQS. Messages exceeding this size will be dropped. See http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/limits-messages.html.
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.
The name of the target SQS queue. Note that this is just the name of the queue, not the URL or ARN.
queue_owner_aws_account_id
edit- Value type is string
- There is no default value for this setting.
The owning account id of the target SQS queue. IAM permissions need to be configured on both accounts to function.
role_arn
edit- Value type is string
- There is no default value for this setting.
The AWS IAM Role to assume, if any. This is used to generate temporary credentials, typically for cross-account access. See the AssumeRole API documentation for more information.
role_session_name
edit- Value type is string
-
Default value is
"logstash"
Session name to use when assuming an IAM role.
secret_access_key
edit- Value type is string
- There is no default value for this setting.
The AWS Secret Access Key
Common options
editThese configuration options are supported by all output plugins:
Setting | Input type | Required |
---|---|---|
No |
||
No |
enable_metric
edit- Value type is boolean
-
Default value is
true
Disable or enable metric logging for this specific plugin instance. By default we record all the metrics we can, but you can disable metrics collection for a specific plugin.
id
edit- Value type is string
- There is no default value for this setting.
Add a unique ID
to the plugin configuration. If no ID is specified, Logstash will generate one.
It is strongly recommended to set this ID in your configuration. This is particularly useful
when you have two or more plugins of the same type. For example, if you have 2 sqs outputs.
Adding a named ID in this case will help in monitoring Logstash when using the monitoring APIs.
output { sqs { id => "my_plugin_id" } }