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.

A DocumentDB cluster consists of:

  • 0 to 16 instances.
  • A cluster storage volume that manages the data for those instances.

Also,

  • All writes are done through the primary instance.
  • All instances (primary and replicas) support reads.
  • Cluster data is stored in the cluster volume with copies in three (3) different availability zones.

See Cluster metrics.

An Amazon DocumentDB instance is an isolated database environment in the cloud.

An instance has the following capability:

  • Setup of multiple user-created databases.
  • Selection of computation and memory capacity of an instance using the instance class.

For example, you can select the instance that best meets your needs and if your needs change, you can choose a different instance class.

See Instance metrics.

Use the AWS public cloud integration to discover and collect metrics against the AWS service.

External reference

What is DocumentDB (clusters)?

Setup

To set up the AWS integration and discover the AWS service, go to AWS Integration Discovery Profile and select DocDB Cluster.

Event support

CloudTrail event support

  • Not Supported

CloudWatch alarm support

  • Supported
  • Configurable in OpsRamp AWS Integration Discovery Profile.

Supported metrics

Cluster metrics

OpsRamp MetricMetric Display NameUnitAggregation Type
aws_docdb_BackupRetentionPeriodStorageUsed

To support the point-in-time restore feature within Amazon DocumentDBs retention window. Total amount of backup storage in GiB used is included in the total reported by the TotalBackupStorageBilled metric.
BackupRetentionPeriodStorageUsedBytesAverage
aws_docdb_BufferCacheHitRatio

Percentage of requests that are served by the buffer cache.
BufferCacheHitRatioPercentAverage
aws_docdb_ChangeStreamLogSize

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. Change stream log size is a function of substantial change happening on your cluster and the change stream long retention duration.
ChangeStreamLogSizeMegabytesAverage
aws_docdb_DBInstanceReplicaLag

The amount of lag in milliseconds when replicating updates from the primary instance to a replica instance.
DBInstanceReplicaLagMillisecondsAverage
aws_docdb_DBClusterReplicaLagMaximum

Maximum amount of lag in milliseconds between the primary instance and each Amazon DocumentDB instance in the cluster.
DBClusterReplicaLagMaximumMillisecondsAverage
aws_docdb_DBClusterReplicaLagMinimum

Minimum amount of lag in milliseconds between the primary instance and each replica instance in the cluster.
DBClusterReplicaLagMinimumMillisecondsAverage
aws_docdb_DiskQueueDepth

The number of concurrent write requests to the distributed storage volume.
DiskQueueDepthCountAverage
aws_docdb_EngineUptime

Amount of time in seconds that the instance has been running.
EngineUptimeSecondsAverage
aws_docdb_FreeableMemory

Amount of available random access memory (in bytes).
FreeableMemoryBytesAverage
aws_docdb_FreeLocalStorage

The metric reports the amount of storage available to each instance for temporary tables and logs. Increase the amount of free storage space for an instance by choosing a larger instance class for your instance.Value depends on the instance class.
FreeLocalStorageBytesAverage
aws_docdb_NetworkReceiveThroughput

Amount of network throughput in bytes per second, received from clients by each instance in the cluster.
NetworkReceiveThroughputBytes/SecondAverage
aws_docdb_NetworkThroughput

Amount of network throughput in bytes per second, received from and transmitted to clients by each instance in the Amazon DocumentDB cluster.
NetworkThroughputBytes/SecondAverage
aws_docdb_NetworkTransmitThroughput

Amount of network throughput in bytes per second, sent to clients by each instance in the cluster.
NetworkTransmitThroughputBytes/SecondAverage
aws_docdb_ReadLatency

Average amount of time taken per disk I/O operation.
ReadLatencySecondsAverage
aws_docdb_ReadThroughput

Average number of bytes read from disk per second.
ReadThroughputBytes/SecondAverage
aws_docdb_SnapshotStorageUsed

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.
SnapshotStorageUsedBytesAverage
aws_docdb_SwapUsage

Amount of swap space used on the instance.
SwapUsageBytesAverage
aws_docdb_TotalBackupStorageBilled

Total amount of backup storage in GiB for which you are billed for a given Amazon DocumentDB cluster. Includes backup storage measured by the BackupRetentionPeriodStorageUsed and SnapshotStorageUsed metrics.
TotalBackupStorageBilledBytesAverage
aws_docdb_VolumeBytesUsed

Amount of storage used by your cluster in bytes.
Note: This value affects the cost of the cluster.
VolumeBytesUsedBytesAverage
aws_docdb_VolumeReadIOPs

The average number of billed read I/O operations from a cluster volume. Billed read operations are calculated at the cluster volume level, aggregated from all instances in the cluster, and then reported at 5-minute intervals.
VolumeReadIOPsCountAverage
aws_docdb_VolumeWriteIOPs

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. Value is calculated by the value of the write operations metric over a 5-minute period.
VolumeWriteIOPsCountAverage
aws_docdb_WriteLatency

Average amount of time in milliseconds taken per disk I/O operation.
WriteLatencySecondsAverage
aws_docdb_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.
WriteIOPSCount/SecondAverage
aws_docdb_WriteThroughput

Average number of bytes written to disk per second.
WriteThroughputBytes/SecondAverage
aws_docdb_CPUUtilization

Percentage of CPU used by an instance.
CPUUtilizationPercentAverage
cloud.instance.state

Status/State
Status/Staten/an/a

Instance metrics

OpsRamp MetricMetric Display NameUnitAggregation Type
aws_docdb_ChangeStreamLogSize

Total amount of backup storage in GiB used to support the point-in-time restore feature within the Amazon DocumentDBs retention window.Included in the total reported by the TotalBackupStorageBilled metric.
ChangeStreamLogSizeMegabytesAverage
aws_docdb_DatabaseConnections

Number of connections open on an instance taken at a 1-minute frequency.
DatabaseConnectionsCountAverage
aws_docdb_FreeLocalStorage

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.
FreeLocalStorageBytesAverage
aws_docdb_FreeableMemory

Amount of available random access memory (in bytes).
FreeableMemoryBytesAverage
aws_docdb_WriteIOPS

Average number of disk write I/O operations per second. On a cluster level, WriteIOPs are evaluated across all instances in the cluster. Read and write IOPS are reported separately on 1-minute intervals.
WriteIOPSCount/SecondAverage
aws_docdb_ReadIOPS

Average number of disk read I/O operations per second.
ReadIOPSCount/SecondAverage
aws_docdb_WriteLatency

Average amount of time (in milliseconds) taken per disk I/O operation.
WriteLatencySecondsAverage
aws_docdb_ReadLatency

Average amount of time taken per disk I/O operation.
ReadLatencySecondsAverage
aws_docdb_WriteThroughput

Average number of bytes written to disk per second.
WriteThroughputBytes/SecondAverage
aws_docdb_ReadThroughput

Average number of bytes read from disk per second.
ReadThroughputBytes/SecondAverage
aws_docdb_NetworkThroughput

Amount of network throughput (in bytes per second), both received from and transmitted to clients by each instance in the Amazon DocumentDB cluster.
NetworkThroughputBytes/SecondAverage
aws_docdb_NetworkTransmitThroughput

Amount of network throughput (in bytes per second), sent to clients by each instance in the cluster.
NetworkTransmitThroughputBytes/SecondAverage
aws_docdb_NetworkReceiveThroughput

Amount of network throughput (in bytes per second), received from clients by each instance in the cluster.
NetworkReceiveThroughputBytes/SecondAverage
aws_docdb_EngineUptime

Amount of time (in seconds) that the instance has been running.
EngineUptimeSecondsAverage
aws_docdb_SwapUsage

Amount of swap space used on the instance.
SwapUsageBytesAverage
aws_docdb_DiskQueueDepth

Number of concurrent write requests to the distributed storage volume.
DiskQueueDepthCountAverage
aws_docdb_BufferCacheHitRatio

Percentage of requests that are served by the buffer cache.
BufferCacheHitRatioPercentAverage
aws_docdb_BackupRetentionPeriodStorageUsed

Total amount of backup storage in GiB used to support the point-in-time restore feature within the Amazon DocumentDBs retention window, included in the total reported by the TotalBackupStorageBilled metric.
BackupRetentionPeriodStorageUsedBytesAverage
aws_docdb_SnapshotStorageUsed

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.
SnapshotStorageUsedBytesAverage
aws_docdb_TotalBackupStorageBilled

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.
TotalBackupStorageBilledBytesAverage
aws_docdb_CPUUtilization

Percentage of CPU used by an instance' where name.
CPUUtilizationPercentAverage
cloud.instance.state

Status/State
Status/Staten/an/a