Once you’ve integrated with AWS CloudWatch, you have access to all metrics for the DocumentDB service, which is a fully managed, JSON based document store.
See all AWS integrations.
To verify metrics are reporting, search for the metrics in the Metric details section of the Settings page.
The following table shows the DocumentDB metrics ingested by Cloud Observability.
| Metric Name | Unit | Description |
|---|---|---|
| aws.documentdb.backup_retention_period_storage_used | gib | The total amount of backup storage used to support the point-in-time restore feature within the Amazon DocumentDB's retention window. Computed separately for each Amazon DocumentDB cluster. |
| aws.documentdb.change_stream_log_size | mb | The amount of storage used by the cluster to store the change stream log. This value affects the cost of the cluster. The change stream log size is a function of the amount of change happening on the cluster and the change stream retention duration. |
| aws.documentdb.cpu_utilization | percent | The percent of CPU used by an instance. |
| aws.documentdb.database_count | count | The number of count open on an instance at a one-minute frequency. |
| aws.documentdb.database_count_max | count | The maximum number of open database count on an instance in a one-minute period. |
| aws.documentdb.database_cursors | count | The number of cursors open on an instance at a one-minute frequency. |
| aws.documentdb.database_cursors_max | count | The maximum number of open cursors on an instance in a one-minute period. |
| aws.documentdb.database_cursors_timed_out | count | The number of cursors that timed out in a one-minute period. |
| aws.documentdb.freeable_memory | bytes | The amount of available random access memory. |
| aws.documentdb.free_local_storage | mb | The amount of storage available to each instance for temporary tables and logs. This value depends on the instance class. You can increase the amount of free storage space for an instance by choosing a larger instance class for your instance. |
| aws.documentdb.low_mem_throttle_queue_depth | count | The queue depth for requests that are throttled due to low available memory taken at a one-minute frequency. |
| aws.documentdb.low_mem_throttle_max_queue_depth | count | The maximum queue depth for requests that are throttled due to low available memory in a one-minute period. |
| aws.documentdb.low_mem_num_operations_throttled | count | The number of requests that are throttled due to low available memory in a one-minute period. |
| aws.documentdb.snapshot_storage_used | gb | The total amount of backup storage consumed by all snapshots for a given Amazon DocumentDB cluster outside its backup retention window. Included in the total reported by the TotalBackupStorageBilled metric. Computed separately for each Amazon DocumentDB cluster. |
| aws.documentdb.swap_usage | percent | The amount of swap space used on the instance. |
| aws.documentdb.total_backup_storage_billed | bytes | The total amount of backup storage billed for all snapshots for a given Amazon DocumentDB cluster outside its backup retention window. |
| aws.documentdb.transactions_open | count | The number of transactions open on an instance taken at a one-minute frequency. |
| aws.documentdb.transactions_open | count | The number of transactions open on an instance taken at a one-minute frequency. |
| aws.documentdb.transactions_open_max | count | The maximum number of transactions open on an instance in a one-minute period. |
| aws.documentdb.volume_bytes_used | bytes | The amount of storage used by your cluster in bytes. This value affects the cost of the cluster. For pricing information, see the Amazon DocumentDB product page. |
| aws.documentdb.db_cluster_replica_lag_maximum | milliseconds | The maximum amount of lag between the primary instance and each Amazon DocumentDB instance in the cluster. |
| aws.documentdb.db_cluster_replica_lag_minimum | milliseconds | The minimum amount of lag between the primary instance and each replica instance in the cluster. |
| aws.documentdb.db_instance_replica_lag | milliseconds | The amount of lag when replicating updates from the primary instance to a replica instance. |
| aws.documentdb.read_latency | milliseconds | The average amount of time taken per disk I/O operation. |
| aws.documentdb.write_latency | milliseconds | The average amount of time taken per disk I/O operation. |
| aws.documentdb.documents_deleted | count | The number of deleted documents in a one-minute period. |
| aws.documentdb.documents_inserted | count | The number of inserted documents in a one-minute period. |
| aws.documentdb.documents_returned | count | The number of returned documents in a one-minute period. |
| aws.documentdb.documents_updated | count | The number of updated documents in a one-minute period. |
| aws.documentdb.opcounters_command | count | The number of commands issued in a one-minute period. |
| aws.documentdb.opcounters_delete | count | The number of delete operations issued in a one-minute period. |
| aws.documentdb.opcounters_getmore | count | The number of getmores issued in a one-minute period. |
| aws.documentdb.opcounters_insert | count | The number of insert operations issued in a one-minute period. |
| aws.documentdb.opcounters_query | count | The number of queries issued in a one-minute period. |
| aws.documentdb.opcounters_update | count | The number of update operations issued in a one-minute period. |
| aws.documentdb.transactions_started | count | The number of transactions started on an instance in a one-minute period. |
| aws.documentdb.transactions_committed | count | The number of successful transactions on an instance in a one-minute period. |
| aws.documentdb.transactions_aborted | count | The number of unsuccessful transactions on an instance in a one-minute period. |
| aws.documentdb.ttl_deleted_documents | count | The number of documents removed by a time-to-live monitor in a one-minute period. |
| aws.documentdb.network_receive_throughput | bytes/s | The amount of network data received from clients by each instance in the cluster, measured in bytes per second. This does not include traffic between instances or between the cluster and its storage volume. |
| aws.documentdb.network_throughput | bytes/s | The total amount of network data sent and received by each instance in the Amazon DocumentDB cluster, measured in bytes per second. This does not include traffic between instances or between the cluster and its storage volume. |
| aws.documentdb.network_transmit_throughput | bytes/s | The amount of network data sent to clients by each instance in the cluster, measured in bytes per second. This does not include traffic between instances or between the cluster and its storage volume. |
| aws.documentdb.read_iops | count/s | The average number of disk read operations per second. Amazon DocumentDB reports read and write operations separately, and on one-minute intervals. |
| aws.documentdb.read_throughput | bytes/s | The average number of bytes read from disk per second. |
| aws.documentdb.volume_read_io_ps | count/s | The average number of billed read operations from the cluster storage volume, reported at 5-minute intervals. Billed read operations are calculated at the cluster volume level, aggregated from all instances in the cluster, and then reported at 5-minute intervals. The value is calculated by taking the value of the read operations metric over a 5-minute period. |
| aws.documentdb.volume_write_io_ps | count/s | The average number of billed write operations to the cluster storage volume, reported at 5-minute intervals. Billed write operations are calculated at the cluster volume level, aggregated from all instances in the cluster, and then reported at 5-minute intervals. |
| aws.documentdb.write_iops | count/s | The average number of disk write operations per second. Read and write operations are reported separately, on 1-minute intervals. |
| aws.documentdb.write_throughput | bytes/s | The average number of bytes written to disk per second. |
| aws.documentdb.buffer_cache_hit_ratio | percent | The proportion of requests that are served by the buffer cache. |
| aws.documentdb.disk_queue_depth | count | the number of concurrent write requests to the distributed storage volume. |
| aws.documentdb.engine_uptime | seconds | The amount of time that the instance has been running. |
| aws.documentdb.index_buffer_cache_hit_ratio | percent | The proportion of index requests that are served by the buffer cache. You might see a spike greater than 100% for the metric right after you drop an index, collection, or database. |
| aws.documentdb.cpu_credit_usage | count | The number of CPU credits spent during the measurement period. |
| aws.documentdb.cpu_credit_balance | count | The number of CPU credits that an instance has accrued. This balance is depleted when the CPU bursts and CPU credits are spent more quickly than they are earned. |
| aws.documentdb.cpu_surplus_credit_balance | count | The number of surplus CPU credits spent to sustain CPU performance when the CPUCreditBalance value is zero. |
| aws.documentdb.cpu_surplus_credits_charged | count | The number of surplus CPU credits exceeding the maximum allowed threshold for a single hour. |
See also
Updated Dec 7, 2022