Skip to content

output-sqs.asciidoc

Latest commit

 

History

History
264 lines (191 loc) · 9.04 KB

output-sqs.asciidoc

File metadata and controls

264 lines (191 loc) · 9.04 KB
Raw

Sqs output plugin

Description

Push 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

This 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.

Warning
 This output cannot currently handle messages larger than 256KiB. Any single message exceeding this size will be dropped.

Sqs Output Configuration Options

This plugin supports the following configuration options plus the [plugins-outputs-sqs-common-options] described later.

Setting Input type Required

access_key_id

string

No

aws_credentials_file

string

No

batch_events

number

No

endpoint

string

No

message_max_size

bytes

No

proxy_uri

string

No

queue

string

Yes

queue_owner_aws_account_id

string

No

region

string

No

role_arn

string

No

role_session_name

string

No

secret_access_key

string

No

session_token

string

No

use_aws_bundled_ca

boolean

No

web_identity_token_file

string

No

Also see [plugins-outputs-sqs-common-options] for a list of options supported by all output plugins.

 

access_key_id

  • 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:

  1. Static configuration, using access_key_id and secret_access_key params in logstash plugin config

  2. External credentials file specified by aws_credentials_file

  3. Environment variables AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY

  4. Environment variables AMAZON_ACCESS_KEY_ID and AMAZON_SECRET_ACCESS_KEY

  5. IAM Instance Profile (available when running inside EC2)

aws_credentials_file

  • 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

  • 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

  • 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

  • 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

  • Value type is string

  • There is no default value for this setting.

URI to proxy server if required

queue

  • 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

  • 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.

region

  • Value type is string

  • Default value is "us-east-1"

The AWS Region

role_arn

  • 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

  • Value type is string

  • Default value is "logstash"

Session name to use when assuming an IAM role.

secret_access_key

  • Value type is string

  • There is no default value for this setting.

The AWS Secret Access Key

session_token

  • Value type is string

  • There is no default value for this setting.

The AWS Session token for temporary credential

use_aws_bundled_ca

  • Value type is boolean

  • Default value is false

Use bundled CA certificates that ship with AWS SDK to verify SSL peer certificates. For cases where the default certificates are unavailable, e.g. Windows, you can set this to true.

web_identity_token_file

Absolute path to the file on disk containing OIDC token for IRSA. Set the path to "/var/run/secrets/eks.amazonaws.com/serviceaccount/token" when using Amazon EKS. If specified, role_arn must not be empty.

For the details of setting up IAM roles and Kubernetes service accounts, check out userguide

../../../../logstash/docs/include/output.asciidoc