Mirroristas/etcd
2
0
Fork 0
mirror of https://github.com/etcd-io/etcd.git synced 2024-09-27 06:25:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve doc for server timeout

Browse Source
This commit is contained in:
Yicheng Qin 2015-01-27 11:06:26 -08:00
parent 91bd02dce1
commit a03c906e9d
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Documentation/admin_guide.md
View File

@ -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.