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 is expected 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.
- Period (in minutes): Specifies the interval in minutes at which data is collected. Data collection occurs once every specified period. The period should be between 1 - 60 minutes.
Firewall Requirement
To collect data from this O11ySource, ensure the following ports are opened:
| Source IP | Destination IP | Destination Port | Protocol | Direction |
|---|---|---|---|---|
| vuSmartMaps IP | AWS CloudWatch IPs | 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 AWS 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
- Enable the O11ySource.
- Select the Sources tab and press the
+button to add a new ALB instance to be monitored. - Populate all the configurations. Click on
Saveto create the instance.
Metrics Collected
| Name | Description | Data Type |
|---|---|---|
| timestamp | The timestamp of the data entry. | DateTime |
| tenant_id | The tenant identifier. | String |
| bu_id | The business unit identifier. | String |
| interval | The time interval for the metrics. | UInt8 |
| region | The region where the resource is located. | String |
| vublock_name | The name of the block. | String |
| db_instance_identifier | The identifier for the database instance. | LowCardinality(String) |
| database_class | The class of the database (e.g., Standard, Enterprise). | LowCardinality(String) |
| engine_name | The name of the database engine (e.g., MySQL, PostgreSQL). | LowCardinality(String) |
| bin_log_disk_usage_average | The average disk usage for binary logs. | Float64 |
| bin_log_disk_usage_sum | The total disk usage for binary logs. | Float64 |
| burst_balance_average | The average burst balance of the system. | Float64 |
| checkpoint_lag_average | The average lag time of the checkpoint. | Float64 |
| checkpoint_lag_maximum | The maximum lag time of the checkpoint. | Float64 |
| checkpoint_lag_minimum | The minimum lag time of the checkpoint. | Float64 |
| connection_attempts_average | The average number of connection attempts. | UInt64 |
| connection_attempts_sum | The total number of connection attempts. | UInt64 |
| cpu_utilization_average | The average CPU utilization percentage. | Float32 |
| cpu_utilization_maximum | The maximum CPU utilization percentage. | Float32 |
| cpu_utilization_minimum | The minimum CPU utilization percentage. | Float32 |
| cpu_credit_usage_average | The average CPU credit usage. | Float32 |
| cpu_credit_usage_sum | The total CPU credit usage. | Float32 |
| cpu_credit_balance_average | The average CPU credit balance. | Float32 |
| cpu_surplus_credit_balance_average | The average surplus credit balance for CPU. | Float32 |
| cpu_surplus_credits_charged_average | The average surplus CPU credits charged. | Float32 |
| database_connections_average | The average number of database connections. | UInt64 |
| database_connections_sum | The total number of database connections. | UInt64 |
| disk_queue_depth_average | The average depth of the disk queue. | Float32 |
| disk_queue_depth_maximum | The maximum depth of the disk queue. | Float32 |
| disk_queue_depth_minimum | The minimum depth of the disk queue. | Float32 |
| disk_queue_depth_log_volume_average | The average disk queue depth for the log volume. | Float32 |
| ebs_byte_balance%_average | The average percentage of byte balance for EBS (Elastic Block Storage). | Float32 |
| ebsio_balance%_average | The average EBS I/O balance percentage. | Float32 |
| failed_sql_server_agent_jobs_count_sum | The total count of failed SQL server agent jobs. | UInt64 |
| freeable_memory_average | The average amount of freeable memory. | Float64 |
| freeable_memory_maximum | The maximum amount of freeable memory. | Float64 |
| freeable_memory_minimum | The minimum amount of freeable memory. | Float64 |
| free_local_storage_average | The average amount of free local storage. | Float64 |
| free_local_storage_sum | The total amount of free local storage. | Float64 |
| free_storage_space_average | The average amount of free storage space. | Float64 |
| free_storage_space_sum | The total amount of free storage space. | Float64 |
| free_storage_space_log_volume_average | The average free storage space for log volumes. | Float64 |
| free_storage_space_log_volume_sum | The total free storage space for log volumes. | Float64 |
| maximum_used_transaction_ids_maximum | The maximum used transaction ID. | UInt64 |
| network_receive_throughput_average | The average network receive throughput. | Float64 |
| network_receive_throughput_sum | The total network receive throughput. | Float64 |
| network_transmit_throughput_average | The average network transmit throughput. | Float64 |
| network_transmit_throughput_sum | The total network transmit throughput. | Float64 |
| oldest_replication_slot_lag_average | The average lag time for the oldest replication slot. | Float64 |
| oldest_replication_slot_lag_maximum | The maximum lag time for the oldest replication slot. | Float64 |
| oldest_replication_slot_lag_minimum | The minimum lag time for the oldest replication slot. | Float64 |
| read_iops_average | The average number of read IOPS (Input/Output Operations per Second). | Float64 |
| read_iops_sum | The total number of read IOPS. | Float64 |
| read_iops_local_storage_average | The average read IOPS for local storage. | Float64 |
| read_iops_local_storage_sum | The total read IOPS for local storage. | Float64 |
| read_iops_log_volume_average | The average read IOPS for log volumes. | Float64 |
| read_iops_log_volume_sum | The total read IOPS for log volumes. | Float64 |
| read_latency_average | The average read latency. | Float64 |
| read_latency_maximum | The maximum read latency. | Float64 |
| read_latency_minimum | The minimum read latency. | Float64 |
| read_latency_local_storage_average | The average read latency for local storage. | Float64 |
| read_latency_local_storage_maximum | The maximum read latency for local storage. | Float64 |
| read_latency_local_storage_minimum | The minimum read latency for local storage. | Float64 |
| read_latency_log_volume_average | The average read latency for log volumes. | Float64 |
| read_latency_log_volume_maximum | The maximum read latency for log volumes. | Float64 |
| read_latency_log_volume_minimum | The minimum read latency for log volumes. | Float64 |
| read_throughput_average | The average read throughput. | Float64 |
| read_throughput_sum | The total read throughput. | Float64 |
| read_throughput_local_storage_average | The average read throughput for local storage. | Float64 |
| read_throughput_local_storage_sum | The total read throughput for local storage. | Float64 |
| read_throughput_log_volume_average | The average read throughput for log volumes. | Float64 |
| read_throughput_log_volume_sum | The total read throughput for log volumes. | Float64 |
| replica_lag_average | The average replica lag. | Float64 |
| replica_lag_maximum | The maximum replica lag. | Float64 |
| replica_lag_minimum | The minimum replica lag. | Float64 |
| replication_channel_lag_average | The average lag for the replication channel. | Float64 |
| replication_channel_lag_maximum | The maximum lag for the replication channel. | Float64 |
| replication_channel_lag_minimum | The minimum lag for the replication channel. | Float64 |
| replication_slot_disk_usage_average | The average disk usage of the replication slot. | Float64 |
| replication_slot_disk_usage_sum | The total disk usage of the replication slot. | Float64 |
| swap_usage_average | The average swap usage. | Float64 |
| swap_usage_maximum | The maximum swap usage. | Float64 |
| swap_usage_minimum | The minimum swap usage. | Float64 |
| transaction_logs_disk_usage_average | The average disk usage for transaction logs. | Float64 |
| transaction_logs_disk_usage_sum | The total disk usage for transaction logs. | Float64 |
| transaction_logs_generation_average | The average transaction logs generation. | Float64 |
| transaction_logs_generation_sum | The total transaction logs generation. | Float64 |
| write_iops_average | The average number of write IOPS (Input/Output Operations per Second). | Float64 |
| write_iops_sum | The total number of write IOPS. | Float64 |
| write_iops_local_storage_average | The average write IOPS for local storage. | Float64 |
| write_iops_local_storage_sum | The total write IOPS for local storage. | Float64 |
| write_iops_log_volume_average | The average write IOPS for log volumes. | Float64 |
| write_iops_log_volume_sum | The total write IOPS for log volumes. | Float64 |
| write_latency_average | The average write latency. | Float64 |
| write_latency_maximum | The maximum write latency. | Float64 |
| write_latency_minimum | The minimum write latency. | Float64 |
| write_latency_local_storage_average | The average write latency for local storage. | Float64 |
| write_latency_local_storage_maximum | The maximum write latency for local storage. | Float64 |
| write_latency_local_storage_minimum | The minimum write latency for local storage. | Float64 |
| write_latency_log_volume_average | The average write latency for log volumes. | Float64 |
| write_latency_log_volume_maximum | The maximum write latency for log volumes. | Float64 |
| write_latency_log_volume_minimum | The minimum write latency for log volumes. | Float64 |
| write_throughput_average | The average write throughput. | Float64 |
| write_throughput_sum | The total write throughput. | Float64 |
| write_throughput_log_volume_average | The average write throughput for log volumes. | Float64 |
| write_throughput_log_volume_sum | The total write throughput for log volumes. | Float64 |
| write_throughput_local_storage_average | The average write throughput for local storage. | Float64 |
| write_throughput_local_storage_sum | The total write throughput for local storage. | Float64 |
