VMWARE VREALIZE OPERATIONS MANAGEMENT PACK FOR Amazon DynamoDB · PDF file3 Blue Medora VMware vRealize Operations Management Pack for Amazon DynamoDB User Guide 1. Purpose The Blue

VMWARE VREALIZE OPERATIONS MANAGEMENT PACK FOR

Amazon DynamoDB

User Guide

2 Blue Medora VMware vRealize Operations Management Pack for Amazon DynamoDB 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 DynamoDB Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53.2 Amazon DynamoDB Capacity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63.3 Amazon DynamoDB Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

4. Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85. Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96. Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107. Analysis Badges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .118. Troubleshooting the Management Pack . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

8.1 Troubleshooting an Adapter Instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128.2 Testing Connection Failures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128.3 Viewing System Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12

9. Appendix I: Metrics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1310. Appendix II: Alerts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1611. Appendix III: Capacity Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .17

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 DynamoDB User Guide describes the primary features of the Management Pack for Amazon DynamoDB, including dashboards, views, reports, alerts, and metrics that allow users to optimize the monitoring and management of DynamoDB resources from within vRealize Operations.

2. Introduction to the Management Pack

The Management Pack for Amazon DynamoDB is an embedded adapter for vRealize Operations (vROps) that monitors DynamoDB systems remotely. The Management Pack retrieves data regarding resources by connecting to each supported DynamoDB 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 DynamoDB device and queries it to retrieve metrics regarding DynamoDB 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 DynamoDB resources:

1. Amazon DynamoDB Global Secondary Index

2. Amazon DynamoDB Key Schema

3. Amazon DynamoDB Local Secondary Index

4. Amazon DynamoDB Table


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.

Figure 1: Example Traversal Spec


3. Dashboards

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

The following dashboards are available in the Management Pack:

• Amazon DynamoDB Overview

• Amazon DynamoDB Capacity

• Amazon DynamoDB Details

3.1 Amazon DynamoDB Overview

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

Figure 2: Amazon DynamoDB Overview Dashboard


3.2 Amazon DynamoDB Capacity

The Amazon DynamoDB Capacity dashboard provides an overview of your Amazon DynamoDB table capacity through a health-related heatmap. Select a table from the heatmap to view its top highest utilization of read units and write units.

Figure 3: Amazon DynamoDB Capacity Dashboard


3.3 Amazon DynamoDB Details

The Amazon DynamoDB Details dashboard provides details about your Amazon DynamoDB tables. Select an adapter instance and related table from the top widgets to view its read and write capacity usage, workload information, and health.

Figure 4: Amazon DynamoDB Details Dashboard


4. Views

The vROps Management Pack for Amazon DynamoDB creates views that allow the user to view statistics of metrics for various DynamoDB 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 DESCRIPTION

Amazon DynamoDB Table Capacity List Show provisioned and consumed read and write capacity for Amazon DynamoDB tables.

Amazon DynamoDB Table Events List Show throttle events along with error metrics.

Amazon DynamoDB Table Read Usage Trend Graph of provisioned and consumed Read Capacity Units.

Amazon DynamoDB Table Write Usage Trend Graph of provisioned and consumed Write Capacity Units.

To access the Management Pack views, go to Environment > All Objects > Amazon DynamoDB 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 5: Accessing Management Pack Views


5. Reports

The Management Pack for Amazon DynamoDB contains two 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 DynamoDB Table Capacity Report

• Amazon DynamoDB Table Events Report

To access the Management Pack reports, go to Environment > All Objects > Amazon DynamoDB 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 6: Accessing Management Pack Reports


6. Alerts

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

Figure 7: Alert Example


7. Analysis Badges

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

Figure 8: 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 DynamoDB.

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/AmazonDynamoDBAdapter/ 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 DynamoDB collects the following metrics by DynamoDB Resource Kinds.

Table 2: Management Pack Metrics

RESOURCE KIND RESOURCE GROUP

RESOURCE ATTRIBUTE

ATTRIBUTE TYPE ATTRIBUTE DESCRIPTION

Amazon DynamoDB Global Secondary Index

Errors System Errors float The System Errors of the Global Secondary Index.


General Backfilling string Indicates if the Global Secondary Index is backfilling.


General Item Count integer The Item Count of the Global Secondary Index.


General Size integer The Size of the Global Secondary Index.


General Status string The Status of the Global Secondary Index.


Online IndexOnline Index Consumed Write Capacity

floatThe Online Index Consumed Write Capacity of the Global Secondary Index.


Online Index Online Index Percentage Progress float

The Online Index Percentage Progress of the Global Secondary Index.


Online Index Online Index Throttle Events integer The Online Index Throttle Events

of the Global Secondary Index.


Read Capacity Consumed Read Capacity float The Consumed Read Capacity of

the Global Secondary Index.


Read Capacity Provisioned Read Capacity float The Provisioned Read Capacity of



Read Capacity Read Throttle Events float The Read Throttle Events of the Global Secondary Index.


Relationships Key Schema Children string List of child Key Schema

resources


Relationships Table Parents string List of parent Table resources


Requests Throttled Requests integer The Throttled Requests of the Global Secondary Index.



RESOURCE ATTRIBUTE



Write Capacity Consumed Write Capacity float The Consumed Write Capacity of



Write Capacity Provisioned Write Capacity float The Provisioned Write Capacity of



Write Capacity Write Throttle Events float The Write Throttle Events of the Global Secondary Index.

Amazon DynamoDB Key Schema Properties Role string The Role of the Key Schema.

Amazon DynamoDB Key Schema Relationships Global Secondary

Index Parents string List of parent Global Secondary Index resources

Amazon DynamoDB Key Schema Relationships Local Secondary

Index Parents string List of parent Local Secondary Index resources

Amazon DynamoDB Local Secondary Index

General Item Count integer The Item Count of the Local Secondary Index.


General Size integer The Size of the Local Secondary Index.


Relationships Key Schema Children string List of child Key Schema

resources


Relationships Table Parents string List of parent Table resources

Amazon DynamoDB Table Errors System Errors float The System Errors of the Table.

Amazon DynamoDB Table Errors User Errors float The User Errors of the Table.

Amazon DynamoDB Table General Returned Items float The Returned Items of the Table.

Amazon DynamoDB Table General Size float The Size of the Table.

Amazon DynamoDB Table General Status string The Status of the Table.

Amazon DynamoDB Table Online Index

Online Index Consumed Write Capacity

float The Online Index Consumed Write Capacity of the Table.

Amazon DynamoDB Table Online Index Online Index

Percentage Progress float The Online Index Percentage Progress of the Table.

Amazon DynamoDB Table Online Index Online Index Throttle

Events integer The Online Index Throttle Events of the Table.

Amazon DynamoDB Table Read Capacity Consumed Read

Capacity float The Consumed Read Capacity of the Table.



RESOURCE ATTRIBUTE


Amazon DynamoDB Table Read Capacity Provisioned Read

Capacity float The Provisioned Read Capacity of the Table.

Amazon DynamoDB Table Read Capacity Read Throttle Events integer The Read Throttle Events of the

Table.

Amazon DynamoDB Table Read Capacity Read Capacity

Usage float Usage of Provisioned Read Capacity

Amazon DynamoDB Table Relationships Global Secondary

Index Children string List of child Global Secondary Index resources

Amazon DynamoDB Table Relationships Local Secondary

Index Children string List of child Local Secondary Index resources

Amazon DynamoDB Table Relationships

Amazon DynamoDB Adapter Instance Parent

string List of parent Amazon DynamoDB Adapter Instance resources

Amazon DynamoDB Table Requests Conditional Check

Failed Requests float The Conditional Check Failed Requests of the Table.

Amazon DynamoDB Table Requests Successful Request

Latency float The Successful Request Latency of the Table.

Amazon DynamoDB Table Requests Throttled Requests integer The Throttled Requests of the

Table.

Amazon DynamoDB Table Write Capacity Consumed Write

Capacity float The Consumed Write Capacity of the Table.

Amazon DynamoDB Table Write Capacity Provisioned Write

Capacity float The Provisioned Write Capacity of the Table.

Amazon DynamoDB Table Write Capacity Write Throttle Events integer The Write Throttle Events of the

Table.

Amazon DynamoDB Table Write Capacity Write Capacity

Usage float Usage of Provisioned Write Capacity


10. Appendix II: Alerts

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

• Amazon DynamoDB Table has User Errors

• Amazon DynamoDB Table has Write Throttle Events

• Amazon DynamoDB Table has Read Throttle Events

• Amazon DynamoDB Table has System Errors

• Amazon DynamoDB Table Consumed Read Capacity is Approaching Provisioned

• Amazon DynamoDB Table Consumed Read Capacity has Exceeded Provisioned

• Amazon DynamoDB Table Consumed Write Capacity is Approaching Provisioned

• Amazon DynamoDB Table Consumed Write Capacity has Exceeded Provisioned


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 USE IN WORKLOAD

Amazon DynamoDB Table

vRealize Calculated Read Capacity yes

vRealize Calculated Write Capacity yes

Copyright © 2016 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 DynamoDB 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=

Documents

VMWARE VREALIZE OPERATIONS MANAGEMENT PACK FOR Amazon DynamoDB · PDF file3 Blue Medora VMware vRealize Operations Management Pack for Amazon DynamoDB User Guide 1. Purpose The Blue