This template contains performance & statistics counters for monitoring AWS RDS (Relational Database Service).
Prerequisites:
Powershell module AWSPowerShell must be installed prior to run this template on target machine.
To connect with AWS account following parameters are required:
Mandatory Parameters:
- Access Key
- Secret Key,
- Region – all for making the connection.
- Database Name - for which metrics must be calculated.
User with the given access key should have the policies below assigned to it so that data can be fetched via SAM::
- AmazonRDSDirectoryServiceAccess
- RDSCloudHsmAuthorizationRole
- AmazonRDSReadOnlyAccess
- CloudWatchReadOnlyAccess
Optional Parameters:
- Time Range – duration (in mins) for which data needs to be fetched. Default value is 10 mins.
- Period – time grain (in mins) within Time Range to get the multiple values within time range. Default value is 2 mins. E.g. If Time Range is 10 mins and Period value is 2 mins then 5 sample value will be collected, and we will pick up the latest sample.
- NumberOfRetries – number of attempts to make the connection or to fetch the data from aws. Default value is 3.
- WaitBetweenRetries – time interval (in seconds) between the retry. Default value is 0.5 seconds.
PowerShell 5.1 and above
Script Argument:
Login credential to access AWS Portal. AWS details must be passed in script arguments as per prerequisites 2 above. E.g.
<AccessKey>, <SecretKey>, <Region>, <Database Name>, <TimeRange>, <Period>, <NumberOfRetries>, <WaitBetweenRetries>
Note:
- 1. To install AWS module, execute below powershell commands;
Install-Module -Name AWSPowerShell -force
- 2. Windows Administrator on the machine where template would be running against. Script should run with administration privilege.
Portions of this document were originally created by and are excerpted from the following sources:
https://docs.aws.amazon.com/powershell/latest/reference/items/Get-CWMetricStatistic.html
MONITORED COMPONENTS
CPU Utilization
The percentage of CPU utilization of the given database.
Unit: Percent
Database Connections
The number of database connections in use.
Unit: Count
Disk Queue Depth
The number of outstanding IOs (read/write requests) waiting to access the disk.
Unit: Count
Freeable Memory
The amount of available random-access memory.
Unit: MB
Free Storage Space
The amount of available storage space.
Unit: GB
Network Receive Throughput
The incoming (Receive) network traffic on the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication.
Unit: Bytes/Second
Network Transmit Throughput
The outgoing (Transmit) network traffic on the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication.
Unit: Bytes/second
Read IOPS
The average number of disk read I/O operations per second.
Unit: Count/Second
Write IOPS
The average number of disk write I/O operations per second.
Unit: Count/Second
Read Latency
The average amount of time taken per disk I/O operation.
Unit: Seconds
Write Latency
The average amount of time taken per disk I/O operation.
Unit: Seconds
Read Throughput
The average number of bytes read from disk per second.
Unit: Bytes/Second
Write Throughput
The average number of bytes written to disk per second.
Unit: Bytes/Second
Swap Usage
The amount of swap space used on the DB instance.
Unit: MB