Skip to main content
Delphix

KBA1699 How to report on Delphix Engine capacity utilization

 

Issue

The Delphix Engine provides a detailed accounting of Capacity Utilization, including a breakdown by snapshot, as part of the Capacity Management screen.

In some cases, you may wish to capture this information for reporting purposes. This article discusses the available mechanisms for collecting storage utilization information from the Delphix Engine.

Several methods are native to the Delphix Engine, and there are other products in the Delphix ecosystem that can also satisfy this requirement.

Functions provided by the Delphix Engine

There are three methods of accessing this information directly from the Delphix Engine

Capacity Management Screen

The "Grid View" of the Delphix Capacity Management Screen will show the storage utilized by each dSource and virtual database (VDB). Each object can be expanded further to get a breakdown of the space used.

Since Delphix Engine 5.1, the Delphix Engine also provides a "Graph View" which shows how utilization has changed over time.

The Capacity Management Screen is an extremely effective way of navigating and visualizing capacity utilization, but it does not offer export functionality for reporting purposes.

For more information on the Capacity Management Screen, please refer to our document Using and Understanding The Capacity Management Screen.

Command Line Interface (CLI)

The CLI offers a breakdown of usage by container (dSource/VDB). For more information on the CLI, please see our Command Line Interface Guide.

The /capacity/consumer object provides a breakdown of the size of each container and the amount of space used by its snapshots (syncSpace) and logs (logSpace):

yourdelphixengine> /capacity/consumer
yourdelphixengine capacity consumer> list display=groupName,container,breakdown.actualSpace,breakdown.syncSpace,breakdown.logSpace,breakdown.descendantSpace,parent
GROUPNAME  CONTAINER   BREAKDOWN.ACTUALSPACE  BREAKDOWN.SYNCSPACE  BREAKDOWN.LOGSPACE  BREAKDOWN.DESCENDANTSPACE  PARENT
Untitled   Paxos       1.99MB                 50KB                 376KB               1KB                        -
Untitled   VPaxos_945  1.13MB                 65.50KB              376KB               0B                         Paxos
Untitled   VPaxos_C1E  1.13MB                 63.50KB              376KB               0B                         Paxos
Untitled   VPaxos_2CA  1.19MB                 104KB                376KB               0B                         Paxos

The CLI can also be used to access historical information. This is described in the document Reviewing Historical Capacity from the CLI.

For more information on the available Capacity properties, you can access API documentation directly from your Delphix Engine at http://yourdelphixengine/api/#CapacityBreakdown.

Web Service API

The information from the CLI is also available using our Web Service API.

For more information on our Web Service APIs, please consult our Web Service API Guide. Documentation on the Consumer API is available from your Delphix Engine at http://yourdelphixengine/api/#consumer .

Other reporting options

There are two other options for gathering this information which do not directly involve the Delphix Engine. These may have support and licensing implications, and are best discussed with your Delphix Customer Success Manager.

Delphix Toolkit (dxToolkit)

The Delphix Toolkit offers command line tools to manage a Delphix Engine, including a dx_get_capacity command to gather information about capacity utilization. Unlike the CLI, the dx_get_capacity command includes the ability to get a complete breakdown of utilization by snapshot.

More information about the Delphix Toolkit is available at its home on Github. The Delphix Toolkit is maintained by our Professional Services team, and support for this tool is not available directly through Delphix Support.

Mission Control

Delphix's complementary Mission Control product also offers utilization reports (e.g. "VDB Usage") across multiple engines, including export of this data to CSV or PDF. Your Delphix account team will be able to assist you if you would like to learn more about the capabilities of this product.