Monitoring Amazon Simple Notification Service (SNS)
Instana uses the Amazon SNS sensor for monitoring your Amazon SNS service. After you install the Instana host agent, the Amazon SNS sensor is automatically installed and enabled. You can view metrics that are related to your Amazon SNS instances in the Instana UI.
For more information about the other supported AWS services, see the AWS documentation.
- Adding required IAM permissions
- Configuring the Amazon SNS sensor
- Viewing metrics
Adding required IAM permissions
Add the following IAM role permissions to the host that is running the Instana agent so that the Instana agent discovers and monitors your AWS SNS instances:
cloudwatch:GetMetricStatistics
cloudwatch:GetMetricData
sns:ListTopics
sns:ListTagsForResource
sns:GetTopicAttributes
Configuring the Amazon SNS sensor
After the Instana agent is installed, the Amazon SNS sensor is enabled by default.
Disabling the Amazon SNS sensor
To disable monitoring of Amazon SNS instances, use the following configuration:
com.instana.plugin.aws.sns:
enabled: false
Setting the metric collection interval
By default, metrics for SNS are pulled every 5 minutes. To change this frequency, edit the cloudwatch_period
value in the agent configuration file <agent_install_dir>/etc/instana/configuration.yml
as shown in
the following example:
com.instana.plugin.aws.sns:
cloudwatch_period: 300
Setting proxy configurations
To configure the Amazon SNS sensor to use proxy configuration, add the following agent configuration settings:
com.instana.plugin.aws.sns:
proxy_host: 'example.com' # proxy host name or ip address
proxy_port: 3128 # proxy port
proxy_protocol: 'HTTP' # proxy protocol: HTTP or HTTPS
proxy_username: 'username' # OPTIONAL: proxy username
proxy_password: 'password' # OPTIONAL: proxy password
Configuring monitoring of Amazon SNS across multiple AWS accounts
You can set up monitoring of multiple AWS accounts with one AWS agent in the same region. For more information, see Monitoring multiple AWS accounts.
To configure the Instana agent to monitor Amazon SNS across multiple AWS accounts, use any one of the following approaches:
AWS named profiles approach
To override the profiles that are used to monitor Amazon SNS, use the following configuration:
com.instana.plugin.aws.sns:
profile_names:
- 'profile2'
- 'profile3'
Defining profiles on service level overrides the global AWS profile configuration.
AWS Security Token Service (STS) approach
To override the IAM roles that are used to monitor Amazon SNS, use the following configuration:
com.instana.plugin.aws.sns:
role_arns:
- 'arn:aws:iam::<account_1_id>:role/<role_1_name>'
- 'arn:aws:iam::<account_2_id>:role/<role_2_name>'
Defining IAM roles on the service level overrides the global AWS IAM roles configuration.
Setting poll rate
You can specify how often sensors poll the AWS tagged resources by using the tagged-services-poll-rate
configuration property. By default, 300 seconds.
Tags are only available with the AWS Agent.
To define how often sensors poll the tagged resources, update the configuration.yaml
file as shown in the following example:
com.instana.plugin.aws:
tagged-services-poll-rate: 60 #default 300
Viewing metrics
To view the metrics, complete the following steps:
- From the navigation menu in the Instana UI, click Infrastructure.
- Click a specified host.
You can see a host dashboard with all the collected metrics and monitored processes. Metrics are pulled every 5 minutes.
Tracked configuration
SNS Topic Details | Description |
---|---|
ARN | The unqualified Amazon Resource Name (ARN) assigned to the topic. |
Availability Zone | The location of the instance. |
Topic Name | The topic name. |
Display Name | The user-defined topic name. |
Subscriptions Confirmed | The number of subscriptions that are confirmed. |
Number Of Retries | The number of notification retry limits. |
Minimum Delay Target | The minimum delay to the target subscription. |
Maximum Delay Target | The maximum delay to the target subscription. |
Metrics
Topic metrics | Description |
---|---|
NumberOfMessagesPublished | The number of messages that are published to your Amazon SNS topics. |
NumberOfNotificationsFailedToRedriveToDlq | The number of messages that are not moved to a dead-letter queue. |
NumberOfNotificationsDelivered | The number of messages that are successfully delivered from your Amazon SNS topics to subscribing endpoints. |
PublishSize | The size of messages published. |
NumberOfNotificationsRedrivenToDlq | The number of messages that are moved to a dead-letter queue. |
NumberOfNotificationsFailed | The number of messages that Amazon SNS failed to deliver. |
NumberOfNotificationsFilteredOut | The number of messages that are rejected by subscription filter policies. A filter policy rejects a message when the message attributes don't match the policy attributes. |