Bug 1548500 - [DOCS] Clearly Specify Router Metrics file format returned
Summary: [DOCS] Clearly Specify Router Metrics file format returned
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 3.6.0
Hardware: Unspecified
OS: Unspecified
unspecified
low
Target Milestone: ---
: ---
Assignee: Michael Burke
QA Contact: Hongan Li
Vikram Goyal
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2018-02-23 17:06 UTC by Juana Nakfour
Modified: 2022-03-13 14:43 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-08-02 15:27:09 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Knowledge Base (Solution) 3406591 0 None None None 2018-05-25 19:31:49 UTC

Description Juana Nakfour 2018-02-23 17:06:50 UTC
Document URL: 
https://docs.openshift.com/container-platform/3.6/install_config/router/default_haproxy_router.html#exposing-the-router-metrics
Section Number and Name: 
Exposing Router Metrics

Describe the issue: 
1. Documentation states, if ROUTER_METRICS_TYPE is set (by default) to haproxy then 
http://admin:<Password>@localhost:1936/metrics should return Prometheus format statistics.
My testing revealed we get a text file with csv Prometheus format statistics with only /metrics exposed.



2.  Documentation states, if ROUTER_METRICS_TYPE is deleted we get HAproxy csv metrics on http://admin:<Password>@localhost:1936/metrics.

My testing revealed we get an html file with statistics on ANY url. Meaning /metrics /ANYTHING will return that html file that has an option to CSV export.

Suggestions for improvement: 
Please clearly specify both the url to get the metrics and the actual file time returned, txt or html

Additional information:

Comment 2 Michael Burke 2018-07-03 00:00:51 UTC
6/30 @knobunc Is this something your team can help with? (I pulled a QuickLab instance to test, but it won't allow users to get metrics.)

Comment 3 Ben Bennett 2018-07-10 20:04:59 UTC
What do you need?  Dan Mace (needinfo'd) is probably the right person now to do that.  He's the Network Edge lead (and the Router is part of that).

Comment 4 Michael Burke 2018-07-10 20:29:42 UTC
The reporter is asking for at least:
"Suggestions for improvement: 
Please clearly specify both the url to get the metrics and the actual file time returned, txt or html" based on ROUTER_METRICS_TYPE being set or not (if I read the concern correctly. 

See Description  https://bugzilla.redhat.com/show_bug.cgi?id=1548500#c0 and changes I made via PR https://github.com/openshift/openshift-docs/pull/10549/files

Comment 5 Hongan Li 2018-07-17 02:18:58 UTC
The doc PR looks good, will move BZ to VERIFIED when it is merged. Thanks


Note You need to log in before you can comment on or make changes to this bug.