|
@@ -0,0 +1,198 @@
|
|
1
|
+From 75c98ad211c9e1b7304033b9d3eb4fe552d725d2 Mon Sep 17 00:00:00 2001
|
|
2
|
+From: James Westby <james.westby@canonical.com>
|
|
3
|
+Date: Tue, 8 Jul 2014 10:14:57 -0400
|
|
4
|
+Subject: [PATCH 20/21] DOC: expand the docs for the provided stats.
|
|
5
|
+
|
|
6
|
+Indicate for each statistic which types may have a value for
|
|
7
|
+that statistic.
|
|
8
|
+
|
|
9
|
+Explain some of the provided statistics a little more deeply.
|
|
10
|
+(cherry picked from commit ebe62d645b45aa2210ef848fa16805a0aba7d75a)
|
|
11
|
+---
|
|
12
|
+ doc/configuration.txt | 163 +++++++++++++++++++++++++++++++-------------------
|
|
13
|
+ 1 file changed, 100 insertions(+), 63 deletions(-)
|
|
14
|
+
|
|
15
|
+diff --git a/doc/configuration.txt b/doc/configuration.txt
|
|
16
|
+index 73195ba..8407500 100644
|
|
17
|
+--- a/doc/configuration.txt
|
|
18
|
++++ b/doc/configuration.txt
|
|
19
|
+@@ -13075,44 +13075,76 @@ text is doubled ('""'), which is the format that most tools recognize. Please
|
|
20
|
+ do not insert any column before these ones in order not to break tools which
|
|
21
|
+ use hard-coded column positions.
|
|
22
|
+
|
|
23
|
+- 0. pxname: proxy name
|
|
24
|
+- 1. svname: service name (FRONTEND for frontend, BACKEND for backend, any name
|
|
25
|
+- for server)
|
|
26
|
+- 2. qcur: current queued requests
|
|
27
|
+- 3. qmax: max queued requests
|
|
28
|
+- 4. scur: current sessions
|
|
29
|
+- 5. smax: max sessions
|
|
30
|
+- 6. slim: sessions limit
|
|
31
|
+- 7. stot: total sessions
|
|
32
|
+- 8. bin: bytes in
|
|
33
|
+- 9. bout: bytes out
|
|
34
|
+- 10. dreq: denied requests
|
|
35
|
+- 11. dresp: denied responses
|
|
36
|
+- 12. ereq: request errors
|
|
37
|
+- 13. econ: connection errors
|
|
38
|
+- 14. eresp: response errors (among which srv_abrt)
|
|
39
|
+- 15. wretr: retries (warning)
|
|
40
|
+- 16. wredis: redispatches (warning)
|
|
41
|
+- 17. status: status (UP/DOWN/NOLB/MAINT/MAINT(via)...)
|
|
42
|
+- 18. weight: server weight (server), total weight (backend)
|
|
43
|
+- 19. act: server is active (server), number of active servers (backend)
|
|
44
|
+- 20. bck: server is backup (server), number of backup servers (backend)
|
|
45
|
+- 21. chkfail: number of failed checks
|
|
46
|
+- 22. chkdown: number of UP->DOWN transitions
|
|
47
|
+- 23. lastchg: last status change (in seconds)
|
|
48
|
+- 24. downtime: total downtime (in seconds)
|
|
49
|
+- 25. qlimit: queue limit
|
|
50
|
+- 26. pid: process id (0 for first instance, 1 for second, ...)
|
|
51
|
+- 27. iid: unique proxy id
|
|
52
|
+- 28. sid: service id (unique inside a proxy)
|
|
53
|
+- 29. throttle: warm up status
|
|
54
|
+- 30. lbtot: total number of times a server was selected
|
|
55
|
+- 31. tracked: id of proxy/server if tracking is enabled
|
|
56
|
+- 32. type (0=frontend, 1=backend, 2=server, 3=socket)
|
|
57
|
+- 33. rate: number of sessions per second over last elapsed second
|
|
58
|
+- 34. rate_lim: limit on new sessions per second
|
|
59
|
+- 35. rate_max: max number of new sessions per second
|
|
60
|
+- 36. check_status: status of last health check, one of:
|
|
61
|
++In brackets after each field name are the types which may have a value for
|
|
62
|
++that field. The types are L (Listeners), F (Frontends), B (Backends), and
|
|
63
|
++S (Servers).
|
|
64
|
++
|
|
65
|
++ 0. pxname [LFBS]: proxy name
|
|
66
|
++ 1. svname [LFBS]: service name (FRONTEND for frontend, BACKEND for backend,
|
|
67
|
++ any name for server/listener)
|
|
68
|
++ 2. qcur [..BS]: current queued requests. For the backend this reports the
|
|
69
|
++ number queued without a server assigned.
|
|
70
|
++ 3. qmax [..BS]: max value of qcur
|
|
71
|
++ 4. scur [LFBS]: current sessions
|
|
72
|
++ 5. smax [LFBS]: max sessions
|
|
73
|
++ 6. slim [LFBS]: configured session limit
|
|
74
|
++ 7. stot [LFBS]: cumulative number of connections
|
|
75
|
++ 8. bin [LFBS]: bytes in
|
|
76
|
++ 9. bout [LFBS]: bytes out
|
|
77
|
++ 10. dreq [LFB.]: requests denied because of security concerns.
|
|
78
|
++ - For tcp this is because of a matched tcp-request content rule.
|
|
79
|
++ - For http this is because of a matched http-request or tarpit rule.
|
|
80
|
++ 11. dresp [LFBS]: responses denied because of security concerns.
|
|
81
|
++ - For http this is because of a matched http-request rule, or
|
|
82
|
++ "option checkcache".
|
|
83
|
++ 12. ereq [LF..]: request errors. Some of the possible causes are:
|
|
84
|
++ - early termination from the client, before the request has been sent.
|
|
85
|
++ - read error from the client
|
|
86
|
++ - client timeout
|
|
87
|
++ - client closed connection
|
|
88
|
++ - various bad requests from the client.
|
|
89
|
++ - request was tarpitted.
|
|
90
|
++ 13. econ [..BS]: number of requests that encountered an error trying to
|
|
91
|
++ connect to a backend server. The backend stat is the sum of the stat
|
|
92
|
++ for all servers of that backend, plus any connection errors not
|
|
93
|
++ associated with a particular server (such as the backend having no
|
|
94
|
++ active servers).
|
|
95
|
++ 14. eresp [..BS]: response errors. srv_abrt will be counted here also.
|
|
96
|
++ Some other errors are:
|
|
97
|
++ - write error on the client socket (won't be counted for the server stat)
|
|
98
|
++ - failure applying filters to the response.
|
|
99
|
++ 15. wretr [..BS]: number of times a connection to a server was retried.
|
|
100
|
++ 16. wredis [..BS]: number of times a request was redispatched to another
|
|
101
|
++ server. The server value counts the number of times that server was
|
|
102
|
++ switched away from.
|
|
103
|
++ 17. status [LFBS]: status (UP/DOWN/NOLB/MAINT/MAINT(via)...)
|
|
104
|
++ 18. weight [..BS]: server weight (server), total weight (backend)
|
|
105
|
++ 19. act [..BS]: server is active (server), number of active servers (backend)
|
|
106
|
++ 20. bck [..BS]: server is backup (server), number of backup servers (backend)
|
|
107
|
++ 21. chkfail [...S]: number of failed checks. (Only counts checks failed when
|
|
108
|
++ the server is up.)
|
|
109
|
++ 22. chkdown [..BS]: number of UP->DOWN transitions. The backend counter counts
|
|
110
|
++ transitions to the whole backend being down, rather than the sum of the
|
|
111
|
++ counters for each server.
|
|
112
|
++ 23. lastchg [..BS]: number of seconds since the last UP<->DOWN transition
|
|
113
|
++ 24. downtime [..BS]: total downtime (in seconds). The value for the backend
|
|
114
|
++ is the downtime for the whole backend, not the sum of the server downtime.
|
|
115
|
++ 25. qlimit [...S]: configured maxqueue for the server, or nothing in the
|
|
116
|
++ value is 0 (default, meaning no limit)
|
|
117
|
++ 26. pid [LFBS]: process id (0 for first instance, 1 for second, ...)
|
|
118
|
++ 27. iid [LFBS]: unique proxy id
|
|
119
|
++ 28. sid [L..S]: server id (unique inside a proxy)
|
|
120
|
++ 29. throttle [...S]: current throttle percentage for the server, when
|
|
121
|
++ slowstart is active, or no value if not in slowstart.
|
|
122
|
++ 30. lbtot [..BS]: total number of times a server was selected, either for new
|
|
123
|
++ sessions, or when re-dispatching. The server counter is the number
|
|
124
|
++ of times that server was selected.
|
|
125
|
++ 31. tracked [...S]: id of proxy/server if tracking is enabled.
|
|
126
|
++ 32. type [LFBS]: (0=frontend, 1=backend, 2=server, 3=socket/listener)
|
|
127
|
++ 33. rate [.FBS]: number of sessions per second over last elapsed second
|
|
128
|
++ 34. rate_lim [.F..]: configured limit on new sessions per second
|
|
129
|
++ 35. rate_max [.FBS]: max number of new sessions per second
|
|
130
|
++ 36. check_status [...S]: status of last health check, one of:
|
|
131
|
+ UNK -> unknown
|
|
132
|
+ INI -> initializing
|
|
133
|
+ SOCKERR -> socket error
|
|
134
|
+@@ -13129,31 +13161,36 @@ use hard-coded column positions.
|
|
135
|
+ L7TOUT -> layer 7 (HTTP/SMTP) timeout
|
|
136
|
+ L7RSP -> layer 7 invalid response - protocol error
|
|
137
|
+ L7STS -> layer 7 response error, for example HTTP 5xx
|
|
138
|
+- 37. check_code: layer5-7 code, if available
|
|
139
|
+- 38. check_duration: time in ms took to finish last health check
|
|
140
|
+- 39. hrsp_1xx: http responses with 1xx code
|
|
141
|
+- 40. hrsp_2xx: http responses with 2xx code
|
|
142
|
+- 41. hrsp_3xx: http responses with 3xx code
|
|
143
|
+- 42. hrsp_4xx: http responses with 4xx code
|
|
144
|
+- 43. hrsp_5xx: http responses with 5xx code
|
|
145
|
+- 44. hrsp_other: http responses with other codes (protocol error)
|
|
146
|
+- 45. hanafail: failed health checks details
|
|
147
|
+- 46. req_rate: HTTP requests per second over last elapsed second
|
|
148
|
+- 47. req_rate_max: max number of HTTP requests per second observed
|
|
149
|
+- 48. req_tot: total number of HTTP requests received
|
|
150
|
+- 49. cli_abrt: number of data transfers aborted by the client
|
|
151
|
+- 50. srv_abrt: number of data transfers aborted by the server (inc. in eresp)
|
|
152
|
+- 51. comp_in: number of HTTP response bytes fed to the compressor
|
|
153
|
+- 52. comp_out: number of HTTP response bytes emitted by the compressor
|
|
154
|
+- 53. comp_byp: number of bytes that bypassed the HTTP compressor (CPU/BW limit)
|
|
155
|
+- 54. comp_rsp: number of HTTP responses that were compressed
|
|
156
|
+- 55. lastsess: number of seconds since last session assigned to server/backend
|
|
157
|
+- 56. last_chk: last health check contents or textual error
|
|
158
|
+- 57. last_agt: last agent check contents or textual error
|
|
159
|
+- 58. qtime: the average queue time in ms over the 1024 last requests
|
|
160
|
+- 59. ctime: the average connect time in ms over the 1024 last requests
|
|
161
|
+- 60. rtime: the average response time in ms over the 1024 last requests (0 for TCP)
|
|
162
|
+- 61. ttime: the average total session time in ms over the 1024 last requests
|
|
163
|
++ 37. check_code [...S]: layer5-7 code, if available
|
|
164
|
++ 38. check_duration [...S]: time in ms took to finish last health check
|
|
165
|
++ 39. hrsp_1xx [.FBS]: http responses with 1xx code
|
|
166
|
++ 40. hrsp_2xx [.FBS]: http responses with 2xx code
|
|
167
|
++ 41. hrsp_3xx [.FBS]: http responses with 3xx code
|
|
168
|
++ 42. hrsp_4xx [.FBS]: http responses with 4xx code
|
|
169
|
++ 43. hrsp_5xx [.FBS]: http responses with 5xx code
|
|
170
|
++ 44. hrsp_other [.FBS]: http responses with other codes (protocol error)
|
|
171
|
++ 45. hanafail [...S]: failed health checks details
|
|
172
|
++ 46. req_rate [.F..]: HTTP requests per second over last elapsed second
|
|
173
|
++ 47. req_rate_max [.F..]: max number of HTTP requests per second observed
|
|
174
|
++ 48. req_tot [.F..]: total number of HTTP requests received
|
|
175
|
++ 49. cli_abrt [..BS]: number of data transfers aborted by the client
|
|
176
|
++ 50. srv_abrt [..BS]: number of data transfers aborted by the server
|
|
177
|
++ (inc. in eresp)
|
|
178
|
++ 51. comp_in [.FB.]: number of HTTP response bytes fed to the compressor
|
|
179
|
++ 52. comp_out [.FB.]: number of HTTP response bytes emitted by the compressor
|
|
180
|
++ 53. comp_byp [.FB.]: number of bytes that bypassed the HTTP compressor
|
|
181
|
++ (CPU/BW limit)
|
|
182
|
++ 54. comp_rsp [.FB.]: number of HTTP responses that were compressed
|
|
183
|
++ 55. lastsess [..BS]: number of seconds since last session assigned to
|
|
184
|
++ server/backend
|
|
185
|
++ 56. last_chk [...S]: last health check contents or textual error
|
|
186
|
++ 57. last_agt [...S]: last agent check contents or textual error
|
|
187
|
++ 58. qtime [..BS]: the average queue time in ms over the 1024 last requests
|
|
188
|
++ 59. ctime [..BS]: the average connect time in ms over the 1024 last requests
|
|
189
|
++ 60. rtime [..BS]: the average response time in ms over the 1024 last requests
|
|
190
|
++ (0 for TCP)
|
|
191
|
++ 61. ttime [..BS]: the average total session time in ms over the 1024 last
|
|
192
|
++ requests
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+ 9.2. Unix Socket commands
|
|
196
|
+--
|
|
197
|
+1.8.5.5
|
|
198
|
+
|