Overview
Amazon Simple Queue Service (SQS) is a fast, reliable, scalable, fully managed message queuing service.
Enable this integration to see all your SQS metrics in Datadog.
Setup
Installation
If you haven’t already, set up the Amazon Web Services integration first.
Metric collection
In the AWS integration page, ensure that SQS is enabled under the Metric Collection tab.
Add these permissions to your Datadog IAM policy in order to collect Amazon SQS metrics:
sqs:ListQueues: Used to list alive queues.tag:GetResources: Get custom tags applied to SQS queues.
For more information, see the SQS policies on the AWS website.
Install the Datadog - Amazon SQS integration.
Log collection
Enable SQS logging
See Logging Amazon SQS API Calls Using AWS CloudTrail to configure your trail. When you define your trails, select a S3 bucket to write the logs in:
Send logs to Datadog
- If you haven’t already, set up the Datadog log collection AWS Lambda function.
- Once the lambda function is installed, manually add a trigger on the S3 bucket that contains your Amazon SQS logs in the AWS console. In your Lambda, click on S3 in the trigger list:
Configure your trigger by choosing the S3 bucket that contains your Amazon SQS logs and change the event type to Object Created (All) then click on the add button.
Once the trigger has been added, use the Datadog Log Explorer to view your logs.
Data Collected
Metrics
| |
|---|
aws.sqs.approximate_age_of_oldest_message
(gauge) | The approximate age of the oldest non-deleted message in the queue.
Shown as second |
aws.sqs.approximate_number_of_messages_delayed
(gauge) | The number of messages in the queue that are delayed and not available for reading immediately. This can happen when the queue is configured as a delay queue or when a message has been sent with a delay parameter.
Shown as message |
aws.sqs.approximate_number_of_messages_not_visible
(gauge) | The number of messages that are in flight. Messages are considered in flight if they have been sent to a client but have not yet been deleted or have not yet reached the end of their visibility window.
Shown as message |
aws.sqs.approximate_number_of_messages_visible
(gauge) | The number of messages available for retrieval from the queue.
Shown as message |
aws.sqs.number_of_empty_receives
(count) | The number of ReceiveMessage API calls that did not return a message.
Shown as message |
aws.sqs.number_of_messages_deleted
(count) | The number of messages deleted from the queue.
Shown as message |
aws.sqs.number_of_messages_received
(count) | The number of messages returned by calls to the ReceiveMessage API action.
Shown as message |
aws.sqs.number_of_messages_sent
(count) | The number of messages added to a queue.
Shown as message |
aws.sqs.sent_message_size
(gauge) | The size of messages added to a queue.
Shown as byte |
Each of the metrics retrieved from AWS are assigned the same tags that appear in the AWS console, including, but not limited to, host name, security-groups, and more.
Events
The Amazon SQS integration does not include any events.
Service Checks
The Amazon SQS integration does not include any service checks.
Out-of-the-box monitoring
The Amazon SQS integration provides ready-to-use monitoring capabilities to monitor and optimize performance.
Troubleshooting
Need help? Contact Datadog support.
