Datadog Synthetics is now available!

AWS DocumentDB

Crawler Crawler

Overview

Amazon DocumentDB is a fast, scalable, highly available, and fully managed document database service that supports MongoDB workloads.

Setup

Installation

If you haven’t already, set up the Amazon Web Services integration first.

Metric collection

  1. In the AWS integration tile, ensure that DocumentDB is checked under metric collection.

  2. Install the Datadog - AWS DocumentDB integration.

Log collection

  1. If you haven’t already, set up the Datadog log collection AWS Lambda function.
  2. Once the Lambda function is installed, manually add a trigger on the Cloudwatch log group that contains your DocumentDB logs in the AWS console. Refer to Manually setup triggers in the main AWS documentation.

Once done, go in your Datadog Log section to start exploring your logs!

Data Collected

Metrics

aws.docdb.backup_rentention_period_storage_used
(count)
Average backup storage in GiB used to support the point-in-time restore feature within the rention window.
shown as gibibyte
aws.docdb.backup_rentention_period_storage_used.sum
(count)
Total backup storage in GiB used to support the point-in-time restore feature within the rention window.
shown as gibibyte
aws.docdb.backup_rentention_period_storage_used.minimum
(count)
Minimum backup storage in GiB used to support the point-in-time restore feature within the rention window.
shown as gibibyte
aws.docdb.backup_rentention_period_storage_used.maximum
(count)
Maximum backup storage in GiB used to support the point-in-time restore feature within the rention window.
shown as gibibyte
aws.docdb.backup_rentention_period_storage_used.samplecount
(count)
Sample count of backup storage in GiB used to support the point-in-time restore feature within the rention window.
shown as gibibyte
aws.docdb.buffer_cache_hit_ratio
(count)
Average percentage of requests that are served by the buffer cache.
aws.docdb.buffer_cache_hit_ratio.sum
(count)
Sum of the percentage of requests that are served by the buffer cache.
aws.docdb.buffer_cache_hit_ratio.minimum
(count)
Minimum percentage of requests that are served by the buffer cache.
aws.docdb.buffer_cache_hit_ratio.maximum
(count)
Maximum percentage of requests that are served by the buffer cache.
aws.docdb.buffer_cache_hit_ratio.samplecount
(count)
Sample count of percentage of requests that are served by the buffer cache.
aws.docdb.cpuutilization
(count)
Average percentage of CPU used by an instance.
aws.docdb.cpuutilization.sum
(count)
Sum of the percentage of CPU used by an instance.
aws.docdb.cpuutilization.minimum
(count)
Minimum percentage of CPU used by an instance.
aws.docdb.cpuutilization.maximum
(count)
Maximum percentage of CPU used by an instance.
aws.docdb.cpuutilization.samplecount
(count)
Sample count of the percentage of CPU used by an instance.
aws.docdb.database_connections
(count)
The average number of connections to an instance.
aws.docdb.database_connections.sum
(count)
The sum of the number of connections to an instance.
aws.docdb.database_connections.minimum
(count)
The minimum number of connections to an instance.
aws.docdb.database_connections.maximum
(count)
The maximum number of connections to an instance.
aws.docdb.database_connections.samplecount
(count)
Sample count of the number of connections to an instance.
aws.docdb.db_instance_replica_lag
(count)
The average amount of lag when replicating updates from the primary instance of a replica.
shown as millisecond
aws.docdb.db_instance_replica_lag.sum
(count)
The sum of the amount of lag when replicating updates from the primary instance of a replica.
shown as millisecond
aws.docdb.db_instance_replica_lag.minimum
(count)
The minimum amount of lag when replicating updates from the primary instance of a replica.
shown as millisecond
aws.docdb.db_instance_replica_lag.maximum
(count)
The maximum amount of lag when replicating updates from the primary instance of a replica.
shown as millisecond
aws.docdb.db_instance_replica_lag.samplecount
(count)
Sample count of the amount of lag when replicating updates from the primary instance of a replica.
shown as millisecond
aws.docdb.db_instance_replica_lag_maximum.sum
(count)
The sum of the maximum amount of lag between the primary instance and each db instance in the cluster.
shown as millisecond
aws.docdb.db_instance_replica_lag_maximum.minimum
(count)
The minimum of the maximum amount of lag between the primary instance and each db instance in the cluster.
shown as millisecond
aws.docdb.db_instance_replica_lag_maximum.maximum
(count)
The total maximum amount of lag between the primary instance and each db instance in the cluster.
shown as millisecond
aws.docdb.db_instance_replica_lag_maximum
(count)
The average maximum amount of lag between the primary instance and each db instance in the cluster.
shown as millisecond
aws.docdb.db_instance_replica_lag_maximum.samplecount
(count)
The sample count of the maximum amount of lag between the primary instance and each db instance in the cluster.
shown as millisecond
aws.docdb.db_instance_replica_lag_minimum
(count)
The average minimum amount of lag between the primary instance and each replica instance in the cluster.
shown as millisecond
aws.docdb.db_instance_replica_lag_minimum.sum
(count)
The sum of the minimum amount of lag between the primary instance and each replica instance in the cluster.
shown as millisecond
aws.docdb.db_instance_replica_lag_minimum.minimum
(count)
The minimum of the minimum amount of lag between the primary instance and each replica instance in the cluster.
shown as millisecond
aws.docdb.db_instance_replica_lag_minimum.maximum
(count)
The maximum of the minimum amount of lag between the primary instance and each replica instance in the cluster.
shown as millisecond
aws.docdb.db_instance_replica_lag_minimum.samplecount
(count)
Sample count of the minimum amount of lag between the primary instance and each replica instance in the cluster.
shown as millisecond
aws.docdb.disk_queue_depth
(count)
The number of outstanding read/write requests waiting to access the disk.
aws.docdb.disk_queue_depth.sum
(count)
The sum of the number of outstanding read/write requests waiting to access the disk.
aws.docdb.disk_queue_depth.minimum
(count)
The minimum of the number of outstanding read/write requests waiting to access the disk.
aws.docdb.disk_queue_depth.maximum
(count)
The maximum number of outstanding read/write requests waiting to access the disk.
aws.docdb.disk_queue_depth.samplecount
(count)
Sample count of the number of outstanding read/write requests waiting to access the disk.
aws.docdb.engine_uptime
(count)
The amount of time that the instance has been running.
shown as second
aws.docdb.engine_uptime.sum
(count)
The sum of the amount of time that the instance has been running.
shown as second
aws.docdb.engine_uptime.minimum
(count)
The minimum amount of time that the instance has been running.
shown as second
aws.docdb.engine_uptime.maximum
(count)
The maximum amount of time that the instance has been running.
shown as second
aws.docdb.engine_uptime.samplecount
(count)
Sample count of the amount of time that the instance has been running.
shown as second
aws.docdb.freeable_memory
(count)
The amount of available random access memory.
shown as byte
aws.docdb.freeable_memory.sum
(count)
The sum of the amount of available random access memory.
shown as byte
aws.docdb.freeable_memory.minimum
(count)
The minimum amount of available random access memory.
shown as byte
aws.docdb.freeable_memory.maximum
(count)
The maximum amount of available random access memory.
shown as byte
aws.docdb.freeable_memory.samplecount
(count)
Sample count of the amount of available random access memory.
shown as byte
aws.docdb.free_local_storage
(count)
The amount of storage available to each instance for temporary tables and logs.
aws.docdb.free_local_storage.sum
(count)
The sum of the amount of storage available to each instance for temporary tables and logs.
aws.docdb.free_local_storage.minimum
(count)
The minimum amount of storage available to each instance for temporary tables and logs.
aws.docdb.free_local_storage.maximum
(count)
The maximum amount of storage available to each instance for temporary tables and logs.
aws.docdb.free_local_storage.samplecount
(count)
Sample count of the amount of storage available to each instance for temporary tables and logs.
aws.docdb.network_receive_throughput
(count)
The amount of network throughput both receieved from and transmitted to clients by each instance in a cluster.
shown as byte
aws.docdb.network_receive_throughput.sum
(count)
The sum amount of network throughput both receieved from and transmitted to clients by each instance in a cluster.
shown as byte
aws.docdb.network_receive_throughput.minimum
(count)
The minimum amount of network throughput both receieved from and transmitted to clients by each instance in a cluster.
shown as byte
aws.docdb.network_receive_throughput.maximum
(count)
The maximum amount of network throughput both receieved from and transmitted to clients by each instance in a cluster.
shown as byte
aws.docdb.network_receive_throughput.samplecount
(count)
Sample count of the amount of network throughput both receieved from and transmitted to clients by each instance in a cluster.
shown as byte
aws.docdb.network_transmit_throughput
(count)
The average amount of network throughput sent to clients by each instance in a cluster.
shown as byte
aws.docdb.network_transmit_throughput.sum
(count)
The sum of the amount of network throughput sent to clients by each instance in a cluster.
shown as byte
aws.docdb.network_transmit_throughput.minimum
(count)
The minimum amount of network throughput sent to clients by each instance in a cluster.
shown as byte
aws.docdb.network_transmit_throughput.maximum
(count)
The maximum amount of network throughput sent to clients by each instance in a cluster.
shown as byte
aws.docdb.network_transmit_throughput.samplecount
(count)
Sample count of the amount of network throughput sent to clients by each instance in a cluster.
shown as byte
aws.docdb.read_iops
(count)
The average amount of time taken per disk I/O operation.
aws.docdb.read_iops.sum
(count)
The sum of the average amount of time taken per disk I/O operation.
aws.docdb.read_iops.minimum
(count)
The minimum average amount of time taken per disk I/O operation.
aws.docdb.read_iops.maximum
(count)
The maximum average amount of time taken per disk I/O operation.
aws.docdb.read_iops.samplecount
(count)
Sample count of the average amount of time taken per disk I/O operation.
aws.docdb.read_latency
(count)
The number of bytes read from disk per second.
aws.docdb.read_latency.sum
(count)
The sum of the number of bytes read from disk per second.
aws.docdb.read_latency.minimum
(count)
The minimum number of bytes read from disk per second.
aws.docdb.read_latency.maximum
(count)
The maximum number of bytes read from disk per second.
aws.docdb.read_latency.samplecount
(count)
Sample count of the number of bytes read from disk per second.
aws.docdb.read_throughput
(count)
The amount of network throughput both receieved from and transmitted to clients by each instance in a cluster.
aws.docdb.read_throughput.sum
(count)
The sum of the amount of network throughput both receieved from and transmitted to clients by each instance in a cluster.
aws.docdb.read_throughput.minimum
(count)
The minimum amount of network throughput both receieved from and transmitted to clients by each instance in a cluster.
aws.docdb.read_throughput.maximum
(count)
The maximum amount of network throughput both receieved from and transmitted to clients by each instance in a cluster.
aws.docdb.read_throughput.samplecount
(count)
Sample count of the amount of network throughput both receieved from and transmitted to clients by each instance in a cluster.
aws.docdb.snapshot_storage_used
(count)
The total amount of backup storage consumed by all snapshots for a given cluster outside its backup retention window.
shown as gibibyte
aws.docdb.snapshot_storage_used.sum
(count)
The sum of the total amount of backup storage consumed by all snapshots for a given cluster outside its backup retention window.
shown as gibibyte
aws.docdb.snapshot_storage_used.minimum
(count)
The minimum total amount of backup storage consumed by all snapshots for a given cluster outside its backup retention window.
shown as gibibyte
aws.docdb.snapshot_storage_used.maximum
(count)
The maximum total amount of backup storage consumed by all snapshots for a given cluster outside its backup retention window.
shown as gibibyte
aws.docdb.snapshot_storage_used.samplecount
(count)
Sample count of the total amount of backup storage consumed by all snapshots for a given cluster outside its backup retention window.
shown as gibibyte
aws.docdb.swap_usage
(count)
The amount of swap space used on the instance.
aws.docdb.swap_usage.sum
(count)
The sum of the amount of swap space used on the instance.
aws.docdb.swap_usage.minimum
(count)
The minimum amount of swap space used on the instance.
aws.docdb.swap_usage.maximum
(count)
The maximum amount of swap space used on the instance.
aws.docdb.swap_usage.samplecount
(count)
Sample count of the amount of swap space used on the instance.
aws.docdb.total_backup_storage_billed
(count)
The total amount of backup storage for which you are billed for a given cluster.
shown as gibibyte
aws.docdb.total_backup_storage_billed.sum
(count)
The sum of the total amount of backup storage for which you are billed for a given cluster.
shown as gibibyte
aws.docdb.total_backup_storage_billed.minimum
(count)
The minimum amount of backup storage for which you are billed for a given cluster.
shown as gibibyte
aws.docdb.total_backup_storage_billed.maximum
(count)
The maximum amount of backup storage for which you are billed for a given cluster.
shown as gibibyte
aws.docdb.total_backup_storage_billed.samplecount
(count)
Sample count of the amount of backup storage for which you are billed for a given cluster.
shown as gibibyte
aws.docdb.volume_bytes_used
(count)
The amount of storage used by your cluster.
shown as byte
aws.docdb.volume_bytes_used.sum
(count)
The sum of the amount of storage used by your cluster.
shown as byte
aws.docdb.volume_bytes_used.minimum
(count)
The minimum amount of storage used by your cluster.
shown as byte
aws.docdb.volume_bytes_used.maximum
(count)
The maximum amount of storage used by your cluster.
shown as byte
aws.docdb.volume_bytes_used.samplecount
(count)
Sample count of the amount of storage used by your cluster.
shown as byte
aws.docdb.volume_read_iops
(count)
The average number of billed read I/O operations from a cluster volume.
aws.docdb.volume_read_iops.sum
(count)
The sum of the average number of billed read I/O operations from a cluster volume.
aws.docdb.volume_read_iops.minimum
(count)
The minimum average number of billed read I/O operations from a cluster volume.
aws.docdb.volume_read_iops.maximum
(count)
The maximum average number of billed read I/O operations from a cluster volume.
aws.docdb.volume_read_iops.samplecount
(count)
Sample count of the average number of billed read I/O operations from a cluster volume.
aws.docdb.volume_write_iops
(count)
The average number of disk I/O operations per second.
aws.docdb.volume_write_iops.sum
(count)
The sum of the average number of disk I/O operations per second.
aws.docdb.volume_write_iops.minimum
(count)
The minimum average number of disk I/O operations per second.
aws.docdb.volume_write_iops.maximum
(count)
The maximum average number of disk I/O operations per second.
aws.docdb.volume_write_iops.samplecount
(count)
Sample count of the average number of disk I/O operations per second.
aws.docdb.write_iops
(count)
The average number of disk I/O operations per second.
aws.docdb.write_iops.sum
(count)
The sum of the average number of disk I/O operations per second.
aws.docdb.write_iops.minimum
(count)
The minimum average number of disk I/O operations per second.
aws.docdb.write_iops.maximum
(count)
The maximum average number of disk I/O operations per second.
aws.docdb.write_iops.samplecount
(count)
Sample count of the average number of disk I/O operations per second.
aws.docdb.write_latency
(count)
The average amount of time taken per disk I/O operation.
shown as millisecond
aws.docdb.write_latency.sum
(count)
The sum of the average amount of time taken per disk I/O operation.
shown as millisecond
aws.docdb.write_latency.minimum
(count)
The minimum amount of time taken per disk I/O operation.
shown as millisecond
aws.docdb.write_latency.maximum
(count)
The maximum amount of time taken per disk I/O operation.
shown as millisecond
aws.docdb.write_latency.samplecount
(count)
Sample count of the amount of time taken per disk I/O operation.
shown as millisecond
aws.docdb.write_throughput
(count)
The average number of bytes written to disk per second.
aws.docdb.write_throughput.sum
(count)
The sum of the average number of bytes written to disk per second.
aws.docdb.write_throughput.minimum
(count)
The minimum average number of bytes written to disk per second.
aws.docdb.write_throughput.maximum
(count)
The maximum average number of bytes written to disk per second.
aws.docdb.write_throughput.samplecount
(count)
Sample count of the average number of bytes written to disk per second.

Each of the metrics retrieved from AWS is assigned the same tags that appear in the AWS console, including but not limited to dbinstanceidentifier, dbclusteridentifier, and more.

Events

The AWS DocumentDB integration does not include any events.

Service Checks

The AWS DocumentDB integration does not include any service checks.

Troubleshooting

Need help? Contact Datadog support.

Further Reading

Additional helpful documentation, links, and articles: