Monitoring Amazon DocumentDB

Disabling the sensor

To disable monitoring of DocumentDB clusters and instances, use the following configuration:

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

Enabling proxy configuration

To enable the Amazon DocumentDB sensor to use the proxy configuration, add the following agent configuration settings:

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

To set up monitoring of multiple AWS accounts with one AWS agent in the same region, you can use two approaches. For more information, see Monitoring multiple AWS accounts.

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

com.instana.plugin.aws.documentdb:
  role_arns:
    - 'arn:aws:iam::<account_1_id>:role/<role_1_name>'
    - 'arn:aws:iam::<account_2_id>:role/<role_2_name>'

Filtering services by tags

Instana monitors all Amazon DocumentDB services by default. You can set which services you want to monitor by defining multiple tags, separated by a comma. You must provide tags as a key-value pair that is separated by a colon (:) in the configuration.yaml file. To configure the Amazon DocumentDB sensor easily, you can define the tags that you want to include in discovery or exclude from discovery. If tags are defined in both the lists (include and exclude), the exclude list has higher priority. If service level filtering is not needed, then you don't need to define the configuration for DocumentDB as the configuration is done at the AWS configuration level.

You can specify the interval of the sensor (default 60 seconds) to poll the AWS tagged resources by using the configuration property tagged-services-poll-rate.

Tags are only available with the AWS Agent.

To define the interval of the sensors to poll the AWS tagged resources, use the following configuration:

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

To include services by tags into discovery, update the following configuration:

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

To exclude the services by tags from discovery, update the following configuration:

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

AWS services without tags are monitored by default but you can exclude it by setting the include_untagged field to false as shown in the following example:

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

Instana agent tags

Instana agent tags are available only with the AWS Agent. For more information about using the agent tags, see Monitoring infrastructure.

DocumentDB Instance based cluster

The following sections show the configuration data and metrics collected for the DocumentDB instance-based clusters.

DocumentDB instance

The Amazon DocumentDB sensor collects the following data from the Amazon DocumentDB instance:

DocumentDB elastic cluster

The Amazon DocumentDB sensor collects the following data from the Amazon DocumentDB elastic cluster: