NetAppDocs / NetAppDocs/element-software

Add page for QoSHistogram object

Open
#202 2 comments 0 reactions 1 assignee View on GitHub

@netapp-pcarriga is already working on this.

Since May 28, 2024.

Dominant language
No language data
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Page URL

https://docs.netapp.com/us-en/element-software/api/reference_element_api_listvolumeqoshistograms.html

Page title

ListVolumeQoSHistograms

Summary

I think this page has several problems:

a) ListVolumeQoSHistograms "generates a histogram of volume QoS usage for one volume or multiple volumes."
But not all objects are related to QoS itself. For example, writeBlockSizes and readBlockSizes merely describe the workload.

b) There's no information about the time interval over which such values are collected.

Given a belowMinIopsPercentages histogram like this:

"belowMinIopsPercentages": {
  "Bucket1To19": 100,
  "Bucket20To39": 100,
  "Bucket40To59": 100,
  "Bucket60To79": 100,
  "Bucket80To100": 0
}

Is this since the volume was created?

The docs say QoS histograms are generated approximately 5 seconds after volume creation, but does not say whether information offered by the API goes back 1 hour or all the way back.

Furthermore, belowMinIopsPercentages values from two volumes will differ, e.g. the one above has (100,100,100,100,0) while another may have (500,500,500,500,0).

In such situation, can one say that these two volumes comparable belowMinIopsPercentages is used or not? What is the difference between (1,1,1,1,0) and (2,2,2,2,0)?

c) Element API documentation for QoSHistogram object does not exist. Rather than answer the above questions I'd prefer that the missing page be created.

We have them for VolumeObject, QoSObject, etc. QoSHistogram is one of the few undocumented ones and I wouldn't ask for it simply because it's missing but as mentioned above ListVolumeQoSHistograms isn't documented nearly well enough to suffice.

Public issues must not contain sensitive information
  • This issue contains no sensitive information.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.