Bug 1528221

Summary:	[Docs][RFE][Metrics User] Document Disk Plugin based on available documentation
Product:	Red Hat Enterprise Virtualization Manager	Reporter:	Emma Heftman <eheftman>
Component:	Documentation	Assignee:	Emma Heftman <eheftman>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Avital Pinnick <apinnick>
Severity:	unspecified	Docs Contact:
Priority:	high
Version:	4.2.0	CC:	lbopf, lsurette, rbalakri, rhev-docs, sradco, srevivo, ykaul
Target Milestone:	ovirt-4.2.1	Keywords:	FutureFeature, Triaged
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:	docs-accepted
Fixed In Version:		Doc Type:	Enhancement
Doc Text:		Story Points:	---
Clone Of:	1528219
Clones:	1528225 (view as bug list)		Environment:
Last Closed:	2018-01-14 12:34:36 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	Docs	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:
Bug Depends On:
Bug Blocks:	1464013

Description Emma Heftman 2017-12-21 10:35:08 UTC

collectd.disk.disk_ops.read
collectd.disk.disk_ops.write
collectd.disk.disk_merged.read
collectd.disk.disk_merged.write
collectd.disk.disk_time.read
collectd.disk.disk_time.write
collectd.disk.pending_operations
collectd.disk.disk_io_time.io_time
collectd.disk.disk_io_time.weighted_io_time

Available docs: https://github.com/signalfx/integrations/tree/master/collectd-disk/docs

Comment 1 Lucy Bopf 2017-12-22 00:45:40 UTC

Accepting into Beta 2 program, and assigning to Emma for review.

Comment 2 Emma Heftman 2017-12-25 16:02:15 UTC

The following were metrics were not covered by existing documentation, as we originally thought, and therefore will be handled by a separate bug (BZ#1528891), as more time will be required to investigate:
|collectd.disk.pending_operations 
|collectd.disk.disk_io_time.io_time
|collectd.disk.disk_io_time.weighted_io_time

Comment 3 Emma Heftman 2017-12-25 16:35:14 UTC

According to the collectd documentation: "The metrics are reported per physical disk, and where supported, per partition. "

Do we implementation the collection of metrics from partitions?

Comment 4 Shirly Radco 2017-12-26 08:03:34 UTC

See also, https://collectd.org/documentation/manpages/collectd.conf.5.shtml#plugin_disk

We use default configurations for this plugin.

Comment 5 Shirly Radco 2017-12-26 08:04:51 UTC

So, yes. If it is possible we collect metrics per physical disks and logical disks (partitions).

Comment 6 Emma Heftman 2017-12-26 10:02:09 UTC

Hey Shirly
A question about the derive type. The collectd documentation says:
"rate = value(new)-value(old)\
                time(new)-time(old) 
NOTE - If value(new) is less than value (old), the resulting rate will be negative. If you set the minimum value to zero, such data points will be discarded. "

Do we set our minimum value to zero by default?

Comment 8 Shirly Radco 2017-12-27 12:52:54 UTC

The 3 missing metrics

|collectd.disk.pending_operations 
|collectd.disk.disk_io_time.io_time
|collectd.disk.disk_io_time.weighted_io_time

are documented at https://collectd.org/wiki/index.php/Plugin:Disk

Comment 9 Emma Heftman 2017-12-27 14:22:28 UTC

(In reply to Shirly Radco from comment #8)
> The 3 missing metrics
> 
> |collectd.disk.pending_operations 
> |collectd.disk.disk_io_time.io_time
> |collectd.disk.disk_io_time.weighted_io_time
> 
> are documented at https://collectd.org/wiki/index.php/Plugin:Disk

I added the additional plugins and updated the link. Please review:
http://file.tlv.redhat.com/~eheftman/bz1528221/html-single/#chap-Metrics