chore(python.d): clarify haproxy module readme (#13388)
Ilya Mashchenko committed
Jul 15, 2022 at 13:24 UTC
15b32a6eef4374c8e5414708f99817a1953db8da
1 file changed
+21
-21
collectors/python.d.plugin/haproxy/README.md
+21
-21
@@ -9,30 +9,32 @@ sidebar_label: "HAProxy"
9
Monitors frontend and backend metrics such as bytes in, bytes out, sessions current, sessions in queue current.
10
And health metrics such as backend servers status (server check should be used).
11
12
-Plugin can obtain data from url **OR** unix socket.
12
+Plugin can obtain data from URL or Unix socket.
13
14
-**Requirement:**
15
-Socket MUST be readable AND writable by the `netdata` user.
14
+Requirement:
15
+
16
+- Socket must be readable and writable by the `netdata` user.
17
+- URL must have `stats uri <path>` present in the haproxy config, otherwise you will get HTTP 503 in the haproxy logs.
18
19
It produces:
20
19
-1. **Frontend** family charts
21
+1. **Frontend** family charts
22
21
- - Kilobytes in/s
22
- - Kilobytes out/s
23
- - Sessions current
24
- - Sessions in queue current
23
+ - Kilobytes in/s
24
+ - Kilobytes out/s
25
+ - Sessions current
26
+ - Sessions in queue current
27
26
-2. **Backend** family charts
28
+2. **Backend** family charts
29
28
- - Kilobytes in/s
29
- - Kilobytes out/s
30
- - Sessions current
31
- - Sessions in queue current
30
+ - Kilobytes in/s
31
+ - Kilobytes out/s
32
+ - Sessions current
33
+ - Sessions in queue current
34
33
-3. **Health** chart
35
+3. **Health** chart
36
35
- - number of failed servers for every backend (in DOWN state)
37
+ - number of failed servers for every backend (in DOWN state)
38
39
## Configuration
40
@@ -48,20 +50,18 @@ Sample:
50
51
```yaml
52
via_url:
51
- user : 'username' # ONLY IF stats auth is used
52
- pass : 'password' # # ONLY IF stats auth is used
53
- url : 'http://ip.address:port/url;csv;norefresh'
53
+ user: 'username' # ONLY IF stats auth is used
54
+ pass: 'password' # # ONLY IF stats auth is used
55
+ url: 'http://ip.address:port/url;csv;norefresh'
56
```
57
58
OR
59
60
```yaml
61
via_socket:
60
- socket : 'path/to/haproxy/sock'
62
+ socket: 'path/to/haproxy/sock'
63
```
64
65
If no configuration is given, module will fail to run.
66
67
---
66
-
67
-