Amazon DocumentDB

Amazon DocumentDB is a fully managed database service that makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud.

Cisco Cloud Observability supports monitoring the following DocumentDB entities:

Instance: An isolated database environment in the cloud. An instance can contain multiple user-created databases.
Instance Cluster: Consists of 0 to 16 instances and a cluster storage volume that manages the data for those instances.
Elastic Cluster: Supports workloads with millions of reads/writes per second and petabytes of storage capacity. Elastic clusters also simplify how developers interact with Amazon DocumentDB by eliminating the need to choose, manage or upgrade instances.

You must configure cloud connections to monitor this entity. See Set up Cisco AppDynamics Cloud Collectors to Monitor AWS.

Cisco Cloud Observability displays AWS entities on the Observe page. Metrics are displayed for specific entity instances in the list and detail views.

This document contains references to third-party documentation. Splunk AppDynamics does not own any rights and assumes no responsibility for the accuracy or completeness of such third-party documentation.

Detail View

To display the detail view for an Amazon DocumentDB entity:

Navigate to the Observe page.
Under Database & Storage, click AWS DocumentDB Clusters.
The list view now displays.
In the left-side Relationships panel, click AWS DocumentDB Instance to display the detail view.
The detail view displays the metrics, key performance indicators, and properties (attributes) related to the instance you selected.

Navigate to the Observe page.
Under Database & Storage, click AWS DocumentDB Clusters.
The list view now displays. The DocDB Instance Clusters tab is selected by default.
From the list, click an instance Arn to display the detail view.
The detail view displays the metrics, key performance indicators, and properties (attributes) related to the instance you selected.

Navigate to the Observe page.
Under Database & Storage, click AWS DocumentDB Clusters.
The list view now displays. Click the DocDB Elastic Clusters tab.
From the list, click an instance Arn to display the detail view.
The detail view displays the metrics, key performance indicators, and properties (attributes) related to the instance you selected.

Metrics and Key Performance Indicators

Cisco Cloud Observability displays the following metrics and key performance indicators (KPIs) for Amazon DocumentDB. For more information, see Amazon DocumentDB Metrics.

Display Name	Source Metric Name	Description
Storage Used for Backup Retention (GiB)	`BackupRetentionPeriodStorageUsed`	The total amount of backup storage in GiB used to support the point-in-time restore feature within the Amazon DocumentDB's retention window. Included in the total reported by the `TotalBackupStorageBilled` metric. Computed separately for each Amazon DocumentDB cluster.
Change Stream Log Usage (MiB)	`ChangeStreamLogSize`	The amount of storage used by your cluster to store the change stream log in megabytes. This value is a subset of the total storage for the cluster (`VolumeBytesUsed`) and affects the cost of the cluster.
CPU Utilization (%)	`CPUUtilization`	The percentage of CPU used by an instance.
Total Database Connections (Count)	`DatabaseConnections`	The number of connections open on an instance taken at a one-minute frequency.
Max Database Connections (Count)	`DatabaseConnectionsMax`	The maximum number of open database connections on an instance in a one-minute period.
Total Database Cursors (Count)	`DatabaseCursors`	The number of cursors open on an instance taken at a one-minute frequency.
Max Database Cursors (Count)	`DatabaseCursorsMax`	The maximum number of open cursors on an instance in a one-minute period.
Timed Out Database Cursors (Count)	`DatabaseCursorsTimedOut`	The number of cursors that timed out in a one-minute period.
Freeable Memory (Bytes)	`FreeableMemory`	The amount of available random access memory, in bytes.
Free Local Storage (Bytes)	`FreeLocalStorage`	This metric reports 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.
Throttled Requests Queue Depth (Count)	`LowMemThrottleQueueDepth`	The queue depth for requests that are throttled due to low available memory taken at a one-minute frequency.
Max Throttled Requests Queue Depth (Count)	`LowMemThrottleMaxQueueDepth`	The maximum queue depth for requests that are throttled due to low available memory in a one-minute period.
Throttled Requests Count	`LowMemNumOperationsThrottled`	The number of requests that are throttled due to low available memory in a one-minute period.
Snapshot Usage (GiB)	`SnapshotStorageUsed`	The total amount of backup storage in GiB 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.
Swap Usage (GiB)	`SwapUsage`	The amount of swap space used on the instance.
Max Open Transactions (Count)	`TransactionsOpenMax`	The maximum number of transactions open on an instance in a one-minute period.
Total Open Transactions (Count)	`TransactionsOpen`	The number of transactions open on an instance taken at a one-minute frequency.
Volume Usage (Bytes)	`VolumeBytesUsed`	The amount of storage used by your cluster in bytes. This value affects the cost of the cluster.
Replication Lag (ms)	`DBClusterReplicaLagMaximum`	The maximum amount of lag, in milliseconds, between the primary instance and each Amazon DocumentDB instance in the cluster.
	`DBClusterReplicaLagMinimum`	The minimum amount of lag, in milliseconds, between the primary instance and each replica instance in the cluster.
	`DBInstanceReplicaLag`	The amount of lag, in milliseconds, when replicating updates from the primary instance to a replica instance.
Latency (ms)	`ReadLatency`	The average amount of time taken per disk I/O operation.
Latency (ms)	`WriteLatency`	The average amount of time, in milliseconds, taken per disk I/O operation.
Network Throughput (By/s)	`NetworkReceiveThroughput`	The amount of network throughput, in bytes per second, received from clients by each instance in the cluster. This throughput doesn't include network traffic between instances in the cluster and the cluster volume.
Network Throughput (By/s)	`NetworkTransmitThroughput`	The amount of network throughput, in bytes per second, sent to clients by each instance in the cluster. This throughput doesn't include network traffic between instances in the cluster and the cluster volume.
Operations Per Second	`ReadIOPS`	The average number of disk read I/O operations per second. Amazon DocumentDB reports read and write IOPS separately, and on one-minute intervals.
Operations Per Second	`WriteIOPS`	The average number of disk write I/O operations per second. When used on a cluster level, `WriteIOPs` are evaluated across all instances in the cluster. Read and write IOPS are reported separately, on 1-minute intervals.
Disk Throughput Per Second (By/s)	`ReadThroughput`	The average number of bytes read from disk per second.
Disk Throughput Per Second (By/s)	`WriteThroughput`	The average number of bytes written to disk per second.
Average Volume Operations (Count)	`VolumeReadIOPs`	The average number of billed read I/O operations from a cluster 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. You can determine the amount of billed read operations per second by taking the value of the billed read operations metric and dividing by 300 seconds. For example, if the `VolumeReadIOPs` returns 13,686, then the billed read operations per second is 45 (13,686 / 300 = 45.62). You accrue billed read operations for queries that request database pages that are not present in the buffer cache and therefore must be loaded from storage. You might see spikes in billed read operations as query results are read from storage and then loaded into the buffer cache.
Average Volume Operations (Count)	`VolumeWriteIOPs`	The average number of billed write I/O operations from a cluster 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. The value is calculated by taking the value of the write operations metric over a 5-minute period. You can determine the amount of billed write operations per second by taking the value of the billed write operations metric and dividing by 300 seconds. For example, if the `VolumeWriteIOPs` returns 13,686, then the billed write operations per second is 45 (13,686 / 300 = 45.62). Note that `VolumeReadIOPs` and `VolumeWriteIOPs` metrics are calculated by the DocumentDB storage layer and it includes IOs performed by the primary and replica instances. The data is aggregated every 20-30 minutes and then reported at 5-minute intervals, thus emitting the same data point for the metric in the time period. If you are looking for a metric to correlate to your insert operations over a 1-minute interval, you can use the instance level `WriteIOPS` metric. The metric is available in the monitoring tab of your Amazon DocumentDB primary instance.
Cache Hit Ratio (%)	`BufferCacheHitRatio`	The percentage of requests that are served by the buffer cache.
Cache Hit Ratio (%)	`IndexBufferCacheHitRatio`	The percentage 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. This will automatically be corrected after 60 seconds. This limitation will be fixed in a future patch update.
Concurrent Write Requests Count	`DiskQueueDepth`	The number of concurrent write requests to the distributed storage volume.
Engine Up Time (s)	`EngineUptime`	The amount of time in seconds that the instance has been running.
Number of CPU Credits	`CPUSurplusCreditBalance`	The number of surplus CPU credits spent to sustain CPU performance when the `CPUCreditBalance` value is zero.
	`CPUCreditBalance`	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.
	`CPUSurplusCreditsCharged`	The number of surplus CPU credits exceeding the maximum number of CPU credits that can be earned in a 24-hour period, and thus attracting an additional charge.
Number of Documents	`DocumentsDeleted`	The number of deleted documents in a one-minute period.
	`DocumentsInserted`	The number of inserted documents in a one-minute period.
	`DocumentsReturned`	The number of returned documents in a one-minute period.
	`DocumentsUpdated`	The number of updated documents in a one-minute period.
	`TTLDeletedDocuments`	The number of documents deleted by a TTLMonitor in a one-minute period.
Operation Counters	`OpcountersCommand`	The number of commands issued in a one-minute period.
	`OpcountersDelete`	The number of delete operations issued in a one-minute period.
	`OpcountersGetmore`	The number of getmores issued in a one-minute period.
	`OpcountersInsert`	The number of insert operations issued in a one-minute period.
	`OpcountersQuery`	The number of queries issued in a one-minute period.
	`OpcountersUpdate`	The number of update operations issued in a one-minute period.
Number of Transactions (Count)	`TransactionsStarted`	The number of transactions started on an instance in a one-minute period.
	`TransactionsCommitted`	The number of transactions committed on an instance in a one-minute period.
	`TransactionsAborted`	The number of transactions aborted on an instance in a one-minute period.

Display Name	Source Metric Name	Description
Primary Instance Freeable Memory (Bytes)	`PrimaryInstanceFreeableMemory`	Freeable memory of the primary instance.
Replica Instance Freeable Memory (Bytes)	`ReplicaInstanceCPUUtilization`	Freeable memory of the replica instance.
Primary Instance CPU Utilization (%)	`PrimaryInstanceCPUUtilization`	The percentage of CPU used by a primary instance.
Replica Instance CPU Utilization (%)	`ReplicaInstanceCPUUtilization`	The percentage of CPU used by a replica instance.
Cache Hit Ratio (%)	`BufferCacheHitRatio`	The percentage of requests that are served by the buffer cache.
Number of Documents	`DocumentsDeleted`	The number of deleted documents in a one-minute period.
	`DocumentsInserted`	The number of inserted documents in a one-minute period.
	`DocumentsReturned`	The number of returned documents in a one-minute period.
	`DocumentsUpdated`	The number of updated documents in a one-minute period.
	`TTLDeletedDocuments`	The number of documents deleted by a TTLMonitor in a one-minute period.
Max Database Cursors (Count)	`DatabaseCursorsMax`	The maximum number of open cursors on an instance in a one-minute period.
Timed Out Database Cursors (Count)	`DatabaseCursorsTimedOut`	The number of cursors that timed out in a one-minute period.
Average Volume Operations (Count)	`VolumeReadIOPs`	The average number of billed read I/O operations from a cluster 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. You can determine the amount of billed read operations per second by taking the value of the billed read operations metric and dividing by 300 seconds. For example, if the `VolumeReadIOPs` returns 13,686, then the billed read operations per second is 45 (13,686 / 300 = 45.62). You accrue billed read operations for queries that request database pages that are not present in the buffer cache and therefore must be loaded from storage. You might see spikes in billed read operations as query results are read from storage and then loaded into the buffer cache.
Average Volume Operations (Count)	`VolumeWriteIOPs`	The average number of billed write I/O operations from a cluster 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. The value is calculated by taking the value of the write operations metric over a 5-minute period. You can determine the amount of billed write operations per second by taking the value of the billed write operations metric and dividing by 300 seconds. For example, if the `VolumeWriteIOPs` returns 13,686, then the billed write operations per second is 45 (13,686 / 300 = 45.62). Note that `VolumeReadIOPs` and `VolumeWriteIOPs` metrics are calculated by the DocumentDB storage layer and it includes IOs performed by the primary and replica instances. The data is aggregated every 20-30 minutes and then reported at 5-minute intervals, thus emitting the same data point for the metric in the time period. If you are looking for a metric to correlate to your insert operations over a 1-minute interval, you can use the instance level `WriteIOPS` metric. The metric is available in the monitoring tab of your Amazon DocumentDB primary instance.
Volume Usage (Bytes)	`VolumeBytesUsed`	The amount of storage used by your cluster in bytes. This value affects the cost of the cluster.
Replication Lag (ms)	`DBInstanceReplicaLag`	The amount of lag, in milliseconds, when replicating updates from the primary instance to a replica instance.
Operation Counters	`OpcountersCommand`	The number of commands issued in a one-minute period.
	`OpcountersDelete`	The number of delete operations issued in a one-minute period.
	`OpcountersGetmore`	The number of getmores issued in a one-minute period.
	`OpcountersInsert`	The number of insert operations issued in a one-minute period.
	`OpcountersQuery`	The number of queries issued in a one-minute period.

Properties (Attributes)

Cisco Cloud Observability displays the following properties for Amazon DocumentDB.

Display Name	Property Name	Description
ARN	`aws.docdb_instance.arn`	The Amazon Resource Name (ARN) for the instance.
Identifier	`aws.docdb_instance.identifier`	Contains a user-provided database identifier. This identifier is the unique key that identifies an instance.
Cluster Identifier	`aws.docdb_instance.cluster.identifier`	Contains the name of the cluster that the instance is a member of if the instance is a member of a cluster.
Backup Retention Period	`aws.docdb_instance.backup_retention_period`	The number of days for which automatic snapshots are retained.
Create Time	`aws.docdb_instance.create_time`	Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
Certificate Identifier	`aws.docdb_instance.ca_certificate.identifier`	The identifier of the CA certificate for this DB instance.
Endpoint	`aws.docdb_instance.endpoint`	Specifies the connection endpoint.
KMS Key Id	`aws.docdb_instance.kms_key_id`	If `StorageEncrypted` is true, the AWS KMS key identifier for the encrypted instance.
Status	`aws.docdb_instance.status`	Specifies the current state of this database.
Engine	`aws.docdb_instance.engine`	Provides the name of the database engine to be used for this instance.
Engine Version	`aws.docdb_instance.engine_version`	Indicates the database engine version.
Latest Restorable Time	`aws.docdb_instance.latest_restorable_time`	Specifies the latest time to which a database can be restored with point-in-time restore.
Preferred Backup Window	`aws.docdb_instance.preferred_backup_window`	Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.
Subnet Ids	`aws.docdb_instance.subnet_ids`	Specifies information on the subnet group that is associated with the instance, including the name, description, and subnets in the subnet group.
Is Storage Encrypted	`aws.docdb_instance.is_storage_encrypted`	Specifies whether or not the instance is encrypted.

Display Name	Property Name	Description
ARN	`aws.docdb_cluster.arn`	The Amazon Resource Name (ARN) for the cluster.
Identifier	`aws.docdb_instance_cluster.identifier`	Contains a user-supplied cluster identifier. This identifier is the unique key that identifies a cluster.
Multi-AZ	`aws.docdb_instance_cluster.multiAz`	Specifies whether the cluster has instances in multiple Availability Zones.
Availability Zones	`aws.docdb_instance_cluster.availability_zones`	Provides the list of Amazon EC2 Availability Zones that instances in the cluster can be created in.
Backup Retention Period	`aws.docdb_cluster.backup_retention_period`	The number of days for which automatic snapshots are retained.
Create Time	`aws.docdb_cluster.create_time`	Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
Endpoint	`aws.docdb_cluster.endpoint`	The URL used to connect to the cluster.
KMS Key Id	`aws.docdb_cluster.kms_key_id`	The Amazon Resource Name (ARN) for the KMS key used to encrypt the cluster.
Status	`aws.docdb_cluster.status`	Specifies the current state of this cluster.
Preferred Maintenance Window	`aws.docdb_cluster.preferred_maintenance_window`	Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Preferred Backup Window	`aws.docdb_cluster.preferred_backup_window`	Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.
Security Groups	`aws.docdb_cluster.security_groups`	Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
Subnet Ids	`aws.docdb_cluster.subnet_ids`	Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.
Deletion Protection	`aws.docdb_instance_cluster.deletion_protection`	Specifies whether this cluster can be deleted. If `DeletionProtection` is enabled, the cluster cannot be deleted unless it is modified and `DeletionProtection` is disabled. `DeletionProtection` protects clusters from being accidentally deleted.
Earliest Restorable Time	`aws.docdb_instance_cluster.earliest_restorable_time`	The earliest time to which a database can be restored with point-in-time restore.
Latest Restorable Time	`aws.docdb_instance_cluster.latest_restorable_time`	Specifies the latest time to which a database can be restored with point-in-time restore.
Engine	`aws.docdb_instance_cluster.engine`	Provides the name of the database engine to be used for this cluster.
Engine Version	`aws.docdb_instance_cluster.engine_version`	Indicates the database engine version.
Port	`aws.docdb_instance_cluster.port`	Specifies the port that the database engine is listening on.
Storage Encrypted	`aws.docdb_instance_cluster.is_storage_encrypted`	Specifies whether the cluster is encrypted.
Storage Type	`aws.docdb_instance_cluster.storage_type`	Storage type associated with your cluster.
Replication Source Identifier	`aws.docdb_instance_cluster.replication_source_identifier`	Contains the identifier of the source cluster if this cluster is a secondary cluster.

Display Name	Property Name	Description
Name	`aws.docdb_elastic_cluster.name`	The name of the elastic cluster.
ARN	`aws.docdb_cluster.arn`	The Amazon Resource Name (ARN) for the cluster.
Shard Capacity	`aws.docdb_elastic_cluster.shard.capacity`	The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.
Shard Count	`aws.docdb_elastic_cluster.shard.count`	The number of shards assigned to the elastic cluster. Maximum is 32.
Shard Instance Count	`aws.docdb_elastic_cluster.shard.instance_count`	The number of replica instances applying to all shards in the cluster. A `shardInstanceCount` value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.
Backup Retention Period	`aws.docdb_cluster.backup_retention_period`	The number of days for which automatic snapshots are retained.
Create Time	`aws.docdb_cluster.create_time`	Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
Endpoint	`aws.docdb_cluster.endpoint`	The URL used to connect to the cluster.
KMS Key Id	`aws.docdb_cluster.kms_key_id`	The Amazon Resource Name (ARN) for the KMS key used to encrypt the cluster.
Status	`aws.docdb_cluster.status`	Specifies the current state of this cluster.
Preferred Maintenance Window	`aws.docdb_cluster.preferred_maintenance_window`	Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
Preferred Backup Window	`aws.docdb_cluster.preferred_backup_window`	Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod`.
Security Groups	`aws.docdb_cluster.security_groups`	Provides a list of virtual private cloud (VPC) security groups that the cluster belongs to.
Subnet Ids	`aws.docdb_cluster.subnet_ids`	Specifies information on the subnet group that is associated with the cluster, including the name, description, and subnets in the subnet group.

Retention and Purge Time-To-Live (TTL)

For all cloud and infrastructure entities, the retention TTL is 180 minutes (3 hours) and the purge TTL is 525,600 minutes (365 days).

Amazon Web Services, the AWS logo, AWS, and any other AWS Marks used in these materials are trademarks of Amazon.com, Inc. or its affiliates in the United States and/or other countries.