---
title: "Cloud - AWS - RDS CloudWatch Opspack"
description: ""
url: "https://docs.itrsgroup.com/docs/opsview/6.11.7/opspacks/cloud-aws-rds-cloudwatch-opspack/index.html"
---
Amazon Relational Database Service (Amazon 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.

## What You Can Monitor

With this opspack installed, users can easily monitor their MySQL, PostgresSQL, MSSQL and Oracle RDS instance running in their AWS account. Users are also able to monitor replicated instances of these servers.

## Service Checks

| Service Check                           | Description                                                                                                                                                       | Default Threshold | Unit of Measurement |
|:----------------------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------:|:-------------------:|
| AWS - RDS - Bin Log Disk Usage          | The amount of disk space occupied by binary logs on the master                                                                                                    |                   |        Bytes        |
| AWS - RDS - CPU Utilization             | The percentage of CPU utilization                                                                                                                                 |                   |     Percentage      |
| AWS - RDS - CPU Credit Usage            | Must be a t2 instance. The number of CPU credits consumed by the instance                                                                                         |                   |    vCPU-minutes     |
| AWS - RDS - CPU Credit Balance          | Must be a t2 instance. The number of CPU credits available for the instance to burst beyond its base CPU utilization                                              |                   |    vCPU-minutes     |
| AWS - RDS - Database Connections        | The number of database connections in use                                                                                                                         |                   |        Count        |
| AWS - RDS - Disk Queue Depth            | The number of outstanding IO operations waiting to access the disk                                                                                                |                   |        Count        |
| AWS - RDS - Freeable Memory             | The amount of available random access memory                                                                                                                      |                   |        Bytes        |
| AWS - RDS - Free Storage Space          | The amount of available storage space                                                                                                                             |                   |        Bytes        |
| AWS - RDS - Replica Lag                 | The amount of time a Read Replica DB instance lags behind the Source DB instance                                                                                  |                   |       Seconds       |
| AWS - RDS - Swap Usage                  | The amount of swap space used on the DB instance                                                                                                                  |                   |        Bytes        |
| AWS - RDS - Read I/O Ops                | The average number of disk read I/O operations per second                                                                                                         |                   |    Count/Second     |
| AWS - RDS - Write I/O Ops               | The average number of disk write I/O operations per second                                                                                                        |                   |    Count/Second     |
| AWS - RDS - Read Latency                | The average amount of Read latency on disk I/O operation                                                                                                          |                   |       Seconds       |
| AWS - RDS - Write Latency               | The average amount of Write latency on disk I/O operation                                                                                                         |                   |       Seconds       |
| AWS - RDS - Read Throughput             | The average number of bytes read from disk per second                                                                                                             |                   |    Bytes/Second     |
| AWS - RDS - Write Throughput            | The average number of bytes written to disk per second                                                                                                            |                   |    Bytes/Second     |
| AWS - RDS - Network Receive Throughput  | The incoming network traffic throughput to the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication   |                   |    Bytes/Second     |
| AWS - RDS - Network Transmit Throughput | The outgoing network traffic throughput from the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication |                   |    Bytes/Second     |

## Setup Amazon Web Services for Monitoring

Users are required to setup their AWS console user to have **programmable API access** to their AWS account. This requires you to create an **AWS user** and to add the **Access Key ID and Secret access Key** to that AWS account. The following steps illustrate how to acquire these keys.

### To create IAM user and Access Keys

- Open IAM Dashboard as described and navigate to Users

![Add host template](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-aws-rds-cloudwatch-create_aws_keys_step0.png)

- Click **Add User**
  - Add User Wizard will open:

![Add host template](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-aws-rds-cloudwatch-create_aws_keys_step1.png)

- Specify User Name (any user name of your choice).
- Check **Programmatic Access**

![Add host template](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-aws-rds-cloudwatch-create_aws_keys_step2.png)

- Click **Next: Permissions**
  - Permissions page will open
  - This step is optional. If no policies exist it can be Skipped.

- Click **Attach Existing policies** for the user

![Add host template](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-aws-rds-cloudwatch-create_aws_keys_step3.png)

- Click **Next: Review**
  - Review tab will open:

![Add host template](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-aws-rds-cloudwatch-create_aws_keys_step4.png)

- Review new user details and click **Create User**

![Add host template](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-aws-rds-cloudwatch-create_aws_keys_step5.png)

- The final page will open:

![Add host template](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-aws-rds-cloudwatch-create_aws_keys_step6.png)

- Click **Show** under the Secret access key column
- Copy **Access key ID** and **Secret access key** into a safe place to be provided in the variables.

## Setup and Configuration

1. Aurora RDS is not supported with this plugin.
2. The Credit Balance and Credit Usage service checks will execute only on a t2 burstable instance.
3. The Replica Lag service check will only execute on the replicated copy of the database instance.

### Add the Host Template

- Add the **Primary Hostname/IP**. This should be the **Endpoint** from the **Connectivity & Security** tab of an RDS instance in the **RDS Console** in AWS.
- **Host Title** Can be any name given to the host - by default Opsview chooses it to be the value in the **Primary Hostname/IP** field.
- Choose the **Host Group**.

Add the *Cloud - AWS - RDS CloudWatch* Host template to your Opsview monitor host


**Note**


For more information, refer to the documentation on [Adding Host Templates to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/host/index.html#host-templates).



### Add and configure the variables for the host

| Variable                       | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
|:-------------------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| AWS_CLOUDWATCH_AUTHENTICATION  | Authentication details for CloudWatch. The Value is not used and therefore can be set to anything. Either override the File Path with the location of your credentials file, or override the Access Key and Secret Key arguments (this approach is recommended as the values will be encrypted). Optionally, override the Region (default: eu-west-1) with the location of your instance if you are not using the default region. 
**Opsview Cloud**

 For Opsview Cloud customers, please contact [ITRS Support](https://www.itrsgroup.com/about/contact) for assistance with a credentials file, as it requires Orchestrator access. 
 |
| AWS_CLOUDWATCH_ROLE_ARN        | This optional variable is the Amazon Resource Name (ARN) of the role to be used for the service checks. Override the Access ARN with the ARN of the role. The account should have AssumeRole(STS) for this ARN.                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| AWS_RDS_DB_INSTANCE_IDENTIFIER | Set the Value to the RDS Instance name.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

![Add credentials variable](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-aws-rds-cloudwatch-add_aws_credentials_variable.png)

![Add instance variable](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-aws-rds-cloudwatch-add_RDS_instance_variable.png)


**Note**


For more information, refer to the documentation on [Adding Variables to Hosts](https://docs.itrsgroup.com/docs/opsview/6.11.7/adding-a-new-variable/index.html#adding-a-variable-to-a-host).



### Apply Changes

Apply Changes and the system will then be monitored:

![Add instance variable](https://docscdn.itrsgroup.com/opsview/images/opspacks-cloud-aws-rds-cloudwatch-output.png)


