Bug 1396890 - use timeout option in CLI for time consuming commands
Summary: use timeout option in CLI for time consuming commands
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Gluster Storage
Classification: Red Hat
Component: doc-Administration_Guide
Version: rhgs-3.2
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: RHGS 3.2.0
Assignee: Divya
QA Contact: Prasad Desala
URL:
Whiteboard:
Depends On:
Blocks: 1351553
TreeView+ depends on / blocked
 
Reported: 2016-11-21 05:45 UTC by Atin Mukherjee
Modified: 2017-03-24 10:23 UTC (History)
10 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-03-24 10:23:16 UTC
Target Upstream Version:


Attachments (Terms of Use)

Description Atin Mukherjee 2016-11-21 05:45:52 UTC
Document URL: 
https://access.redhat.com/documentation/en-US/Red_Hat_Storage/3.1/html/Administration_Guide/

Section Number and Name: 
Not known

Describe the issue: 
Following CLI commands may get frequently timed out as GlusterD takes longer than 120 secs (default time out) to process these commands:

gluster volume status <volname> inode
gluster volume status <volname> details
gluster volume status <volname> clients

Suggestions for improvement: 

With rhgs-3.2.0 a new parameter called 'timeout' option is introduced for gluster CLI where it can be effectively configured to ensure CLI commands do not get timed out where glusterd takes longer than 120 seconds (default timeout) to process the commands.

The usage will look like:

gluster --timeout=500 volume status <volname> inode

Additional information:

Comment 2 Divya 2017-02-14 06:27:07 UTC
Atin,

I have documented the --time-out option based on the bug description.

Link to the doc: http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.2-Administration_Guide-branch-BZ-1396890-add_timeout_option/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#Displaying_Volume_Status

Please review and let me know if it requires any other change.

Thanks!

Comment 3 Atin Mukherjee 2017-02-14 13:23:00 UTC
Few corrections required:

The first sentence is formed up as "When you try to obtain information about the inode or clients or details, they may get timed out if the glusterd takes longer than 120 seconds, the default timeout, to process these commands". Instead of that can we reword it as "When you try to obtain information about inodes or clients or details of a specific volume, the command may get timed out from CLI if the originator GlusterD taken longer than 120 seconds, the default time out, to aggregate the results from all the other GlusterDs and report back to CLI".

Secondly the immediate statement provides a sort of indication that the --timeout option *only* works with volume status inode/clients/details which is not the case. It can work with any CLI, its just we are highlighting the commands which are more susceptible to time out given the heavy data exchange between the CLI & GlusterD. We have to be clear on this part.

Comment 4 Divya 2017-02-16 11:46:40 UTC
(In reply to Atin Mukherjee from comment #3)

Atin,

I have updated the documentation based on the feedback in Comment 3.

Link to the latest doc: http://ccs-jenkins.gsslab.brq.redhat.com:8080/job/doc-Red_Hat_Gluster_Storage-3.2-Administration_Guide-branch-BZ-1396890-add_timeout_option/lastSuccessfulBuild/artifact/tmp/en-US/html-single/index.html#Displaying_Volume_Status 

I have also added "timeout" option to the volume status command.

Could you please check and let me know if the changes are fine?

Comment 5 Atin Mukherjee 2017-02-16 12:16:49 UTC
Looks good.

Comment 7 Prasad Desala 2017-03-09 10:35:30 UTC
Verified the doc provided in Comment 6. The content looks good but requires below two minor changes,

Section: 19.9. Displaying Volume Status

1) "It is receommended to use --time-out option when obtaining information about the inodes or clients or details as they frequently get timed out."
>> typo error in the word "recommended"

2) Spacing issues in "gluster volume status test-volume" and "gluster volume status all" outputs.

Comment 9 Prasad Desala 2017-03-14 05:59:22 UTC
Looks good.

Comment 10 Rejy M Cyriac 2017-03-24 10:23:16 UTC
RHGS 3.2.0 GA completed on 23 March 2017


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