The AWS SQS integration allows you to monitor Amazon Simple Queue Service (Amazon SQS)—a managed message queuing service.

Use the AWS SQS integration to view metrics on messages sent, stored, and received via Amazon SQS. Then visualize that data in Kibana, create alerts to notify you if something goes wrong, and reference metrics when troubleshooting an issue.

For example, you could track the number of messages in the queue that are delayed and not available for reading immediately. Then create an alert to be notified if the queue reaches a certain size.

IMPORTANT: Extra AWS charges on AWS API requests will be generated by this integration. Please refer to the AWS integration for more details.

Data streams

The SQS integration collects one type of data: metrics.

Metrics give you insight into the state of AWS SQS. Metrics collected by the AWS SQS integration include the number of messages that are in flight, the number of ReceiveMessage API calls that did not return a message, and more. See more details in the Metrics reference.

Requirements

You need Elasticsearch for storing and searching your data and Kibana for visualizing and managing it. You can use our hosted Elasticsearch Service on Elastic Cloud, which is recommended, or self-manage the Elastic Stack on your own hardware.

Before using any AWS integration you will need:

• AWS Credentials to connect with your AWS account.
• AWS Permissions to make sure the user you're using to connect has permission to share the relevant data.

For more details about these requirements, please take a look at the AWS integration documentation.

Setup

Use this integration if you only need to collect data from the AWS SQS service.

If you want to collect data from two or more AWS services, consider using the AWS integration. When you configure the AWS integration, you can collect data from as many AWS services as you'd like.

For step-by-step instructions on how to set up an integration, see the Getting started guide.

Metrics reference

An example event for sqs looks as following:

{
    "@timestamp": "2022-07-26T21:43:00.000Z",
    "agent": {
        "name": "docker-fleet-agent",
        "id": "2d4b09d0-cdb6-445e-ac3f-6415f87b9864",
        "type": "metricbeat",
        "ephemeral_id": "cdaaaabb-be7e-432f-816b-bda019fd7c15",
        "version": "8.3.2"
    },
    "elastic_agent": {
        "id": "2d4b09d0-cdb6-445e-ac3f-6415f87b9864",
        "version": "8.3.2",
        "snapshot": false
    },
    "cloud": {
        "provider": "aws",
        "region": "eu-central-1",
        "account": {
            "name": "elastic-beats",
            "id": "428152502467"
        }
    },
    "ecs": {
        "version": "8.0.0"
    },
    "service": {
        "type": "aws"
    },
    "data_stream": {
        "namespace": "default",
        "type": "metrics",
        "dataset": "aws.sqs"
    },
    "metricset": {
        "period": 300000,
        "name": "cloudwatch"
    },
    "aws": {
        "sqs": {
            "messages": {
                "visible": 1518.4,
                "deleted": 0,
                "not_visible": 0,
                "delayed": 0,
                "received": 0,
                "sent": 0.16666666666666666
            },
            "empty_receives": 0,
            "sent_message_size": {
                "bytes": 1002
            },
            "oldest_message_age": {
                "sec": 345605.6
            },
            "queue": {
                "name": "filebeat-aws-elb-test"
            }
        },
        "cloudwatch": {
            "namespace": "AWS/SQS"
        },
        "dimensions": {
            "QueueName": "filebeat-aws-elb-test"
        },
        "tags": {
            "created-by": "kaiyan"
        }
    },
    "event": {
        "duration": 11576777300,
        "agent_id_status": "verified",
        "ingested": "2022-07-26T21:47:48Z",
        "module": "aws",
        "dataset": "aws.sqs"
    }
}

Exported fields

Changelog