Browse Source

Merge pull request #2042 from yichengq/279

docs: improve doc for server timeout
Yicheng Qin 11 years ago
parent
commit
0f2582e0be
1 changed files with 9 additions and 8 deletions
  1. 9 8
      Documentation/admin_guide.md

+ 9 - 8
Documentation/admin_guide.md

@@ -185,20 +185,21 @@ etcd sets different timeouts for various types of client requests. The timeout v
 
 #### Get requests
 
-No timeout is set for get requests, because etcd can always return the result in a short time.
+Timeout is not set for get requests, because etcd serves the result locally in a non-blocking way.
+
+**Note**: QuorumGet request is a different type, which is mentioned in the following sections.
 
 #### Watch requests
 
-Unlimited timeout is set for watch requests. Clients can keep long-polling watch requests as long as they want.
+Timeout is not set for watch requests. etcd will not stop a watch request until client cancels it, or the connection is broken.
 
 #### Delete, Put, Post, QuorumGet requests
 
-The default timeout is large enough to allow all key modifications in a healthy cluster, even when it is electing a new leader.
+The default timeout is 5 seconds. It should be large enough to allow all key modifications if the majority of cluster is functioning.
 
-If the request times out, it indicates three possibilities:
+If the request times out, it indicates two possibilities:
 
-1. the request is lost when switching leader, which occurs occasionally
-2. the request is sent to a network-isolated member
-3. the cluster is unhealthy, or even out-of-work
+1. the server the request sent to was not functioning at that time.
+2. the majority of the cluster is not functioning.
 
-If case 2 or 3 happens, administrators should resolve it as soon as possible.
+If timeout happens several times continuously, administrators should check status of cluster and resolve it as soon as possible.