Introduction
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.
DocumentDB cluster
A cluster consists of:
- 0 to 16 instances.
- A cluster storage volume that manages the data for those instances.
In addition:
- All writes are done through the primary instance.
- All instances (primary and replicas) support reads.
- Cluster’s data is stored in the cluster volume with copies in three (3) different availability zones.
DocumentDB instance
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.
Note
Use the OpsRamp AWS public cloud integration to discover and collect metrics against the AWS service.Setup
To set up the OpsRamp AWS integration and discover the AWS service,
go to AWS Integration Discovery Profile and select DocDB Cluster.
Metrics
Cluster metrics
| OpsRamp Metric | Metric Display Name | Unit | Aggregation Type | Description |
|---|---|---|---|---|
| aws_docdb_BackupRetentionPeriodStorageUsed | BackupRetentionPeriodStorageUsed | Bytes | Average | BackupRetentionPeriodStorageUsed |
| aws_docdb_BufferCacheHitRatio | BufferCacheHitRatio | Percent | Average | BufferCacheHitRatio |
| aws_docdb_ChangeStreamLogSize | ChangeStreamLogSize | Megabytes | Average | ChangeStreamLogSize |
| aws_docdb_DBInstanceReplicaLag | DBInstanceReplicaLag | Milliseconds | Average | DBInstanceReplicaLag |
| aws_docdb_DBClusterReplicaLagMaximum | DBClusterReplicaLagMaximum | Milliseconds | Average | DBClusterReplicaLagMaximum |
| aws_docdb_DBClusterReplicaLagMinimum | DBClusterReplicaLagMinimum | Milliseconds | Average | DBClusterReplicaLagMinimum |
| aws_docdb_DiskQueueDepth | DiskQueueDepth | Count | Average | DiskQueueDepth |
| aws_docdb_EngineUptime | EngineUptime | Seconds | Average | EngineUptime |
| aws_docdb_FreeableMemory | FreeableMemory | Bytes | Average | FreeableMemory |
| aws_docdb_FreeLocalStorage | FreeLocalStorage | Bytes | Average | FreeLocalStorage |
| aws_docdb_NetworkReceiveThroughput | NetworkReceiveThroughput | Bytes/Second | Average | NetworkReceiveThroughput |
| aws_docdb_NetworkThroughput | NetworkThroughput | Bytes/Second | Average | NetworkThroughput |
| aws_docdb_NetworkTransmitThroughput | NetworkTransmitThroughput | Bytes/Second | Average | NetworkTransmitThroughput |
| aws_docdb_ReadLatency | ReadLatency | Seconds | Average | ReadLatency |
| aws_docdb_ReadThroughput | ReadThroughput | Bytes/Second | Average | ReadThroughput |
| aws_docdb_SnapshotStorageUsed | SnapshotStorageUsed | Bytes | Average | SnapshotStorageUsed |
| aws_docdb_SwapUsage | SwapUsage | Bytes | Average | SwapUsage |
| aws_docdb_TotalBackupStorageBilled | TotalBackupStorageBilled | Bytes | Average | TotalBackupStorageBilled |
| aws_docdb_VolumeBytesUsed | VolumeBytesUsed | Bytes | Average | VolumeBytesUsed |
| aws_docdb_VolumeReadIOPs | VolumeReadIOPs | Count | Average | VolumeReadIOPs |
| aws_docdb_VolumeWriteIOPs | VolumeWriteIOPs | Count | Average | VolumeWriteIOPs |
| aws_docdb_WriteLatency | WriteLatency | Seconds | Average | WriteLatency |
| aws_docdb_WriteIOPS | WriteIOPS | Count/Second | Average | WriteIOPS |
| aws_docdb_WriteThroughput | WriteThroughput | Bytes/Second | Average | WriteThroughput |
| aws_docdb_CPUUtilization | Percent | Average | CPUUtilization | |
| cloud.instance.state | Status/State | n/a | n/a | Status/State |
Instance metrics
| OpsRamp Metric | Metric Display Name | Unit | Aggregation Type | Description |
|---|---|---|---|---|
| aws_docdb_ChangeStreamLogSize | ChangeStreamLogSize | Megabytes | Average | ChangeStreamLogSize |
| aws_docdb_DatabaseConnections | DatabaseConnections | Count | Average | DatabaseConnections |
| aws_docdb_FreeLocalStorage | FreeLocalStorage | Bytes | Average | FreeLocalStorage |
| aws_docdb_FreeableMemory | FreeableMemory | Bytes | Average | FreeableMemory |
| aws_docdb_WriteIOPS | WriteIOPS | Count/Second | Average | WriteIOPS |
| aws_docdb_ReadIOPS | ReadIOPS | Count/Second | Average | ReadIOPS |
| aws_docdb_WriteLatency | WriteLatency | Seconds | Average | WriteLatency |
| aws_docdb_ReadLatency | ReadLatency | Seconds | Average | ReadLatency |
| aws_docdb_WriteThroughput | WriteThroughput | Bytes/Second | Average | WriteThroughput |
| aws_docdb_ReadThroughput | ReadThroughput | Bytes/Second | Average | ReadThroughput |
| aws_docdb_NetworkThroughput | NetworkThroughput | Bytes/Second | Average | NetworkThroughput |
| aws_docdb_NetworkTransmitThroughput | NetworkTransmitThroughput | Bytes/Second | Average | NetworkTransmitThroughput |
| aws_docdb_NetworkReceiveThroughput | NetworkReceiveThroughput | Bytes/Second | Average | NetworkReceiveThroughput |
| aws_docdb_EngineUptime | EngineUptime | Seconds | Average | EngineUptime |
| aws_docdb_SwapUsage | SwapUsage | Bytes | Average | SwapUsage |
| aws_docdb_DiskQueueDepth | DiskQueueDepth | Count | Average | DiskQueueDepth |
| aws_docdb_BufferCacheHitRatio | BufferCacheHitRatio | Percent | Average | BufferCacheHitRatio |
| aws_docdb_BackupRetentionPeriodStorageUsed | BackupRetentionPeriodStorageUsed | Bytes | Average | BackupRetentionPeriodStorageUsed |
| aws_docdb_SnapshotStorageUsed | SnapshotStorageUsed | Bytes | Average | SnapshotStorageUsed |
| aws_docdb_TotalBackupStorageBilled | TotalBackupStorageBilled | Bytes | Average | TotalBackupStorageBilled |
| aws_docdb_CPUUtilization | Percent | Average | CPUUtilization | |
| cloud.instance.state | Status/State | n/a | n/a | Status/State |
Event support
CloudTrail event support
- Not Supported
CloudWatch alarm support
- Supported
- Configurable in OpsRamp AWS Integration Discovery Profile.