Back to Beats

Docs

x-pack/metricbeat/module/aws/sns/_meta/docs.md

9.4.02.0 KB
Original Source

::::{warning} 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 sns metricset of aws module allows you to monitor your AWS SNS topic. sns metricset fetches a set of values from Amazon SNS Metrics. CloudWatch metrics for Amazon SNS topics are automatically collected and pushed to CloudWatch every five minutes.

AWS Permissions [_aws_permissions_13]

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

cloudwatch:GetMetricData
cloudwatch:ListMetrics
ec2:DescribeRegions
sns:ListTopics
sts:GetCallerIdentity
iam:ListAccountAliases

Dashboard [_dashboard_14]

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

Configuration example [_configuration_example_13]

yaml
- module: aws
  period: 300s
  metricsets:
    - sns
  # This module uses the aws cloudwatch metricset, all
  # the options for this metricset are also available here.

Metrics [_metrics_6]

Please see more details for each metric in CloudWatch SNS Metrics.

Metric NameStatistic Method
NumberOfMessagesPublishedSum
NumberOfNotificationsDeliveredSum
NumberOfNotificationsFailedSum
NumberOfNotificationsFilteredOutSum
NumberOfNotificationsFilteredOut-InvalidAttributesSum
NumberOfNotificationsFilteredOut-NoMessageAttributesSum
NumberOfNotificationsRedrivenToDlqSum
NumberOfNotificationsFailedToRedriveToDlqSum
PublishSizeAverage
SMSMonthToDateSpentUSDSum
SMSSuccessRateAverage