vmware vrealize operations management pack for amazon rds · queries it to retrieve metrics...

VMWARE VREALIZE OPERATIONS MANAGEMENT PACK FOR

Amazon RDS

User Guide

2 Blue Medora VMware vRealize Operations Management Pack for Amazon RDS User Guide

1. Purpose . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32. Introduction to the Management Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

2.1 How the Management Pack Collects Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32.2 Data the Management Pack Collects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32.3 Inventory Tree (Traversal Spec) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

3. Dashboards . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53.1 Amazon RDS Environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53.2 Amazon RDS External Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63.3 Amazon RDS Instance Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73.4 Amazon RDS Region Analysis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

4. Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95. Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .106. Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .117. Analysis Badges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128. Troubleshooting the Management Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

8.1 Troubleshooting an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138.2 Testing Connection Failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138.3 Viewing System Log Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .13

9. Appendix I: Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1410. Appendix II: Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1811. Appendix III: Capacity Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18

TABLE OF CONTENTS

NOTE: This document supports the version of each product listed, as well as all subsequent versions, until a new edition replaces it.

You can find the most up-to-date technical documentation on the Blue Medora support site at: http://support.bluemedora.com.

The Blue Medora website also provides the latest product updates. If you have comments about this documentation, submit your feedback to: [email protected].

http://support.bluemedora.com

mailto:support%40bluemedora.com?subject=


1. Purpose

The Blue Medora VMware vRealize Operations (vROps) Management Pack for Amazon RDS User Guide describes the primary features of the Management Pack for Amazon RDS, including dashboards, views, reports, alerts, and metrics that allow users to optimize the monitoring and management of RDS resources from within vRealize Operations.

2. Introduction to the Management Pack

The Management Pack for Amazon RDS is an embedded adapter for vRealize Operations (vROps) that monitors RDS systems remotely. The Management Pack retrieves data regarding resources by connecting to each supported RDS device.

This section includes the following topics:• How the Management Pack Collects Data• Data the Management Pack Collects• Inventory Tree (Traversal Spec)

2.1 How the Management Pack Collects Data

During each data collection cycle, the Management Pack opens a connection to the configured RDS device and queries it to retrieve metrics regarding RDS resources.

The collection interval for the adapter instance resource determines how often the Management Pack collects data. The default collection interval is five minutes.

The Management Pack supports Autodiscovery and manual discovery of resources. When you enable Autodiscovery for an adapter instance, the Management Pack creates resources in vRealize Operations and collects data after the main collection query runs. If a new resource belongs to a resource kind that does not exist in vROps, the Management Pack creates the resource kind.

2.2 Data the Management Pack Collects

The Management Pack can collect performance data, relationships, and events for the following RDS resources:1. Amazon RDS Instance2. Amazon RDS Region


2.3 Inventory Tree (Traversal Spec)

The Inventory Tree (Traversal Spec) feature within vROps allows you to easily navigate your environment. The hierarchical structure implicitly shows relationships among resource kinds and enables quick drill-downs to root-cause issues.

In addition to internal relationships, the Management Pack also includes the following external relationships:• RDS Instance -> Aurora Instance• RDS Instance -> Microsoft SQL Server Instance• RDS Instance -> MySQL Instance• RDS Instance -> Oracle Instance• RDS Instance -> PostgreSQL Instance

Figure 1: Example Traversal Spec


3. Dashboards

Dashboards are the primary user interface that allow users to monitor Amazon RDS resources from within vRealize Operations.

The following dashboards are available in the Management Pack:• Amazon RDS Environment• Amazon RDS External Analysis• Amazon RDS Instance Analysis• Amazon RDS Region Analysis

3.1 Amazon RDS Environment

The Amazon RDS Environment dashboard provides details about your Amazon RDS resources. Select a resource from the Environment widget on the left to view its alerts and metrics.

Figure 2: Amazon RDS Environment Dashboard


3.2 Amazon RDS External Analysis

The Amazon RDS External Analysis dashboard provides an overview of external relationships being made to your Amazon RDS environment. Select a region from the widget on the left to view its instances and KPIs as well as a topology view of the external relationships to the selected instance.

Figure 3: Amazon RDS External Analysis Dashboard


3.3 Amazon RDS Instance Analysis

The Amazon RDS Instance Analysis dashboard provides an overview of your Amazon RDS instances through a health-related heatmap. Select an instance from the heatmap to view its properties, disk read/write information, database connections, and CPU credit usage.

Figure 4: Amazon RDS Instance Analysis Dashboard


3.4 Amazon RDS Region Analysis

The Amazon RDS Region Analysis dashboard provides details about your Amazon RDS regions. Select a region from the widget on the left to view its database connections, average IOPS, and average latency as well as a topology view of instances within the selected region.

Figure 5: Amazon RDS Region Analysis Dashboard


4. Views

The vROps Management Pack for Amazon RDS creates views that allow the user to view statistics of metrics for various RDS resources. The views help give a broad picture of the entire system, as opposed to a more in depth view.

Table 1: Management Pack Views

VIEW TYPE

Amazon RDS Instance CPU List

Amazon RDS Instance CPU Credit Usage List

Amazon RDS Instance Database Connections List

Amazon RDS Instance IOPS List

Amazon RDS Instance Latency List

Amazon RDS Instance Storage List

Amazon RDS Instance Throughput List

Amazon RDS Region Average IOPS Trend

Amazon RDS Region Average Latency Trend

Amazon RDS Region CPU List

Amazon RDS Region IOPS List

Amazon RDS Region Latency List

Amazon RDS Region Storage List

Amazon RDS Region Throughput List

To access the Management Pack views, go to Environment > All Objects > Amazon RDS Adapter and double-click on the desired Object (resource). Select the Details tab, then Views. The available views for that resource are listed and can be selected.

Figure 6: Accessing Management Pack Views


5. Reports

The Management Pack for Amazon RDS contains five out-of-the-box reports, as listed below. Most reports contain one or more of the views listed in section “4. Views”. These reports can be exported and easily shared with key stakeholders in either .pdf or .csv formats.

• Amazon RDS CPU• Amazon RDS IOPS• Amazon RDS Latency• Amazon RDS Storage• Amazon RDS Throughput

To access the Management Pack reports, go to Environment > All Objects > Amazon RDS Adapter and double-click on the desired Object (resource). Select the Reports tab, then Report Templates.

To run the selected report, click the Run Template icon ( ), then click Generated Reports, to select the report in your preferred format.

Figure 7: Accessing Management Pack Reports


6. Alerts

The Management Pack pulls alerts and events from RDS resources and displays them in vRealize Operations as alerts. Refer to section “10. Appendix II: Alerts” for the full list of alerts.

Figure 8: Alert Example


7. Analysis Badges

Using the predictive analytics capabilities of the vROps Analysis Badges through capacity definitions, the Management Pack for Amazon RDS populates capacity breakdowns for Amazon RDS instances and regions. Refer to section “11. Appendix III: Capacity Definitions” for the full list of resource kinds and capacity definitions.

Figure 9: Analysis Badge Example


8. Troubleshooting the Management Pack

Known troubleshooting information can help you diagnose and correct common problems with the Management Pack for Amazon RDS.

This section includes the following topics:• Troubleshooting an Adapter Instance• Testing Connection Failures• Viewing System Log Files

8.1 Troubleshooting an Adapter Instance

Perform these general troubleshooting steps to diagnose and correct problems with an adapter instance:• Edit the adapter instance and click Test Connection to verify the connection to vROps. Refer to

section “8.2 Testing Connection Failures”.• View the collection status and collection state for the adapter instance resource on the Inventory

Explorer page in vROps.• Check the adapter and collector logs for errors. Refer to section “8.3 Viewing System Log Files”, for

details.

8.2 Testing Connection Failures

When clicking Test Connection in the Manage Solution window when adding an adapter instance, the following connection errors are possible.

8.2.1 Incorrect Access Key ID

Ensure the correct Access Key ID was entered.

8.2.2 Incorrect Secret Access Key

Ensure the correct Secret Access Key was entered.

8.3 Viewing System Log Files

You can view adapter errors in the adapter and collector log files. You can view the adapter and collector log files in the vROps user interface or in an external log viewer.

• The adapter log files are in the $VCOPS_BASE/user/log/adapters/AmazonRDSAdapter/ folder.• The collector log files are in the $VCOPS_BASE/user/log/ folder.

The logging level is set to WARNING by default. To troubleshoot issues, set the logging level to INFO. To view detailed messages, including micro steps, queries, and returned results, set the logging level to DEBUG.

You can set the base log level for the collector via Administration ( ) > Support > Logs > Select COLLECTOR folder > Select Edit Properties icon ( ) > Edit Root logger level.

NOTE: If you set the logging level to DEBUG, log files can become large very quickly. Set the logging level to DEBUG only for short periods of time.

For complete information about viewing log files and modifying log levels, refer to the VMware vRealize Operations online help.


9. Appendix I: Metrics

The Management Pack for Amazon RDS collects the following metrics by RDS Resource Kinds.

Table 2: Management Pack Metrics

RESOURCE KIND RESOURCE GROUP

RESOURCE ATTRIBUTE

ATTRIBUTE TYPE ATTRIBUTE DESCRIPTION

Amazon RDS Region Disk Total Allocated Storage integer The Total Allocated Storage of the

RDS Region.

Amazon RDS Region Disk Average Binary Log Disk Usage float The Average Binary Log Disk

Usage of the RDS Region.

Amazon RDS Region Disk Average Disk Queue Depth float The Average Disk Queue Depth of

the RDS Region.

Amazon RDS Region Disk Total Free Storage Space float The Total Free Storage Space of

the RDS Region.

Amazon RDS Region Disk Average Read IOPS float The Average Read IOPS of the RDS Region.

Amazon RDS Region Disk Average Read Latency float The Average Read Latency of the

RDS Region.

Amazon RDS Region Disk Total Read Throughput float The Total Read Throughput of the

RDS Region.

Amazon RDS Region Disk Total Used Storage float The Total Used Storage of the RDS Region.

Amazon RDS Region Disk Average Write IOPS float The Average Write IOPS of the RDS Region.

Amazon RDS Region Disk Average Write Latency float The Average Write Latency of the RDS Region.

Amazon RDS Region Disk Total Write Throughput float The Total Write Throughput of the

RDS Region.

Amazon RDS Region Network Total Network Receive Throughput float The Total Network Receive

Throughput of the RDS Region.

Amazon RDS Region Network Total Network Transmit Throughput float The Total Network Transmit

Throughput of the RDS Region.

Amazon RDS Region Workload Total CPU Credit Balance float The Total CPU Credit Balance of

the RDS Region.

Amazon RDS Region Workload Total CPU Credit Usage float The Total CPU Credit Usage of

the RDS Region.

Amazon RDS Region Workload Average CPU Utilization float The Average CPU Utilization of

the RDS Region.

Amazon RDS Region Workload Max CPU Utilization float The Max CPU Utilization of the RDS Region.

Amazon RDS Region Workload Total Database Connections float The Total Database Connections

of the RDS Region.

Amazon RDS Region Workload Total Freeable Memory float The Total Freeable Memory of the

RDS Region.

Amazon RDS Region Workload Average Swap Usage float The Average Swap Usage of the RDS Region.



RESOURCE ATTRIBUTE


Amazon RDS Region Relationships Amazon RDS Instance Children string RDS Instance resource names of

Child resources.

Amazon RDS Instance Properties Name string The Name of the RDS Instance.

Amazon RDS Instance Properties License Model string The License Model of the RDS Instance.

Amazon RDS Instance Properties Engine Version string The Engine Version of the RDS Instance.

Amazon RDS Instance Properties Auto Minor Version Upgrade string The Auto Minor Version Upgrade

of the RDS Instance.

Amazon RDS Instance Properties Availability Zone string The Availability Zone of the RDS Instance.

Amazon RDS Instance Properties CA Certificate Identifier string The CA Certificate Identifier of the

RDS Instance.

Amazon RDS Instance Properties Class string The Class of the RDS Instance.

Amazon RDS Instance Properties Instance Create Time string The Instance Create Time of the RDS Instance.

Amazon RDS Instance Properties KMS Key ID string The KMS Key ID of the RDS Instance.

Amazon RDS Instance Properties Multi AZ string The Multi AZ of the RDS Instance.

Amazon RDS Instance Properties Secondary Availability Zone string The Secondary Availability Zone


Amazon RDS Instance Properties TDE Credential ARN string The TDE Credential ARN of the RDS Instance.

Amazon RDS Instance Properties Character Set Name string The Character Set Name of the RDS Instance.

Amazon RDS Instance Properties Cluster Identifier string The Cluster Identifier of the RDS Instance.

Amazon RDS Instance Properties Master Username string The Master Username of the RDS Instance.

Amazon RDS Instance Properties Port integer The Port of the RDS Instance.

Amazon RDS Instance Properties Read Replica Source DB Instance Identifier string

The Read Replica Source DB Instance Identifier of the RDS Instance.

Amazon RDS Instance Properties Storage Type string The Storage Type of the RDS Instance.

Amazon RDS Instance Properties Copy Tags to Snapshot string The Copy Tags to Snapshot of the

RDS Instance.

Amazon RDS Instance Properties Enhanced Monitoring Resource ARN string

The Enhanced Monitoring Resource ARN of the RDS Instance.

Amazon RDS Instance Properties Latest Restorable Time string The Latest Restorable Time of the

RDS Instance.

Amazon RDS Instance Properties Monitoring Role ARN string The Monitoring Role ARN of the RDS Instance.



RESOURCE ATTRIBUTE


Amazon RDS Instance Properties Preferred Backup Window string The Preferred Backup Window of

the RDS Instance.

Amazon RDS Instance Properties Preferred Maintenance Window string The Preferred Maintenance

Window of the RDS Instance.

Amazon RDS Instance Properties Engine string The Engine of the RDS Instance.

Amazon RDS Instance Properties Identifier string The Identifier of the RDS Instance.

Amazon RDS Instance Properties Endpoint Address string The Endpoint Address of the RDS Instance.

Amazon RDS Instance Properties Endpoint Hosted Zone ID string The Endpoint Hosted Zone ID of

the RDS Instance.

Amazon RDS Instance Properties Endpoint Port integer The Endpoint Port of the RDS Instance.

Amazon RDS Instance Properties Publicly Accessible string The Publicly Accessible of the RDS Instance.

Amazon RDS Instance Properties Subnet Group Description string The Subnet Group Description of

the RDS Instance.

Amazon RDS Instance Properties Subnet Group Name string The Subnet Group Name of the RDS Instance.

Amazon RDS Instance Properties Subnet Group VPC ID string The Subnet Group VPC ID of the RDS Instance.

Amazon RDS Instance Disk Allocated Storage integer The Allocated Storage of the RDS Instance.

Amazon RDS Instance Disk Binary Log Disk Usage float The Binary Log Disk Usage of the

RDS Instance.

Amazon RDS Instance Disk Disk Queue Depth float The Disk Queue Depth of the RDS Instance.

Amazon RDS Instance Disk Free Storage Space float The Free Storage Space of the RDS Instance.

Amazon RDS Instance Disk Free Storage Space Percent float The Free Storage Space

Percentage of the RDS Instance.

Amazon RDS Instance Disk Read IOPS float The Read IOPS of the RDS Instance.

Amazon RDS Instance Disk Read Latency float The Read Latency of the RDS Instance.

Amazon RDS Instance Disk Read Throughput float The Read Throughput of the RDS Instance.

Amazon RDS Instance Disk Storage Encrypted string The Storage Encrypted of the RDS Instance.

Amazon RDS Instance Disk Total IOPS float The Total IOPS of the RDS Instance.

Amazon RDS Instance Disk Used Storage float The Used Storage of the RDS Instance.

Amazon RDS Instance Disk Write IOPS float The Write IOPS of the RDS Instance.



RESOURCE ATTRIBUTE


Amazon RDS Instance Disk Write Latency float The Write Latency of the RDS Instance.

Amazon RDS Instance Disk Write Throughput float The Write Throughput of the RDS Instance.

Amazon RDS Instance Maintenance Backup Retention Period integer The Backup Retention Period of

the RDS Instance.

Amazon RDS Instance Maintenance Monitoring Interval integer The Monitoring Interval of the RDS Instance.

Amazon RDS Instance General Provisioned IOPS float The Provisioned IOPS of the RDS Instance.

Amazon RDS Instance General Status string The Status of the RDS Instance.

Amazon RDS Instance Network Network Receive Throughput float The Network Receive Throughput


Amazon RDS Instance Network Network Transmit Throughput float The Network Transmit Throughput


Amazon RDS Instance Network Subnet Group Status string The Subnet Group Status of the RDS Instance.

Amazon RDS Instance Workload CPU Credit Balance float The CPU Credit Balance of the RDS Instance.

Amazon RDS Instance Workload CPU Credit Usage float The CPU Credit Usage of the RDS Instance.

Amazon RDS Instance Workload CPU Utilization float The CPU Utilization of the RDS Instance.

Amazon RDS Instance Workload Database Connections float The Database Connections of the

RDS Instance.

Amazon RDS Instance Workload Freeable Memory float The Freeable Memory of the RDS Instance.

Amazon RDS Instance Workload Max CPU Utilization float The Max CPU Utilization of the RDS Instance.

Amazon RDS Instance Workload Swap Usage float The Swap Usage of the RDS Instance.

Amazon RDS Instance Relationships Amazon RDS Region Parents string RDS Region resource names of

Parent resources.

Amazon RDS Instance Relationships Microsoft SQL Server Instance Children string SQL Server Instance resource

names of Child resources.

Amazon RDS Instance Relationships MySQL Instance Children string MySQL Instance resource names

of Child resources.

Amazon RDS Instance Relationships PostgreSQL Instance Children string PostgreSQL Instance resource

names of Child resources.

Amazon RDS Instance Relationships Oracle Instance Children string Oracle Instance resource names

of Child resources.


10. Appendix II: Alerts

The Management Pack for Amazon RDS populates alerts originating from the Amazon RDS API and makes them available in vROps. Refer to the full list of alerts as shown below:

• CPU Utilization is High• Read IOPS is High• Write IOPS is High• Write Latency is High• Read Latency is High• Free Storage Space is Low

11. Appendix III: Capacity Definitions

The Management Pack uses the following capacity definitions, which help determine the value of Analysis Badges (refer to section “7. Analysis Badges”) within vRealize Operations. For more information on using Analysis Badges, refer to the VMware vRealize Operations online help.

Table 3: Capacity Definitions

CONTAINER DESCRIPTION USE IN WORKLOAD

RDS Instance

CPU Capacity CPU utilization by the RDS Instance yes

IOPS Capacity Total IOPS by the RDS Instance yes

Storage Capacity Storage used by the RDS Instance yes

RDS Region

CPU Capacity Average CPU utilization by the RDS Region yes

Storage Capacity Total storage used by the RDS Region yes

Copyright © 2017 Blue Medora Inc. All rights reserved. U.S. and international copyright and intellectual property laws protect this product. Blue Medora is a registered trademark or trademark of Blue Medora in the United States and/or other jurisdictions.

The Amazon RDS name and logo are trademarks or registered trademarks of Amazon Web Services, Inc. in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.

Blue Medora3225 N Evergreen Dr. NE Suite 103Grand Rapids, MI 49525

bluemedora.com

You can find the most up-to-date technical documentation on the Blue Medora support site at: http://support.bluemedora.com.

The Blue Medora website also provides the latest product updates. If you have comments about this documentation, submit your feedback to: [email protected].

http://bluemedora.com

http://support.bluemedora.com

mailto:support%40bluemedora.com?subject=

vmware vrealize operations management pack for amazon rds · queries it to retrieve metrics...

Documents