On-Prem Storage Dashboard

Customers require visibility into the Free vs Used vs Reserved capacity of their Storage Arrays to inform forecasting and budgeting decisions. This documentation guides users on how to access the current status of their on-prem environment, specifically focusing on storage capacity reports.

Data Collection and Storage

Virtual Wisdom collects detailed storage related metrics from various vendors through its wide range of integrations. This data is sent over to Global View using the Virtana Cloud Sync (VCS) component. This data includes the specific storage array inventory details, specific metrics which are responsible for indicating usage, analytics output which are run on the Virtual Wisdom. The Storage Capacity dashboard collates this data across multiple Virtual Wisdom appliances and shows unified view of the Storage capacity across the entire infrastructure, enabling users to get detailed insights on the storage array usage and trends.

Refer to Architecture, for more information.

Authentication

For Authentication, refer to Get Bearer Token.

Reporting Capabilities

Users have various options to generate data points, such as:

Example Queries

Purpose:  This API fetches a summarized view of entities based on the provided group by and filter criteria. It helps users quickly understand the distribution and status of different entities within their inventory.

Endpoint:  /api/inventory/entities/summary

Example:

{
  "groupBy": "entityType",
  "countBy": "entityStatus",
  "limit": "10",
  "filterBy": {
    "entityCategory": "Server",
    "isEntityTerminated": false
  }
}

Expected Response:  The response will be a JSON object containing the summary of entities grouped and counted based on the specified criteria. Each group will include the entity type, status count, and any applicable filters.

Purpose:  This API retrieves a paginated list of entities that match the provided filter criteria, allowing users to efficiently search and navigate through large sets of entities.

Endpoint:  /api/inventory/entities/search

Example

{
  "filterBy": {
    "entityType": "k8scluster"
  },
  "sortBy": [
    "entityName asc"
  ],
  "pageSize": 20
}

Components:

Expected Response:  The response will be a JSON object containing a paginated list of entities that match the provided filter criteria. Each entity in the list will include detailed information such as entity name, type, and status.

By using the Search Entities API with the specified parameters, users can efficiently retrieve, sort, and navigate through a list of entities that meet specific criteria. This aids in managing and monitoring various types of entities within the infrastructure.

The Metrics Service APIs provide a way to query and retrieve metrics data related to on-prem capacity, storage, and clusters from a timeseries database. This document details the use cases for querying specific metrics through these APIs.

Endpoint Details  : POST /api/metrics/query

Calculate: Query Used Usable Capacity

Title: Retrieve Used Usable Capacity in Gigabytes (GB)

This use case retrieves the total used usable capacity in gigabytes (GB) for each storage array, grouped by entity name and manufacturer, over the last 30 days.

Query

{
  "query": [
    "sum((UsedUsableCapacity_KB{version='1', type='StorageArray'}[30d])) by (manufacturer ) / 1024^3"
  ],
  "step": "1d",
  "start": "17066xxxx",
  "end": "17196xxxx"
}

Components:

Query Long-Term Trends

Title : Retrieve Long-Term Trends for Storage Arrays

This use case retrieves long-term trend enumeration for storage arrays over the last 30 daysThis use case retrieves long-term trend enumeration for storage arrays over the last 30 days

Query

{
  "query": [
    "(LongTermTrend_ENUM{version='1', type='StorageArray'}[30d])"
  ],
  "step": "1d",
  "time": "17xxxxx"
}

Components:

Refer to Metrics Service APIs: Metrics Service APIs

Refer to Inventory Service APIs: Inventory Service APIs