Amazon RDS monitoring integration | New Relic Documentation

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 infrastructure integrations include an integration for reporting your Amazon Web Services RDS data to New Relic. This document explains how to activate this integration and describes the data that can be reported.

New Relic also offers an integration for enhanced RDS monitoring.

Features

Amazon's Relational Database Service (RDS) is a web service that makes it easier to set up, operate, and scale a relational database in the cloud. It provides cost-efficient, resizable capacity for an industry-standard relational database and manages common database administration tasks.

New Relic's RDS monitoring integration gathers metric and configuration data for the relational databases associated with your Amazon RDS account. Your RDS data is available in pre-built dashboards and you can also create custom queries and charts in New Relic One. You can create alert conditions for RDS data, and use the reported data to plan for future RDS capacity.

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 RDS integration:

New Relic polling interval: 5 minutes
Amazon CloudWatch data interval: 1 minute for RDS instances; 5 minutes for RDS clusters

Find and use data

To find your integration data, go to one.newrelic.com > Infrastructure > AWS and select one of the RDS integration links.

You can query and explore your data using the DatastoreSample event type, with a provider value of RdsDbInstance for DB instances, or RdsDbCluster for Aurora DB clusters.

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

Metric data

This integration collects Amazon RDS data for clusters and also for instances. Some RDS instance metrics are distinct for cluster instances and stand-alone instances.

RDS cluster metric data

Name	Description
`volumeBytesUsed`	Volume bytes used.
`volumeReadIops`	Volume read IOPs.
`volumeWriteIops`	Volume write IOPs.

RDS instance common metric data

Metric	Description
`cpuCreditUsage`	The number of CPU credits consumed during the specified period.
`cpuCreditBalance`	The number of CPU credits that an instance has accumulated.
`cpuUtilization`	The percentage of CPU used by a DB instance.
`databaseConnections`	The number of connections to an instance.
`diskQueueDepth`	The number of outstanding read/write requests waiting to access the disk.
`freeableMemoryBytes`	The amount of available random access memory, in bytes.
`maximumUsedTransactionIDs`	The age of the oldest unvacuumed transaction ID, in transactions.
`networkReceiveThroughput`	The amount of network throughput received from clients by each instance in the Aurora MySQL DB cluster, in bytes per second.
`networkTransmitThroughput`	The amount of network throughput sent to clients by each instance in the Aurora DB cluster, in bytes per second.
`readLatency`	The average amount of time taken per disk I/O operation, in seconds.
`readThroughput`	The average number of bytes read from disk per second.
`swapUsageBytes`	The amount of swap space used on the Aurora PostgreSQL DB instance, in bytes.
`transactionLogsDiskUsageBytes`	The amount of disk space occupied by transaction logs on the Aurora PostgreSQL DB instance, in bytes.

RDS cluster instance data

Metric	Description
`activeTransactions`	The average number of current transactions executing on an Aurora database instance per second.
`auroraReplicaLag`	For an Aurora Replica, the amount of lag when replicating updates from the primary instance, in milliseconds.
`auroraReplicaLagMaximum`	The maximum amount of lag between the primary instance and each Aurora DB instance in the DB cluster, in milliseconds.
`auroraReplicaLagMinimum`	The minimum amount of lag between the primary instance and each Aurora DB instance in the DB cluster, in milliseconds.
`backtrackChangeRecordsCreationRate`	The number of backtrack change records created over five minutes for your DB cluster.
`backtrackChangeRecordsStored`	The actual number of backtrack change records used by your DB cluster.
`backtrackWindowActual`	The difference between the target backtrack window and the actual backtrack window.
`backtrackWindowAlert`	The number of times that the actual backtrack window is smaller than the target backtrack window for a given period of time.
`blockedTransactions`	The average number of transactions in the database that are blocked per second.
`bufferCacheHitRatio`	The percentage of requests that are served by the buffer cache.
`commitLatency`	The amount of latency for commit operations, in milliseconds.
`commitThroughput`	The average number of commit operations per second.
`ddlLatency`	The amount of latency for data definition language (DDL) requests, in milliseconds—for example, create, alter, and drop requests.
`ddlThroughput`	The average number of DDL requests per second.
`deadlocks`	The average number of deadlocks in the database per second.
`deleteLatency`	The amount of latency for delete queries, in milliseconds.
`deleteThroughput`	The average number of delete queries per second.
`dmlLatency`	The amount of latency for inserts, updates, and deletes, in milliseconds.
`dmlThroughput`	The average number of inserts, updates, and deletes per second.
`engineUptime`	The amount of time that the instance has been running, in seconds.
`failedSqlStatements`	This metric, displayed under the SQL category of the latest metrics view in the Amazon RDS console, does not apply to Amazon Aurora.
`freeLocalStorageBytes`	The amount of storage available for temporary tables and logs, in bytes.
`insertLatency`	The amount of latency for insert queries, in milliseconds.
`insertThroughput`	The average number of insert queries per second.
`loginFailures`	The average number of failed login attempts per second.
`networkThroughput`	The amount of network throughput both received from and transmitted to clients by each instance in the Aurora MySQL DB cluster, in bytes per second.
`queries`	The average number of queries executed per second.
`rdsToAuroraPostgreSQLReplicaLag`	The amount of lag in seconds when replicating updates from the primary RDS PostgreSQL instance to other nodes in the cluster.
`resultSetCacheHitRatio`	The percentage of requests that are served by the Resultset cache.
`selectLatency`	The amount of latency for select queries, in milliseconds.
`selectThroughput`	The average number of select queries per second.
`totalConnections`	Total number of connections to the database instance.
`updateLatency`	The amount of latency for update queries, in milliseconds.
`updateThroughput`	The average number of update queries per second.
`volumeReadIOPs`	The number of billed read I/O operations from a cluster volume, reported at 5-minute intervals.
`volumeWriteIOPs`	The number of write disk I/O operations to the cluster volume, reported at 5-minute intervals.

RDS stand-alone instance data

Metric	Description
`allocatedStorageBytes`	Specifies the allocated storage size, in bytes. Note this data doesn't come from an AWS CloudWatch metric, but from the `allocatedStorage` inventory attribute.
`binLogDiskUsageBytes`	The amount of disk space occupied by binary logs on the master, in bytes.
`diskQueueDepth`	The number of outstanding read/write requests waiting to access the disk.
`freeStorageSpaceBytes`	The amount of storage available for tables and logs, in bytes.
`maximumUsedTransactionIDs`	The age of the oldest unvacuumed transaction ID, in transactions.
`oldestReplicationSlotLag`	Shows how far behind in seconds the most lagging replica is in terms of WAL data received.
`readIops`	The average number of disk I/O operations per second.
`readLatency`	The average amount of time taken per disk I/O operation.
`readThroughput`	The average number of bytes read from disk per second.
`replicaLag`	The amount of lag when replicating updates from the primary instance, in milliseconds.
`replicationSlotDiskUsage`	The amount of disk space occupied by replication slots.
`swapUsageBytes`	The amount of swap space used on the Aurora PostgreSQL DB instance, in bytes.
`transactionLogsDiskUsage`	The amount of disk space occupied by transaction logs on the Aurora PostgreSQL DB instance.
`transactionLogsGeneration`	How much storage is being used for WAL data.
`writeIops`	The average number of disk I/O operations per second.
`writeLatency`	The average amount of time taken per disk I/O operation.
`writeThroughput`	The average number of bytes written to disk per second.

Inventory data

EOL NOTICE

After March 2022, we're discontinuing support for several capabilities, including inventory data for cloud integrations. For more details, including how you can easily prepare for this transition, see our Explorers Hub post.

This integration supports the following RDS inventory data. For more about inventory data, see Understand integration data.

Tip

Tags (indicated with an *) are only fetched when tags collection is on.

aws/rds/cluster

Name	Description
`allocatedStorage`	The storage space allocated to this instance, in gibibytes.
`autoMinorVersionUpgrade`	Boolean. If `true`, indicates that minor version patches are applied to this instance automatically.
`availabilityZone`	The RDS availability zone for this instance.
`awsRegion`	The RDS region for this instance.
`backupRetentionPeriod`	Count of the number of days RDS preserves automated backups for this instance.
`caCertificateIdentifier`	The CA certificate for this instance.
`dbInstanceClass`	The DB instance class for this instance.
`dbInstancePort`	Integer representing the port where this instance listens for traffic. If the instance is part of a cluster, this port may not be the port assigned to the overall database cluster.
`dbInstanceStatus`	The DB instance status for this instance.
`dbName`	The meaning of this configuration option depends on the database engine: Amazon Aurora, MariaDB, MySQL, PostgreSQL, and SQL Server: Indicates the name specified when the instance was created. Oracle: Indicates the Oracle System ID (SID) for this instance.
`dbParameterGroups`	JSON string that lists DB parameter groups for this instance.
`dbSecurityGroups`	JSON string that lists DB security groups for this instance. Only collects data from the `DBSecurityGroup.Name` and `DBSecurityGroup.Status` sub-elements.
`dbSubnetGroup`	JSON string that lists details about the instance's DB subnet group, including the name and description for each subnet in the subnet group.
`engine`	The name of the database engine running on this instance.
`engineVersion`	The version identifier for the database engine running on this instance.
`licenseModel`	The license identifier for the database engine running on this instance. For example, `general-public-license`.
`multiAz`	Boolean. If `true`, indicates this instance is a multi-availability-zone deployment.
`optionGroupMemberships`	JSON string that lists any option group memberships for this instance.
`publiclyAccessible`	Boolean. If `true`, indicates an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. If `false`, indicates an internal instance with a DNS name that resolves to a private IP address.
`secondaryAvailabilityZone`	If present, indicates the name of the secondary availability zone for a multi-availability-zone deployment.
`storageEncrypted`	Boolean. If `true`, indicates that the database on this instance is encrypted.
`storageType`	Indicates the RDS storage type for this instance.
`vpcSecurityGroups`	JSON string that lists the VPC security groups for this instance.
`tags`*	Cluster tags.

aws/rds/instance

Name	Description
`awsRegion`	The AWS region that the instance was provisioned in.
`dbInstanceIdentifier`	Contains a user-supplied database identifier. This identifier is the unique key that identifies a DB instance.
`allocatedStorage`	Specifies the allocated storage size, in gibibytes.
`autoMinorVersionUpgrade`	Indicates that minor version patches are applied automatically.
`availabilityZone`	Specifies the name of the Availability Zone the DB instance is located in.
`backupRetentionPeriod`	Specifies the number of days for which automatic DB snapshots are retained.
`caCertificateIdentifier`	The identifier of the CA certificate for this DB instance.
`characterSetName`	If present, specifies the name of the character set that this instance is associated with.
`dbClusterIdentifier`	If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is member of.
`dbInstanceClass`	Contains the name of the compute and memory capacity class of the DB instance.
`dbInstancePort`	Specifies the port that the DB instance listens on. If the DB instance is part of a DB cluster, this can be a different port than the DB cluster port.
`dbInstanceStatus`	Specifies the current state of this database.
`dbName`	Contains the name of the initial database of this instance that was provided at create time, if one was specified when the DB instance was created. This same name is returned for the life of the DB instance.
`dbParameterGroups`	Provides the list of DB parameter groups applied to this DB instance.
`dbSecurityGroups`	Provides List of DB security group elements.
`dbParameterGroups`	Provides the list of DB parameter groups.
`dbSubnetGroup`	Specifies information on the subnet group associated with the DB instance, including the name, description, and subnets in the subnet group.
`endpoint`	Specifies the connection endpoint.
`engine`	Provides the name of the database engine to be used for this DB instance.
`engineVersion`	Indicates the database engine version.
`kmsKeyId`	If StorageEncrypted is true, the AWS KMS key identifier for the encrypted DB instance.
`licenseModel`	License model information for this DB instance.
`masterUsername`	Contains the master username for the DB instance.
`multiAz`	Specifies if the DB instance is a Multi-AZ deployment.
`optionGroupMemberships`	Provides the list of option group memberships for this DB instance.
`preferredBackupWindow`	Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the BackupRetentionPeriod.
`preferredMaintenanceWindow`	Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).
`publiclyAccessible`	Specifies the accessibility options for the DB instance. A value of true specifies an Internet-facing instance with a publicly resolvable DNS name, which resolves to a public IP address. A value of false specifies an internal instance with a DNS name that resolves to a private IP address.
`readReplicaDdInstanceIdentifiers`	Contains one or more identifiers of the Read Replicas associated with this DB instance.
`readReplicaSourceDbInstanceIdentifier`	Contains the identifier of the source DB instance if this DB instance is a Read Replica.
`secondaryAvailabilityZone`	If present, specifies the name of the secondary Availability Zone for a DB instance with multi-AZ support.
`storageEncrypted`	Specifies whether the DB instance is encrypted.
`storageType`	Specifies the storage type associated with DB instance.
`tdeCredentialArn`	The ARN from the key store with which the instance is associated for TDE encryption.
`vpcSecurityGroups`	Provides a list of VPC security group elements that the DB instance belongs to.
`clusterInstance`	If the instance is a cluster or not.
`tags`*	Instance tags.