Bug 1699233 - [DOC] Document ceph-mgr restful /request endpoint
Summary: [DOC] Document ceph-mgr restful /request endpoint
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Ceph Storage
Classification: Red Hat Storage
Component: Documentation
Version: 3.2
Hardware: x86_64
OS: Linux
unspecified
high
Target Milestone: z1
: 3.3
Assignee: Bara Ancincova
QA Contact: Tejas
Jennifer Patton
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-04-12 07:58 UTC by Servesha
Modified: 2023-03-24 14:49 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-10-23 11:08:48 UTC
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHCEPH-6310 0 None None None 2023-03-24 14:49:42 UTC

Description Servesha 2019-04-12 07:58:57 UTC
Description of problem: 

Customer wants to have exact same functions in mgr-resful-module which is present in deprecated ceph-rest-api. 
The following things related to rgw are not included in mgr-restful-module:


rgw successful requests 
rgw failed requests 
rgw performance details (read/write iops, latency, throughput etc)
rgw active connections 
rgw active thread number 

In mgr-module we can see the information about particular request using url => https://10.74.255.33:8003/request and https://10.74.255.33:8003/request/<id> , but we are unable to see the set of rgw failed request, rgw successful requests, rgw active thread number , connections and rgw performance details.

The information about other arguments regarding rgw can be seen using url =>  https://10.74.255.33:8003/config/cluster

But as we can see information related to monitor and osd separately using url => https://10.74.255.33:8003/mon and https://10.74.255.33:8003/osd respectively


Version-Release number of selected component (if applicable): RHCS 3.2


How reproducible: Always


Steps to Reproduce:
1. Enable and configure mgr restful module

Actual results: Some rgw bits [ bits Mentioned below under Expected result ] are absent in mgr plugin.


Expected results: 

rgw successful requests 
rgw failed requests 
rgw performance details (read/write iops, latency, throughput etc)
rgw active connections 
rgw active thread number 

These should be included in mgr restful plugin.


Additional info: 

I followed below doc to refer to mgr-module. 

https://access.redhat.com/documentation/en-us/red_hat_ceph_storage/3/html/ceph_management_api/questions-and-answers

Thanks

Best regards,
Servesha

Comment 2 Boris Ranto 2019-04-30 08:35:21 UTC
Related:

https://github.com/ceph/ceph/pull/27885

Comment 3 Boris Ranto 2019-04-30 10:31:26 UTC
For 3.3, we could include the PR mentioned above if/when merged.

Comment 4 Boris Ranto 2019-06-04 23:51:38 UTC
We need to use this bz to track the documentation effort for the ceph-mgr restful /request endpoint since I used the other bz to track the rgw bits back-port.

Comment 5 Boris Ranto 2019-07-18 10:43:02 UTC
The upstream docs should be a starting point for documenting the /request endpoint:

http://docs.ceph.com/docs/master/mgr/restful/#the-request-endpoint

Comment 7 Giridhar Ramaraju 2019-08-05 13:08:15 UTC
Updating the QA Contact to a Hemant. Hemant will be rerouting them to the appropriate QE Associate. 

Regards,
Giri

Comment 8 Giridhar Ramaraju 2019-08-05 13:09:45 UTC
Updating the QA Contact to a Hemant. Hemant will be rerouting them to the appropriate QE Associate. 

Regards,
Giri


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