Documentation forAppOptics

DocumentDB

Overview

Amazon DocumentDB (with MongoDB compatibility) is a fast, reliable, and fully managed database service. Amazon DocumentDB makes it easy to set up, operate, and scale MongoDB-compatible databases in the cloud. With Amazon DocumentDB, you can run the same application code and use the same drivers and tools that you use with MongoDB.

Setup

Installation

If you haven't already, first set up the AWS CloudWatch integration. No additional steps are needed for installation.

Configuration

On the AWS CloudWatch integration page, ensure that the DocumentDB service is selected for metric collection.

Metrics

Name Description
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.
BufferCacheHitRatio The percentage of requests that are served by the buffer cache.
CPUUtilization The percentage of CPU used by an instance.
DatabaseConnections The number of connections to an instance.
DBInstanceReplicaLag The amount of lag (in milliseconds) when replicating updates from the primary instance to a replica instance.
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.
DiskQueueDepth The number of outstanding read/write requests waiting to access the disk.
EngineUptime The amount of time (in seconds) that the instance has been running.
FreeableMemory The amount of available random access memory (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.
NetworkReceiveThroughput The amount of network throughput (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.
NetworkThroughput The amount of network throughput (bytes per second) both received from and transmitted to clients by each instance in the Amazon DocumentDB cluster. This throughput doesn't include network traffic between instances in the cluster and the cluster volume.
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.
ReadIOPS The average number of disk I/O operations per second. Amazon DocumentDB reports read and write IOPS separately and on one-minute intervals.
ReadLatency The average amount of time taken per disk I/O operation.
ReadThroughput The average number of bytes read from disk per second.
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.
SwapUsage The amount of swap space used on the instance.
TotalBackupStorageBilled The total amount of backup storage in GiB for which you are billed for a given Amazon DocumentDB cluster. Includes the backup storage measured by the BackupRetentionPeriodStorageUsed and SnapshotStorageUsed metrics. Computed separately for each Amazon DocumentDB cluster.
VolumeBytesUsed The amount of storage (in bytes) used by your cluster (in bytes).
VolumeReadIOPs The average number of billed read I/O operations from a cluster volume (reported at 5-minute intervals).
VolumeWriteIOPs The average number of disk I/O operations per second. Read and write IOPS are reported separately and on 1-minute intervals.
WriteIOPS The average number of disk I/O operations per second. Read and write IOPS are reported separately.
WriteLatency The average amount of time (in milliseconds) taken per disk I/O operation.
WriteThroughput The average number of bytes written to disk per second.

Available Tags

Name Description
dbclusteridentifier The DB cluster ID
role The role (writer or reader)
region The region for the instances and cluster
awsaccount AWS account associated with the metrics

Navigation Notice: When the APM Integrated Experience is enabled, SolarWinds Template Product shares a common navigation and enhanced feature set with other integrated experience products. How you navigate SolarWinds Template Product and access its features may vary from these instructions.