Amazon SQS
Collect Amazon SQS metrics with Elastic Agent
Version | 2.24.0 (View all) |
Compatible Kibana version(s) | 8.14.0 or higher |
Supported Serverless project types | Security Observability |
Subscription level | Basic |
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": {
"ephemeral_id": "cdaaaabb-be7e-432f-816b-bda019fd7c15",
"id": "2d4b09d0-cdb6-445e-ac3f-6415f87b9864",
"name": "docker-fleet-agent",
"type": "metricbeat",
"version": "8.3.2"
},
"aws": {
"cloudwatch": {
"namespace": "AWS/SQS"
},
"dimensions": {
"QueueName": "filebeat-aws-elb-test"
},
"sqs": {
"empty_receives": 0,
"messages": {
"delayed": 0,
"deleted": 0,
"not_visible": 0,
"received": 0,
"sent": 0.16666666666666666,
"visible": 1518.4
},
"oldest_message_age": {
"sec": 345605.6
},
"queue": {
"name": "filebeat-aws-elb-test"
},
"sent_message_size": {
"bytes": 1002
}
},
"tags": {
"created-by": "kaiyan"
}
},
"cloud": {
"account": {
"id": "428152502467",
"name": "elastic-beats"
},
"provider": "aws",
"region": "eu-central-1"
},
"data_stream": {
"dataset": "aws.sqs",
"namespace": "default",
"type": "metrics"
},
"ecs": {
"version": "8.11.0"
},
"elastic_agent": {
"id": "2d4b09d0-cdb6-445e-ac3f-6415f87b9864",
"snapshot": false,
"version": "8.3.2"
},
"event": {
"agent_id_status": "verified",
"dataset": "aws.sqs",
"duration": 11576777300,
"ingested": "2022-07-26T21:47:48Z",
"module": "aws"
},
"metricset": {
"name": "cloudwatch",
"period": 300000
},
"service": {
"type": "aws"
}
}
ECS Field Reference
Please refer to the following document for detailed information on ECS fields.
Exported fields
Field | Description | Type | Metric Type |
---|---|---|---|
@timestamp | Event timestamp. | date | |
agent.id | Unique identifier of this agent (if one exists). Example: For Beats this would be beat.id. | keyword | |
aws.cloudwatch.namespace | The namespace specified when query cloudwatch api. | keyword | |
aws.dimensions.QueueName | SQS queue name | keyword | |
aws.sqs.empty_receives | The total number of ReceiveMessage API calls that did not return a message. | long | gauge |
aws.sqs.messages.delayed | The average number of messages in the queue that are delayed and not available for reading immediately. | long | gauge |
aws.sqs.messages.deleted | The total number of messages deleted from the queue. | long | gauge |
aws.sqs.messages.not_visible | The average number of messages that are in flight. | long | gauge |
aws.sqs.messages.received | The total number of messages returned by calls to the ReceiveMessage action. | long | gauge |
aws.sqs.messages.sent | The total number of messages added to a queue. | long | gauge |
aws.sqs.messages.visible | The average number of messages available for retrieval from the queue. | long | gauge |
aws.sqs.oldest_message_age.sec | The maximum approximate age of the oldest non-deleted message in the queue. | long | gauge |
aws.sqs.queue.name | SQS queue name | keyword | |
aws.sqs.sent_message_size.bytes | The average size of messages added to a queue. | long | gauge |
aws.tags | Tag key value pairs from aws resources. | flattened | |
cloud.account.id | The cloud account or organization id used to identify different entities in a multi-tenant environment. Examples: AWS account id, Google Cloud ORG Id, or other unique identifier. | keyword | |
cloud.image.id | Image ID for the cloud instance. | keyword | |
cloud.region | Region in which this host, resource, or service is located. | keyword | |
data_stream.dataset | Data stream dataset. | constant_keyword | |
data_stream.namespace | Data stream namespace. | constant_keyword | |
data_stream.type | Data stream type. | constant_keyword | |
event.module | Event module | constant_keyword | |
host.containerized | If the host is a container. | boolean | |
host.os.build | OS build information. | keyword | |
host.os.codename | OS codename, if any. | keyword |
Changelog
Version | Details | Kibana version(s) |
---|---|---|
2.24.0 | Enhancement View pull request | 8.14.0 or higher |
2.23.0 | Enhancement View pull request | 8.14.0 or higher |
2.22.1 | Bug fix View pull request | 8.14.0 or higher |
2.22.0 | Enhancement View pull request | 8.14.0 or higher |
2.21.0 | Enhancement View pull request | 8.14.0 or higher |
2.20.0 | Enhancement View pull request | 8.14.0 or higher |
2.19.0 | Enhancement View pull request | 8.14.0 or higher |
2.18.0 | Enhancement View pull request | 8.14.0 or higher |
2.17.0 | Enhancement View pull request | 8.13.0 or higher |
2.16.0 | Enhancement View pull request | 8.12.0 or higher |
2.15.4 | Bug fix View pull request | 8.12.0 or higher |
2.15.3 | Enhancement View pull request | 8.12.0 or higher |
2.15.2 | Bug fix View pull request | 8.12.0 or higher |
2.15.1 | Bug fix View pull request | 8.12.0 or higher |
2.15.0 | Enhancement View pull request | 8.12.0 or higher |
2.14.2 | Bug fix View pull request | 8.12.0 or higher |
2.14.1 | Enhancement View pull request | 8.12.0 or higher |
2.14.0 | Enhancement View pull request | 8.12.0 or higher |
2.13.1 | Enhancement View pull request | 8.12.0 or higher |
2.13.0 | Enhancement View pull request | 8.12.0 or higher |
2.12.2 | Bug fix View pull request | 8.12.0 or higher |
2.12.1 | Enhancement View pull request | 8.12.0 or higher |
2.12.0 | Enhancement View pull request | 8.12.0 or higher |
2.11.3 | Bug fix View pull request | 8.10.2 or higher |
2.11.2 | Bug fix View pull request | 8.10.2 or higher |
2.11.1 | Enhancement View pull request | 8.10.2 or higher |
2.11.0 | Enhancement View pull request | 8.10.2 or higher |
2.10.2 | Bug fix View pull request | 8.10.2 or higher |
2.10.1 | Bug fix View pull request | 8.10.2 or higher |
2.10.0 | Enhancement View pull request | 8.10.2 or higher |
2.9.1 | Bug fix View pull request | 8.9.0 or higher |
2.9.0 | Enhancement View pull request | 8.9.0 or higher |
2.8.6 | Bug fix View pull request | 8.9.0 or higher |
2.8.5 | Enhancement View pull request | 8.9.0 or higher |
2.8.4 | Bug fix View pull request | 8.9.0 or higher |
2.8.3 | Bug fix View pull request | 8.9.0 or higher |
2.8.2 | Bug fix View pull request | 8.9.0 or higher |
2.8.1 | Bug fix View pull request | 8.9.0 or higher |
2.8.0 | Enhancement View pull request | 8.9.0 or higher |
2.7.0 | Enhancement View pull request | 8.9.0 or higher |
2.6.1 | Bug fix View pull request | 8.9.0 or higher |
2.6.0 | Enhancement View pull request | 8.9.0 or higher |
2.5.0 | Enhancement View pull request | 8.9.0 or higher |
2.4.1 | Bug fix View pull request | 8.9.0 or higher |
2.4.0 | Bug fix View pull request | 8.9.0 or higher |
2.3.0 | Enhancement View pull request | 8.9.0 or higher |
2.2.1 | Bug fix View pull request | 8.9.0 or higher |
2.2.0 | Enhancement View pull request | 8.9.0 or higher |
2.1.2 | Bug fix View pull request | 8.9.0 or higher |
2.1.1 | Enhancement View pull request | 8.9.0 or higher |
2.1.0 | Enhancement View pull request | 8.9.0 or higher |
2.0.0 | Enhancement View pull request | 8.9.0 or higher |
1.53.5 | Enhancement View pull request | 8.9.0 or higher |
1.53.4 | Enhancement View pull request | 8.9.0 or higher |
1.53.3 | Enhancement View pull request | 8.9.0 or higher |
1.53.2 | Bug fix View pull request | 8.9.0 or higher |
1.53.1 | Enhancement View pull request | 8.9.0 or higher |
1.53.0 | Enhancement View pull request | 8.9.0 or higher |
1.52.1 | Enhancement View pull request | 8.9.0 or higher |
1.52.0 | Enhancement View pull request | 8.9.0 or higher |
1.51.3 | Bug fix View pull request | 8.8.1 or higher |
1.51.2 | Enhancement View pull request | 8.8.1 or higher |
1.51.1 | Enhancement View pull request | 8.8.1 or higher |
1.51.0 | Enhancement View pull request | 8.8.1 or higher |
1.50.6 | Enhancement View pull request | 8.8.1 or higher |
1.50.5 | Enhancement View pull request | 8.8.1 or higher |
1.50.4 | Enhancement View pull request | 8.8.1 or higher |
1.50.3 | Enhancement View pull request | 8.8.1 or higher |
1.50.2 | Enhancement View pull request | 8.8.1 or higher |
1.50.1 | Enhancement View pull request | 8.8.1 or higher |
1.50.0 | Enhancement View pull request | 8.8.1 or higher |
1.49.0 | Enhancement View pull request | 8.8.1 or higher |
1.48.0 | Enhancement View pull request | 8.8.1 or higher |
1.47.1 | Enhancement View pull request | 8.8.1 or higher |
1.47.0 | Enhancement View pull request | 8.8.1 or higher |
1.46.9 | Enhancement View pull request | 8.8.1 or higher |
1.46.8 | Enhancement View pull request | 8.8.1 or higher |
1.46.7 | Enhancement View pull request | 8.8.1 or higher |
1.46.6 | Enhancement View pull request | 8.8.1 or higher |
1.46.5 | Enhancement View pull request | 8.8.1 or higher |
1.46.4 | Enhancement View pull request | — |
1.46.3 | Enhancement View pull request | 8.8.1 or higher |
1.46.2 | Enhancement View pull request | 8.8.1 or higher |
1.46.1 | Enhancement View pull request | 8.8.1 or higher |
1.46.0 | Enhancement View pull request | 8.8.1 or higher |
1.45.9 | Enhancement View pull request | 8.8.1 or higher |
1.45.8 | Enhancement View pull request | 8.8.1 or higher |
1.45.7 | Enhancement View pull request | 8.8.1 or higher |
1.45.6 | Enhancement View pull request | 8.8.1 or higher |
1.45.4 | Enhancement View pull request | 8.8.1 or higher |
1.45.3 | Bug fix View pull request | 8.8.1 or higher |
1.45.2 | Enhancement View pull request | 8.8.1 or higher |
1.45.1 | Enhancement View pull request | 8.8.1 or higher |
1.45.0 | Enhancement View pull request | 8.8.1 or higher |
1.44.4 | Enhancement View pull request | 8.8.1 or higher |
1.44.3 | Enhancement View pull request | 8.8.1 or higher |
1.44.2 | Bug fix View pull request | 8.8.1 or higher |
1.44.1 | Enhancement View pull request | 8.8.1 or higher |
1.44.0 | Enhancement View pull request | 8.8.1 or higher |
1.43.2 | Enhancement View pull request | 8.8.1 or higher |
1.43.1 | Enhancement View pull request | 8.8.1 or higher |
1.43.0 | Enhancement View pull request | 8.8.1 or higher |
1.42.0 | Enhancement View pull request | 8.7.1 or higher |
1.41.0 | Enhancement View pull request | 8.7.1 or higher |
1.40.9 | Enhancement View pull request | 8.7.1 or higher |
1.40.8 | Enhancement View pull request | 8.7.1 or higher |
1.40.7 | Enhancement View pull request | 8.7.1 or higher |
1.40.6 | Enhancement View pull request | 8.7.1 or higher |
1.40.5 | Enhancement View pull request | 8.7.1 or higher |
1.40.4 | Enhancement View pull request | 8.7.1 or higher |
1.40.3 | Enhancement View pull request | 8.7.1 or higher |
1.40.2 | Enhancement View pull request | 8.7.1 or higher |
1.40.1 | Enhancement View pull request | 8.7.1 or higher |
1.40.0 | Enhancement View pull request | 8.7.1 or higher |
1.39.0 | Enhancement View pull request | 8.7.1 or higher |
1.38.4 | Enhancement View pull request | 8.7.1 or higher |
1.38.3 | Enhancement View pull request | 8.7.1 or higher |
1.38.2 | Enhancement View pull request | 8.7.1 or higher |
1.38.1 | Enhancement View pull request | 8.7.1 or higher |
1.38.0 | Enhancement View pull request | 8.7.1 or higher |
1.37.3 | Bug fix View pull request | 8.7.1 or higher |
1.37.2 | Enhancement View pull request | 8.7.1 or higher |
1.37.1 | Enhancement View pull request | 8.7.1 or higher |
1.37.0 | Enhancement View pull request | 8.7.1 or higher |
1.36.9 | Enhancement View pull request | 8.7.1 or higher |
1.36.8 | Enhancement View pull request | 8.7.1 or higher |
1.36.7 | Enhancement View pull request | 8.7.1 or higher |
1.36.6 | Enhancement View pull request | 8.7.1 or higher |
1.36.5 | Enhancement View pull request | 8.7.1 or higher |
1.36.4 | Enhancement View pull request | 8.7.1 or higher |
1.36.3 | Enhancement View pull request | 8.7.1 or higher |
1.36.2 | Enhancement View pull request | 8.7.1 or higher |
1.36.1 | Enhancement View pull request | 8.7.1 or higher |
1.36.0 | Enhancement View pull request | 8.7.1 or higher |
1.35.1 | Bug fix View pull request | 8.7.1 or higher |
1.35.0 | Enhancement View pull request | 8.7.1 or higher |
1.34.5 | Enhancement View pull request | 8.6.0 or higher |
1.34.4 | Enhancement View pull request | 8.6.0 or higher |
1.34.3 | Enhancement View pull request | 8.6.0 or higher |
1.34.2 | Enhancement View pull request | 8.6.0 or higher |
1.34.1 | Enhancement View pull request | 8.6.0 or higher |
1.34.0 | Enhancement View pull request | 8.6.0 or higher |
1.33.3 | Enhancement View pull request | 8.6.0 or higher |
1.33.2 | Bug fix View pull request | 8.6.0 or higher |
1.33.1 | Bug fix View pull request | 8.6.0 or higher |
1.33.0 | Enhancement View pull request | 8.6.0 or higher |
1.32.2 | Bug fix View pull request | 8.6.0 or higher |
1.32.1 | Enhancement View pull request | 8.6.0 or higher |
1.32.0 | Enhancement View pull request | 8.6.0 or higher |
1.31.0 | Enhancement View pull request | 8.6.0 or higher |
1.30.0 | Enhancement View pull request | 8.6.0 or higher |
1.29.1 | Bug fix View pull request | 8.6.0 or higher |
1.29.0 | Enhancement View pull request | 8.6.0 or higher |
1.28.3 | Bug fix View pull request | 8.4.0 or higher |
1.28.2 | Bug fix View pull request | 8.4.0 or higher |
1.28.1 | Enhancement View pull request | 8.4.0 or higher |
1.28.0 | Enhancement View pull request | 8.4.0 or higher |
1.27.3 | Bug fix View pull request | 8.4.0 or higher |
1.27.2 | Enhancement View pull request | 8.4.0 or higher |
1.27.1 | Enhancement View pull request | 8.4.0 or higher |
1.27.0 | Enhancement View pull request | 8.4.0 or higher |
1.25.3 | Bug fix View pull request | 8.3.0 or higher |
1.25.2 | Bug fix View pull request | 8.3.0 or higher |
1.25.1 | Bug fix View pull request | 8.3.0 or higher |
1.25.0 | Enhancement View pull request | 8.3.0 or higher |
1.24.6 | Bug fix View pull request | 8.3.0 or higher |
1.24.5 | Bug fix View pull request | 8.3.0 or higher |
1.24.4 | Bug fix View pull request | 8.3.0 or higher |
1.24.3 | Bug fix View pull request | 8.3.0 or higher |
1.24.2 | Bug fix View pull request | 8.3.0 or higher |
1.24.1 | Bug fix View pull request | 8.3.0 or higher |
1.24.0 | Bug fix View pull request | 8.3.0 or higher |
1.23.4 | Bug fix View pull request | 8.3.0 or higher |
1.23.3 | Bug fix View pull request | 8.3.0 or higher |
1.23.2 | Bug fix View pull request | 8.3.0 or higher |
1.23.1 | Enhancement View pull request | 8.1.0 or higher |
1.23.0 | Bug fix View pull request | 8.1.0 or higher |
1.22.0 | Enhancement View pull request | 8.1.0 or higher |
1.21.0 | Enhancement View pull request | 8.1.0 or higher |
1.20.0 | Enhancement View pull request | 8.1.0 or higher |
1.19.5 | Enhancement View pull request | 7.15.0 or higher |
1.19.4 | Bug fix View pull request | 7.15.0 or higher |
1.19.3 | Bug fix View pull request | 7.15.0 or higher |
1.19.2 | Enhancement View pull request | 7.15.0 or higher |
1.19.1 | Enhancement View pull request | 7.15.0 or higher |
1.19.0 | Enhancement View pull request | 7.15.0 or higher |
1.18.2 | Enhancement View pull request | 7.15.0 or higher |
1.18.1 | Enhancement View pull request | 7.15.0 or higher |
1.18.0 | Enhancement View pull request | 7.15.0 or higher |
1.17.5 | Enhancement View pull request | 7.15.0 or higher |
1.17.4 | Bug fix View pull request | 7.15.0 or higher |
1.17.3 | Bug fix View pull request | 7.15.0 or higher |
1.17.2 | Bug fix View pull request | 7.15.0 or higher |
1.17.1 | Bug fix View pull request | 7.15.0 or higher |
1.17.0 | Enhancement View pull request | 7.15.0 or higher |
1.16.6 | Enhancement View pull request | 7.15.0 or higher |
1.16.5 | Enhancement View pull request | — |
1.16.4 | Bug fix View pull request | 7.15.0 or higher |
1.16.3 | Enhancement View pull request | — |
1.16.2 | Enhancement View pull request | — |
1.16.1 | Bug fix View pull request | — |
1.16.0 | Enhancement View pull request | 7.15.0 or higher |
1.15.0 | Enhancement View pull request | — |
1.14.8 | Bug fix View pull request | 7.15.0 or higher |
1.14.7 | Bug fix View pull request | 7.15.0 or higher |
1.14.6 | Enhancement View pull request | — |
1.14.5 | Bug fix View pull request | 7.15.0 or higher |
1.14.4 | Bug fix View pull request | — |
1.14.3 | Enhancement View pull request | — |
1.14.2 | Bug fix View pull request | — |
1.14.1 | Enhancement View pull request | — |
1.14.0 | Enhancement View pull request | 7.15.0 or higher |
1.13.1 | Bug fix View pull request | 7.15.0 or higher |
1.13.0 | Enhancement View pull request | 7.15.0 or higher |
1.12.1 | Bug fix View pull request | 7.15.0 or higher |
1.12.0 | Enhancement View pull request | — |
1.11.4 | Bug fix View pull request | — |
1.11.3 | Bug fix View pull request | — |
1.11.2 | Bug fix View pull request | — |
1.11.1 | Bug fix View pull request | — |
1.11.0 | Enhancement View pull request | 7.15.0 or higher |
1.10.2 | Enhancement View pull request | 7.15.0 or higher |
1.10.1 | Enhancement View pull request | — |
1.10.0 | Enhancement View pull request | — |
1.9.0 | Enhancement View pull request | 7.15.0 or higher |
1.8.0 | Enhancement View pull request | — |
1.7.1 | Bug fix View pull request | — |
1.7.0 | Enhancement View pull request | — |
1.6.2 | Bug fix View pull request | — |
1.6.1 | Enhancement View pull request | 7.15.0 or higher |
1.6.0 | Enhancement View pull request | — |
1.5.1 | Enhancement View pull request | 7.15.0 or higher |
1.5.0 | Enhancement View pull request | 7.15.0 or higher |
1.4.1 | Enhancement View pull request | 7.15.0 or higher |
1.4.0 | Enhancement View pull request | — |
1.3.2 | Enhancement View pull request | — |
1.3.1 | Enhancement View pull request | — |
1.3.0 | Enhancement View pull request | — |
1.2.2 | Bug fix View pull request | — |
1.2.1 | Bug fix View pull request | — |
1.2.0 | Enhancement View pull request | — |
1.1.0 | Enhancement View pull request | 7.14.0 or higher |
1.0.0 | Enhancement View pull request | 7.14.0 or higher |
0.10.7 | Enhancement View pull request | — |
0.10.6 | Bug fix View pull request | — |
0.10.5 | Bug fix View pull request | — |
0.10.4 | Enhancement View pull request | — |
0.10.3 | Enhancement View pull request | — |
0.10.2 | Enhancement View pull request | — |
0.10.1 | Enhancement View pull request | — |
0.10.0 | Enhancement View pull request | — |
0.9.3 | Bug fix View pull request | — |
0.9.2 | Enhancement View pull request | — |
0.9.1 | Bug fix View pull request | — |
0.9.0 | Enhancement View pull request | — |
0.8.0 | Enhancement View pull request | — |
0.7.0 | Enhancement View pull request | — |
0.6.4 | Enhancement View pull request | — |
0.6.3 | Bug fix View pull request | — |
0.6.2 | Bug fix View pull request | — |
0.6.1 | Enhancement View pull request | — |
0.6.0 | Enhancement View pull request | — |
0.5.6 | Bug fix View pull request | — |
0.5.5 | Enhancement View pull request | — |
0.5.4 | Enhancement View pull request | — |
0.5.3 | Enhancement View pull request | — |
0.5.2 | Enhancement View pull request | — |
0.5.1 | Bug fix View pull request | — |
0.5.0 | Enhancement View pull request | — |
0.4.2 | Enhancement View pull request | — |
0.4.1 | Bug fix View pull request | — |
0.4.0 | Enhancement View pull request | — |
0.0.3 | Enhancement View pull request | — |