Bug 1368881

Summary: [DOCS] [3.3] Document the ability to diagnose metrics stacks
Product: OpenShift Container Platform Reporter: Vikram Goyal <vigoyal>
Component: DocumentationAssignee: Ashley Hardin <ahardin>
Status: CLOSED CURRENTRELEASE QA Contact: Wei Sun <wsun>
Severity: medium Docs Contact: Vikram Goyal <vigoyal>
Priority: medium    
Version: 3.3.0CC: aos-bugs, jokerman, lmeyer, mmccomas, xiazhao
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-10-06 19:08:56 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:

Description Vikram Goyal 2016-08-22 02:59:03 UTC
As a cluster administrator, I would like a way to check the health of the metrics stack so that I know it is up and running correctly.

Will need interviewing SME/Dev/GSS/QE to figure out what needs documenting.

Eng Card: https://trello.com/c/7VTcGrMB/226-5-metrics-validations-diagnostics-hawkular

Comment 1 Ashley Hardin 2016-08-22 21:28:32 UTC
@Luke Do you have any guidance on what should be documented here? Thanks!

Comment 2 Luke Meyer 2016-08-29 17:36:46 UTC
https://github.com/openshift/openshift-docs/pull/1984/files documents briefly how the metrics validations work and that you can invoke them after installation. @Vikram was there any other place you were thinking of mentioning this?

It's probably also worth mentioning that there's a diagnostic for metrics:

    oadm diagnostics MetricsApiProxy

Comment 3 Ashley Hardin 2016-08-29 18:24:52 UTC
Thanks Luke!
Work is continued in https://github.com/openshift/openshift-docs/pull/2754

Comment 5 Xia Zhao 2016-08-31 02:06:17 UTC
The metrics diagnose document looks good to me, set it to verified. Thanks.

Comment 6 openshift-github-bot 2016-08-31 14:59:08 UTC
Commits pushed to master at https://github.com/openshift/openshift-docs

https://github.com/openshift/openshift-docs/commit/bdbf2a01563bec679b7256327a42abbff2f946be
Bug 1368881, added information about the diagnostic for metrics in the Metrics Deployer Validations section

https://github.com/openshift/openshift-docs/commit/2260b828ac4ddc64e6235a78a801ce691f8a6a50
Merge pull request #2754 from ahardin-rh/Bug-1368881

Bug 1368881, added info about the diagnostic for metrics in the Metrics Deployer Validations section

Comment 7 Vikram Goyal 2016-09-01 05:51:59 UTC
(In reply to Luke Meyer from comment #2)
> https://github.com/openshift/openshift-docs/pull/1984/files documents
> briefly how the metrics validations work and that you can invoke them after
> installation. @Vikram was there any other place you were thinking of
> mentioning this?

Hey Luke - not really sure. The current PR doesn't show HOW the command would work. Is that something we can incorporate into the docs? Ashley?

> 
> It's probably also worth mentioning that there's a diagnostic for metrics:
> 
>     oadm diagnostics MetricsApiProxy

Comment 8 Luke Meyer 2016-09-26 18:32:34 UTC
(In reply to Vikram Goyal from comment #7)

Sorry, I missed this.

> Hey Luke - not really sure. The current PR doesn't show HOW the command
> would work. Is that something we can incorporate into the docs? Ashley?

Which command do you mean, and what kind of "show how" are you thinking - an example of the command running and its output?

Comment 9 Vikram Goyal 2016-09-28 01:43:59 UTC
(In reply to Luke Meyer from comment #8)
> (In reply to Vikram Goyal from comment #7)
> 
> Sorry, I missed this.
> 
> > Hey Luke - not really sure. The current PR doesn't show HOW the command
> > would work. Is that something we can incorporate into the docs? Ashley?
> 
> Which command do you mean, and what kind of "show how" are you thinking - an
> example of the command running and its output?

That was my initial thought. To show the command running and the output. At the moment, we have published the docs as is, but perhaps if you could submit another PR to illustrate that that would be great. 

Thanks Luke!