Monitoring AWS SQS

The AWS SQS sensor is automatically deployed and installed after you install the Instana agent.

Learn about the other supported AWS services with our AWS documentation.

Supported information

Supported client-side tracing

For this technology, Instana supports client-side tracing for the following languages and runtimes:

Sensor (Data Collection)

Tracked Configuration

  • Endpoint address
  • ARN
  • Region
  • Creation time
  • Message Retention Period
  • Max Message Size
  • Visibility Timeout
  • Last Modified Timestamp

Metrics

  • Number of messages delayed
  • Number of messages not visible
  • Number of messages visible
  • Number of messages empty receives
  • Number of messages receives
  • Number of messages sent
  • Age of oldest message
  • Sent message size

Required Permissions

  • cloudwatch:GetMetricStatistics
  • cloudwatch:GetMetricData
  • sqs:ListQueues
  • sqs:GetQueueAttributes
  • sqs:ListQueueTags

Configuration

Metrics for SQS are pulled every 5 minutes, this can be changed via agent configuration in <agent_install_dir>/etc/instana/configuration.yml:

com.instana.plugin.aws.sqs:
  cloudwatch_period: 300

To disable monitoring of SQS instances use the following configuration:

com.instana.plugin.aws.sqs:
  enabled: false

Proxy configuration

To configure the specific AWS Sensor to use proxy configuration, add the following agent configuration settings:

com.instana.plugin.aws.sqs:
  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

Monitoring multiple AWS accounts

Refer to the Monitoring multiple AWS accounts documentation to set up monitoring of multiple AWS accounts with one AWS agent in the same region.

AWS named profiles approach

To override which profiles should be used to monitor SQS, use the following configuration:

com.instana.plugin.aws.sqs:
  profile_names:
    - 'profile2'
    - 'profile3'

Defining profiles on service level will override the global AWS profiles configuration.

AWS STS approach

To override which profiles should be used to monitor SQS, use the following configuration:

com.instana.plugin.aws.sqs:
  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 service level will override the global AWS IAM roles configuration.

Filtering

Multiple tags can be defined, separated by a comma. Tags should be provided as a key-value pair separated by a : character. In order to make configuration easier, it is possible to define which tags you want to include in discovery or exclude from discovery. In case of tags defined in both lists (include and exclude), exclude list has higher priority. If there is no need for services filtering, the configuration should not be defined. It is not mandatory to define all values in order to enable filtering.

Users are able to specify how often sensors will poll the AWS tagged resources using the tagged-services-poll-rate configuration property (default 300 seconds).

Tags are only available in conjunction with the AWS Agent.

To define how often sensors will poll the tagged resources use following configuration:

com.instana.plugin.aws:
  tagged-services-poll-rate: 60 #default 300

To include services by tags into discovery use following configuration:

com.instana.plugin.aws.sqs:
  include_tags: # Comma separated list of tags in key:value format (e.g. env:prod,env:staging)

To exclude services by tags from discovery use following configuration:

com.instana.plugin.aws.sqs:
  exclude_tags: # Comma separated list of tags in key:value format (e.g. env:dev,env:test)

AWS services without tags will be monitored by default but can be excluded by setting the include_untagged field to false:

com.instana.plugin.aws.sqs:
  include_untagged: false # True value by default

Poll Rate

Users are able to specify how often sensors will poll the AWS tagged resources using the tagged-services-poll-rate configuration property (default 300 seconds).

To define how often sensors will poll the tagged resources use following configuration:

com.instana.plugin.aws:
  tagged-services-poll-rate: 60 #default 300