Bug 1613705

Summary: Description of IOPS chart in "Disk Load" section of Brick dashboard is insufficient
Product: [Red Hat Storage] Red Hat Gluster Storage Reporter: Martin Bukatovic <mbukatov>
Component: web-admin-tendrl-monitoring-integrationAssignee: gowtham <gshanmug>
Status: CLOSED ERRATA QA Contact: Filip Balák <fbalak>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: rhgs-3.4CC: anbehl, apaladug, fbalak, gshanmug, julim, nthomas, rhs-bugs, sankarshan
Target Milestone: ---Keywords: ZStream
Target Release: RHGS 3.4.z Batch Update 1   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: tendrl-monitoring-integration-1.6.3-13.el7rhgs Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2018-10-31 08:45:18 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Attachments:
Description Flags
screenshot 1: IOPS charts on Brick dashboard none

Description Martin Bukatovic 2018-08-08 08:08:18 UTC 
Description of problem
======================

Description of IOPS chart in "Disk Load" section of Brick dashboard is not
clear enough, because there is another IOPS chart in At-a-Glance section of
the same dashboard, which shows different data, but the description doesn't
provide answers to questions like:

 * what is the difference between data shown on IOPS chart in At-a-Glance
   and Disk Load section
 * why is having both useful
 * how to read the charts when for the same time range, different values
   (including trends, and range of iops values) are shown on these charts

Version-Release number of selected component
============================================

tendrl-monitoring-integration-1.6.3-7.el7rhgs.noarch

How reproducible
================

100 %

Steps to Reproduce
==================

1. Instal RHGS WA using tendrl-ansible
2. Import Trusted storage pool with at least one volume, enable profiling
3. Run some workload for few hours
4. Disable profiling
5. Run some workload for few hours
6. Go to Brick dashboard and IOPS panels there, including both values
   and description

Actual results
==============

Both IOPS chars shows different data during the same time range, but the
description of the IOPS chart doesn't explain this clear enough.

Description of IOPS chart in Disk Load section is general (which would not
be a problem if there weren't another IOPS chart in At-a-Glance section with
different data):

> The IOPS panel displays IOPS for a brick over a period of time.
> IOPS is based on brick level read and write operations.

Description of IOPS chart in At-a-Glance section (for reference):

> The IOPS panel displays aggregated read and write operations collected
> when the brick is part of a volume that has volume profiling enabled.
> No data will be shown if the volume that the brick is a member of does not
> have volume profiling enabled.

see screenshot 1

Expected results
================

The descriptions is clear enough so that customer would be able to understand:

 * why there are 2 IOPS charts in the brick dashboard
 * what is the difference between the two
 * how to interpret different values shown on both charts
Comment 1 Martin Bukatovic 2018-08-08 08:09:49 UTC 
Created attachment 1474192 [details]
screenshot 1: IOPS charts on Brick dashboard
Comment 6 Ju Lim 2018-09-07 18:29:05 UTC 
My suggestions are:

(1) Change label to “Disk IOPS” (and makes it consistent with the naming in the Host Dashboard.  This would make it clearer that this IOPS is different vs. the IOPS panel in the At-A-Glance section.

Change description to:
The Disk IOPS panel displays the aggregated IOPS of the underlying devices a brick is mounted on.
Comment 7 Ju Lim 2018-09-10 11:43:30 UTC 
Change the IOPS label in the At-A-Glance to Bricks IOPS.
Comment 8 Nishanth Thomas 2018-09-10 16:11:45 UTC 
providing acks based on https://bugzilla.redhat.com/show_bug.cgi?id=1613705#c6 and https://bugzilla.redhat.com/show_bug.cgi?id=1613705#c7
Comment 9 Martin Bukatovic 2018-09-11 08:49:10 UTC 
I'm ok with the proposed changes (as described by Ju above), and propose to
tackle the rest of my points (see list below) in WA documentation.

 * [ ] why there are 2 IOPS charts in the brick dashboard
 * [ ] how to interpret different values shown on both charts
Comment 11 gowtham 2018-09-11 11:15:29 UTC 
What I saw from code is disk IOPS panels shows Aggregation of value based on the number of input and output happening in devices where the brick belongs to (brick can be created from multiple devices also). So the value is an aggregation of IOPS on brick devices. 


brick IOPS panels show value when the input and out happening via its mount point only. It only cares about brick mount point.
Comment 12 gowtham 2018-09-11 11:36:54 UTC 
PR is under review: https://github.com/Tendrl/monitoring-integration/pull/567
Comment 13 Martin Bukatovic 2018-09-11 16:09:09 UTC 
I have created separate doc BZ 1627835 for tracking of documentation details for:

 * [ ] why there are 2 IOPS charts in the brick dashboard
 * [ ] how to interpret different values shown on both charts
Comment 15 Filip Balák 2018-10-04 12:05:35 UTC 
There are now panels with descriptions:

Brick IOPS
The IOPS panel displays aggregated read and write operations collected when the brick is part of a volume that has volume profiling enabled. No data will be shown if the volume that the brick is a member of does not have volume profiling enabled.

Disk IOPS
The Disk IOPS panel displays the aggregated IOPS of the underlying devices a brick is mounted on.

As per comments 9 and 13 in this bz is tracked only:

 * [x] what is the difference between the two panels

which is satisfied with the change of panel titles and descriptions. --> VERIFIED

Tested with:
tendrl-ansible-1.6.3-7.el7rhgs.noarch
tendrl-api-1.6.3-7.el7rhgs.noarch
tendrl-api-httpd-1.6.3-7.el7rhgs.noarch
tendrl-commons-1.6.3-12.el7rhgs.noarch
tendrl-grafana-plugins-1.6.3-13.el7rhgs.noarch
tendrl-grafana-selinux-1.5.4-2.el7rhgs.noarch
tendrl-monitoring-integration-1.6.3-13.el7rhgs.noarch
tendrl-node-agent-1.6.3-10.el7rhgs.noarch
tendrl-notifier-1.6.3-4.el7rhgs.noarch
tendrl-selinux-1.5.4-2.el7rhgs.noarch
tendrl-ui-1.6.3-11.el7rhgs.noarch
Comment 17 errata-xmlrpc 2018-10-31 08:45:18 UTC 
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2018:3427