IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« aws s3_request metricset Beat module »

› › ›

aws sqs metricset

edit

aws sqs metricset

edit

This functionality is in beta and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Beta features are not subject to the support SLA of official GA features.

The sqs metricset of aws module allows you to monitor your AWS SQS queues. sqs metricset fetches a set of values from Amazon SQS Metrics. CloudWatch metrics for Amazon SQS queues are automatically collected and pushed to CloudWatch every five minutes.

AWS Permissions

edit

Some specific AWS permissions are required for IAM user to collect AWS SQS metrics.

cloudwatch:GetMetricData
cloudwatch:ListMetrics
ec2:DescribeRegions
sqs:ListQueues

Dashboard

edit

The aws sqs metricset comes with a predefined dashboard. For example:

Configuration example

edit

- module: aws
  period: 300s
  metricsets:
    - sqs
  access_key_id: '<access_key_id>'
  secret_access_key: '<secret_access_key>'
  session_token: '<session_token>'

Fields

edit

For a description of each field in the metricset, see the exported fields section.

Here is an example document generated by this metricset:

{
    "@timestamp": "2017-10-12T08:05:34.853Z",
    "aws": {
        "sqs": {
            "empty_receives": 28,
            "messages": {
                "delayed": 0,
                "deleted": 0,
                "not_visible": 1,
                "received": 1,
                "sent": 0,
                "visible": 0
            },
            "oldest_message_age": {
                "sec": 676
            },
            "queue": {
                "name": "test-s3-notification"
            },
            "sent_message_size": {}
        }
    },
    "cloud": {
        "provider": "aws",
        "region": "ap-southeast-1"
    },
    "event": {
        "dataset": "aws.sqs",
        "duration": 115000,
        "module": "aws"
    },
    "metricset": {
        "name": "sqs"
    },
    "service": {
        "type": "aws"
    }
}

« aws s3_request metricset Beat module »