Amazon RDS
Introduction
Amazon Relational Database Service (Amazon RDS) is a managed database service by AWS that supports various database engines.
Getting Started
Compatibility
The Amazon RDS metricsets were tested mySQL 8.0 and is expeted to work on MySQL >= 5.5, PostgreSQL >= 9.6, MariaDB >= 10.2, Oracle >= 12c, SQL Server >= 2012 and Amazon Aurora >= 5.6.
Data Collection Method
vuSmartmaps collect health and performance data for Amazon RDS O11ySource using an internal agent. This agent collects data based on the source's configuration.
Prerequisites
Dependent Configuration
To configure this O11ySource, create a 'credential' of type 'aws' under the 'Definition' tab.
Inputs for Configuring Data Source
- AWS Account ID: A 12-digit number, such as 012345678901, that uniquely identifies an AWS account.
- AWS Region: AWS Region where the instance of this component is running. For eg: Asia Pacific (Mumbai), the region would be ap-south-1.
- AWS Credential: AWS credential that provides Access key and Secret key to access Cloudwatch.
- Periods (in seconds): Specifies the interval in seconds at which data is collected. Data collection occurs once every specified period.
Firewall Requirement
To collect data from this O11ySource, ensure the following ports are opened:
| Source IP | Destination IP | Destination Port | Protocol | Direction |
|---|---|---|---|---|
| IP address of the server where the Agent is running | vuSmartMaps IP | 443 | TCP | Outbound |
*Before providing the firewall requirements, please update the port based on the customer environment.
Configuring the Target
Health and Performance metrics of Amazon RDS is collected through CloudWatch service. So AWS CloudWatch services must be enabled in your AWS account.
An IAM role or user with the following permissions to access CloudWatch metrics:
- cloudwatch:GetMetricData
- cloudwatch:ListMetrics
Configuration Steps
Metrics Collected
| Name | Description | Data Type |
|---|---|---|
| Timestamp | Timestamp at metricsets collected | DateTime |
| Tenant ID | Tenant ID | String |
| BU ID | BU ID | String |
| Interval | Time interval at which data are polling | UInt8 |
| Region | AWS Region of Load Balancer | String |
| Vublock Name | Vublock Name | String |
| DBInstanceIdentifier | A specific DB instance. | LowCardinality(String) |
| DatabaseClass | A instances in a database class. | LowCardinality(String) |
| EngineName | The identified engine name. | LowCardinality(String) |
| BinLogDiskUsageAvg | The average amount of disk space occupied by binary logs. This is available for MariaDB and MySQL | Float64 |
| BinLogDiskUsageSum | The total amount of disk space occupied by binary logs. This is available for MariaDB and MySQL | Float64 |
| BurstBalanceAvg | The average percent of General Purpose SSD (gp2) burst-bucket I/O credits available. | Float64 |
| CheckpointLagAvg | The average amount of time since the most recent checkpoint. | Float64 |
| CheckpointLagMax | The maximum amount of time since the most recent checkpoint. | Float64 |
| CheckpointLagMin | The minimum amount of time since the most recent checkpoint. | Float64 |
| ConnectionAttemptsAvg | The average number of attempts to connect to an instance, whether successful or not. This is applicable only to MySQL | UInt64 |
| ConnectionAttemptsSum | The total number of attempts to connect to an instance, whether successful or not. This is applicable only to MySQL | UInt64 |
| CPUUtilizationAvg | The average percentage of CPU utilization. | UInt64 |
| CPUUtilizationMax | The maximum percentage of CPU utilization. | Float32 |
| CPUUtilizationMin | The minimum percentage of CPU utilization. | Float32 |
| CPUCreditUsageAvg | The average number of CPU credits spent by the instance for CPU utilization. | Float32 |
| CPUCreditUsageSum | The total number of CPU credits spent by the instance for CPU utilization. | Float32 |
| CPUCreditBalanceAvg | The average number of earned CPU credits that an instance has accrued since it was launched or started. | Float32 |
| CPUSurplusCreditBalanceAvg | The average number of surplus credits that have been spent by an unlimited instance. | Float32 |
| CPUSurplusCreditsChargedAvg | The average number of spent surplus credits that are not paid down by earned CPU credits. | Float32 |
| DatabaseConnectionsAvg | The average number of client network connections to the database instance. | UInt64 |
| DatabaseConnectionsSum | The total number of client network connections to the database instance. | UInt64 |
| DiskQueueDepthAvg | The average number of outstanding I/Os (read/write requests) waiting to access the disk. | Float32 |
| DiskQueueDepthMax | The maximum number of outstanding I/Os (read/write requests) waiting to access the disk. | Float32 |
| DiskQueueDepthMin | The minimum number of outstanding I/Os (read/write requests) waiting to access the disk. | Float32 |
| DiskQueueDepthLogVolumeAvg | The average number of outstanding I/Os (read/write requests) waiting to access the log volume disk. | Float32 |
| EBSByteBalancePctAvg | The average percentage of throughput credits remaining in the burst bucket of your RDS database. | Float32 |
| EBSIOBalancePctAvg | The average percentage of I/O credits remaining in the burst bucket of your RDS database. | Float32 |
| FailedSQLServerAgentJobsCountSum | The total number of failed Microsoft SQL Server Agent jobs during the last minute. Applicable to Microsoft SQL Server | UInt64 |
| FreeableMemoryAvg | The average amount of available random access memory | Float64 |
| FreeableMemoryMax | The maximum amount of available random access memory. | Float64 |
| FreeableMemoryMin | The minimum amount of available random access memory. | Float64 |
| FreeLocalStorageAvg | The average amount of available local storage space. | Float64 |
| FreeLocalStorageSum | The total amount of available local storage space. | Float64 |
| FreeStorageSpaceAvg | The average amount of available storage space. | Float64 |
| FreeStorageSpaceSum | The total amount of available storage space. | Float64 |
| FreeStorageSpaceLogVolumeAvg | The average amount of available storage space on the log volume. | Float64 |
| FreeStorageSpaceLogVolumeSum | The total amount of available storage space on the log volume. | Float64 |
| MaximumUsedTransactionIDsAvg | The average maximum transaction IDs that have been used. | UInt64 |
| NetworkReceiveThroughputAvg | The average incoming (receive) network traffic on the DB instance. | Float64 |
| NetworkReceiveThroughputSum | The total incoming (receive) network traffic on the DB instance. | Float64 |
| NetworkTransmitThroughputAvg | The average outgoing (transmit) network traffic on the DB instance. | Float64 |
| NetworkTransmitThroughputSum | The total outgoing (transmit) network traffic on the DB instance. | Float64 |
| OldestReplicationSlotLagAvg | The average lagging size of the replica lagging the most in terms of write-ahead log (WAL) data received. | Float64 |
| OldestReplicationSlotLagMax | The maximum lagging size of the replica lagging the most in terms of write-ahead log (WAL) data received. | Float64 |
| OldestReplicationSlotLagMin | The minimum lagging size of the replica lagging the most in terms of write-ahead log (WAL) data received. | Float64 |
| ReadIOPSAvg | The average number of disk read I/O operations per second. | Float64 |
| ReadIOPSSum | The total number of disk read I/O operations per second. | Float64 |
| ReadIOPSLocalStorageAvg | The average number of disk read I/O operations to local storage per second. | Float64 |
| ReadIOPSLocalStorageSum | The total number of disk read I/O operations to local storage per second. | Float64 |
| ReadIOPSLogVolumeAvg | The average number of disk read I/O operations per second for the log volume. | Float64 |
| ReadIOPSLogVolumeSum | The total number of disk read I/O operations per second for the log volume. | Float64 |
| ReadLatencyAvg | The average amount of time taken per disk I/O operation. | Float64 |
| ReadLatencyMax | The maximum amount of time taken per disk I/O operation. | Float64 |
| ReadLatencyMin | The minimum amount of time taken per disk I/O operation. | Float64 |
| ReadLatencyLocalStorageAvg | The average amount of time taken per disk I/O operation for local storage. | Float64 |
| ReadLatencyLocalStorageMax | The maximum amount of time taken per disk I/O operation for local storage. | Float64 |
| ReadLatencyLocalStorageMin | The minimum amount of time taken per disk I/O operation for local storage. | Float64 |
| ReadLatencyLogVolumeAvg | The average amount of time taken per disk I/O operation for the log volume. | Float64 |
| ReadLatencyLogVolumeMax | The maximum amount of time taken per disk I/O operation for the log volume. | Float64 |
| ReadLatencyLogVolumeMin | The minimum amount of time taken per disk I/O operation for the log volume. | Float64 |
| ReadThroughputAvg | The average number of bytes read from disk per second. | Float64 |
| ReadThroughputSum | The total number of bytes read from disk per second. | Float64 |
| ReadThroughputLocalStorageAvg | The average number of bytes read from disk per second for local storage. | Float64 |
| ReadThroughputLocalStorageSum | The total number of bytes read from disk per second for local storage. | Float64 |
| ReadThroughputLogVolumeAvg | The average number of bytes read from disk per second for the log volume. | Float64 |
| ReadThroughputLogVolumeSum | The total number of bytes read from disk per second for the log volume. | Float64 |
| ReplicaLagAvg | The average amount of time a read replica DB instance lags behind the source DB instance. | Float64 |
| ReplicaLagMax | The maximum amount of time a read replica DB instance lags behind the source DB instance. | Float64 |
| ReplicaLagMin | The minimum amount of time a read replica DB instance lags behind the source DB instance. | Float64 |
| ReplicationChannelLagAvg | The average amount of time a particular channel on the multi-source replica lags behind the source DB instance. | Float64 |
| ReplicationChannelLagMax | The maximum amount of time a particular channel on the multi-source replica lags behind the source DB instance. | Float64 |
| ReplicationChannelLagMin | The minimum amount of time a particular channel on the multi-source replica lags behind the source DB instance. | Float64 |
| ReplicationSlotDiskUsageAvg | The average disk space used by replication slot files. | Float64 |
| ReplicationSlotDiskUsageSum | The total disk space used by replication slot files. | Float64 |
| SwapUsageAvg | The average amount of swap space used on the DB instance. | Float64 |
| SwapUsageMax | The maximum amount of swap space used on the DB instance. | Float64 |
| SwapUsageMin | The minimum amount of swap space used on the DB instance. | Float64 |
| TransactionLogsDiskUsageAvg | The average disk space used by transaction logs. | Float64 |
| TransactionLogsDiskUsageSum | The total disk space used by transaction logs. | Float64 |
| TransactionLogsGenerationAvg | The average size of transaction logs generated per second. | Float64 |
| TransactionLogsGenerationSum | The total size of transaction logs generated per second. | Float64 |
| WriteIOPSAvg | The average number of disk write I/O operations per second. | Float64 |
| WriteIOPSSum | The total number of disk write I/O operations per second. | Float64 |
| WriteIOPSLocalStorageAvg | The average number of disk write I/O operations per second on local storage. | Float64 |
| WriteIOPSLocalStorageSum | The total number of disk write I/O operations per second on local storage. | Float64 |
| WriteIOPSLogVolumeAvg | The average number of disk write I/O operations per second for the log volume. | Float64 |
| WriteIOPSLogVolumeSum | The total number of disk write I/O operations per second for the log volume. | Float64 |
| WriteLatencyAvg | The average amount of time taken per disk I/O operation. | Float64 |
| WriteLatencyMax | The maximum amount of time taken per disk I/O operation. | Float64 |
| WriteLatencyMin | The minimum amount of time taken per disk I/O operation. | Float64 |
| WriteLatencyLocalStorageAvg | The average amount of time taken per disk I/O operation on local storage. | Float64 |
| WriteLatencyLocalStorageMax | The maximum amount of time taken per disk I/O operation on local storage. | Float64 |
| WriteLatencyLocalStorageMin | The minimum amount of time taken per disk I/O operation on local storage. | Float64 |
| WriteLatencyLogVolumeAvg | The average amount of time taken per disk I/O operation for the log volume. | Float64 |
| WriteLatencyLogVolumeMax | The maximum amount of time taken per disk I/O operation for the log volume. | Float64 |
| WriteLatencyLogVolumeMin | The minimum amount of time taken per disk I/O operation for the log volume. | Float64 |
| WriteThroughputAvg | The average number of bytes written to disk per second. | Float64 |
| WriteThroughputSum | The total number of bytes written to disk per second. | Float64 |
| WriteThroughputLogVolumeAvg | The average number of bytes written to disk per second for the log volume. | Float64 |
| WriteThroughputLogVolumeSum | The total number of bytes written to disk per second for the log volume. | Float64 |
| WriteThroughputLocalStorageAvg | The average number of bytes written to disk per second for local storage. | Float64 |
| WriteThroughputLocalStorageSum | The total number of bytes written to disk per second for local storage. | Float64 |
