Amazon DocumentDB monitoring integration

Important

Enable the AWS CloudWatch Metric Streams integration to monitor all CloudWatch metrics from your AWS services, including custom namespaces. Individual integrations are no longer our recommended option.

New Relic offers an integration for reporting your Amazon DocumentDB data. This document explains how to activate this integration and describes the data that can be reported.

Activate integration

To enable this integration follow standard procedures to Connect AWS services to New Relic.

Configuration and polling

You can change the polling frequency and filter data using configuration options.

Default polling information for the Amazon DocumentDB integration:

New Relic polling interval: 5 minutes
Amazon CloudWatch data interval: 1 minute

Find and use data

To find your integration data, go to one.newrelic.com > All capabilities > Infrastructure > AWS and select an integration.

You can query and explore your data using the following event type:

Entity	Event Type	Provider
Cluster	`AwsDocDbClusterSample`	`AwsDocDbCluster`
ClusterByRole	`AwsDocDbClusterByRoleSample`	`AwsDocDbClusterByRole`
Instance	`AwsDocDbInstanceSample`	`AwsDocDbInstance`

For more on how to use your data, see Understand and use integration data.

Metric data

This integration collects Amazon DocumentDB data for Cluster, ClusterByRole, and Instance.

DocumentDB Cluster data

Metric	Unit	Description
`CPUUtilization`	Percent	The percentage of CPU used by an instance.
`DatabaseConnections`	Count	The number of connections to an instance.
`FreeLocalStorage`	Bytes	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.
`FreeableMemory`	Bytes	The amount of available random access memory, in bytes.
`WriteIOPS`	CountPerSecond	The average number of disk write I/O operations per second. Read and write IOPS are reported separately, on 1-minute intervals.
`ReadIOPS`	CountPerSecond	The average number of disk read I/O operations per second. Amazon DocumentDB reports read and write IOPS separately, and on one-minute intervals.
`WriteLatency`	Milliseconds	The average amount of time, in milliseconds, taken per disk I/O operation.
`ReadLatency`	Milliseconds	The average amount of time taken per disk I/O operation, in milliseconds.
`WriteThroughput`	Bytes	The average number of bytes written to disk per second.
`ReadThroughput`	Bytes	The average number of bytes read from disk per second.
`NetworkThroughput`	Bytes	The amount of network throughput, in 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`	Bytes	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.
`NetworkReceiveThroughput`	Bytes	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.
`EngineUptime`	Seconds	The amount of time, in seconds, that the instance has been running.
`SwapUsage`	Bytes	The amount of swap space used on the instance.
`DiskQueueDepth`	Count	The number of outstanding read/write requests waiting to access the disk.
`BufferCacheHitRatio`	Percent	The percentage of requests that are served by the buffer cache.
`BackupRetentionPeriodStorageUsed`	Bytes	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.
`SnapshotStorageUsed`	Bytes	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.
`TotalBackupStorageBilled`	Bytes	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.
`DBInstanceReplicaLag`	Milliseconds	The amount of lag, in milliseconds, when replicating updates from the primary instance to a replica instance.
`DBClusterReplicaLagMaximum`	Milliseconds	The maximum amount of lag, in milliseconds, between the primary instance and each Amazon DocumentDB instance in the cluster.
`DBClusterReplicaLagMinimum`	Milliseconds	The minimum amount of lag, in milliseconds, between the primary instance and each replica instance in the cluster.
`VolumeBytesUsed`	Bytes	The amount of storage, in bytes, used by your cluster, in bytes. This value affects the cost of the cluster (for pricing information, see the Amazon DocumentDB product page).
`VolumeReadIOPs`	Count	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 billed read operations 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.
`VolumeWriteIOPs`	Count	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 billed write operations returns 13,686, then the billed write operations per second is 45 (13,686 / 300 = 45.62).

DocumentDB ClusterByRole data

Metric	Unit	Description
`CPUUtilization`	Percent	The percentage of CPU used by an instance.
`DatabaseConnections`	Count	The number of connections to an instance.
`FreeLocalStorage`	Bytes	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.
`FreeableMemory`	Bytes	The amount of available random access memory, in bytes.
`WriteIOPS`	CountPerSecond	The average number of disk write I/O operations per second. Read and write IOPS are reported separately, on 1-minute intervals.
`ReadIOPS`	CountPerSecond	The average number of disk read I/O operations per second. Amazon DocumentDB reports read and write IOPS separately, and on one-minute intervals.
`WriteLatency`	Milliseconds	The average amount of time, in milliseconds, taken per disk I/O operation.
`ReadLatency`	Milliseconds	The average amount of time taken per disk I/O operation, in milliseconds.
`WriteThroughput`	Bytes	The average number of bytes written to disk per second.
`ReadThroughput`	Bytes	The average number of bytes read from disk per second.
`NetworkThroughput`	Bytes	The amount of network throughput, in 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`	Bytes	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.
`NetworkReceiveThroughput`	Bytes	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.
`EngineUptime`	Seconds	The amount of time, in seconds, that the instance has been running.
`SwapUsage`	Bytes	The amount of swap space used on the instance.
`DiskQueueDepth`	Count	The number of outstanding read/write requests waiting to access the disk.
`BufferCacheHitRatio`	Percent	The percentage of requests that are served by the buffer cache.
`BackupRetentionPeriodStorageUsed`	Bytes	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.
`SnapshotStorageUsed`	Bytes	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.
`TotalBackupStorageBilled`	Bytes	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.
`DBInstanceReplicaLag`	Milliseconds	The amount of lag, in milliseconds, when replicating updates from the primary instance to a replica instance.
`DBClusterReplicaLagMaximum`	Milliseconds	The maximum amount of lag, in milliseconds, between the primary instance and each Amazon DocumentDB instance in the cluster.
`DBClusterReplicaLagMinimum`	Milliseconds	The minimum amount of lag, in milliseconds, between the primary instance and each replica instance in the cluster.
`VolumeBytesUsed`	Bytes	The amount of storage, in bytes, used by your cluster, in bytes. This value affects the cost of the cluster (for pricing information, see the Amazon DocumentDB product page).
`VolumeReadIOPs`	Count	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 billed read operations 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.
`VolumeWriteIOPs`	Count	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 billed write operations returns 13,686, then the billed write operations per second is 45 (13,686 / 300 = 45.62).

DocumentDB Instance data

Metric	Unit	Description
`CPUUtilization`	Percent	The percentage of CPU used by an instance.
`DatabaseConnections`	Count	The number of connections to an instance.
`FreeLocalStorage`	Bytes	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.
`FreeableMemory`	Bytes	The amount of available random access memory, in bytes.
`WriteIOPS`	CountPerSecond	The average number of disk write I/O operations per second. Read and write IOPS are reported separately, on 1-minute intervals.
`ReadIOPS`	CountPerSecond	The average number of disk read I/O operations per second. Amazon DocumentDB reports read and write IOPS separately, and on one-minute intervals.
`WriteLatency`	Milliseconds	The average amount of time, in milliseconds, taken per disk I/O operation.
`ReadLatency`	Milliseconds	The average amount of time taken per disk I/O operation, in milliseconds.
`WriteThroughput`	Bytes	The average number of bytes written to disk per second.
`ReadThroughput`	Bytes	The average number of bytes read from disk per second.
`NetworkThroughput`	Bytes	The amount of network throughput, in 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`	Bytes	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.
`NetworkReceiveThroughput`	Bytes	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.
`EngineUptime`	Seconds	The amount of time, in seconds, that the instance has been running.
`SwapUsage`	Bytes	The amount of swap space used on the instance.
`DiskQueueDepth`	Count	The number of outstanding read/write requests waiting to access the disk.
`BufferCacheHitRatio`	Percent	The percentage of requests that are served by the buffer cache.
`BackupRetentionPeriodStorageUsed`	Bytes	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.
`SnapshotStorageUsed`	Bytes	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.
`TotalBackupStorageBilled`	Bytes	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.
`DBInstanceReplicaLag`	Milliseconds	The amount of lag, in milliseconds, when replicating updates from the primary instance to a replica instance.
`DBClusterReplicaLagMaximum`	Milliseconds	The maximum amount of lag, in milliseconds, between the primary instance and each Amazon DocumentDB instance in the cluster.
`DBClusterReplicaLagMinimum`	Milliseconds	The minimum amount of lag, in milliseconds, between the primary instance and each replica instance in the cluster.
`VolumeBytesUsed`	Bytes	The amount of storage, in bytes, used by your cluster, in bytes. This value affects the cost of the cluster (for pricing information, see the Amazon DocumentDB product page).
`VolumeReadIOPs`	Count	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 billed read operations 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.
`VolumeWriteIOPs`	Count	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 billed write operations returns 13,686, then the billed write operations per second is 45 (13,686 / 300 = 45.62).