1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
conn-check
==========
conn-check allows for checking connectivity with external services.
You can write a config file that defines services that you need to
have access to, and conn-check will check connectivity with each.
It supports various types of services, all of which allow for
basic network checks, but some allow for confirming credentials
work also.
Configuration
-------------
The configuration is done via a yaml file. The file defines a list
of checks to do::
- type: tcp
host: localhost
port: 80
- type: ssl
host: localhost
port: 443
verify: true
Each check defines a type, and then options as appropriate for that type.
Check Types
-----------
tcp
```
A simple tcp connectivity check.
host
The host.
port
The port.
ssl
```
A check that uses SSL.
host
The host.
port
The port.
verify
Whether to also verify the SSL certificate. Optional. Default: true.
udp
```
Check that sending a specific UDP packet gets a specific response.
host
The host.
port
The port.
send
The string to send.
expect
The string to expect in the response.
http
````
Check that a HTTP/HTTPS request succeeds.
url
The URL to fetch.
method
The method to use. Optional. Default: "GET".
expected_code
The status code that defines success. Optional. Default: 200.
proxy_host
Optional HTTP proxy to connect via.
proxy_port
Port to use with ``proxy_host``. Default: 8000.
headers:
Optional headers to send, as a dict of key-values. Multiple values can be
given as a list under the same key.
body:
Optional raw request body string to send.
amqp
````
Check that an AMQP server can be authenticated against.
host
The host.
port
The port.
username
The username to authenticate with.
password
The password to authenticate with.
use_ssl
Whether to connect with ssl. Optional. Default: true.
vhost
The vhost to connect to. Optional. Default '/'.
postgres
````````
Check that a postgres db can be authenticated against.
host
The host.
port
The port.
username
The username to authenticate with.
password
The password to authenticate with.
database
The database to connect to.
redis
`````
Check that a redis server is present, optionally checking authentication.
host
The host.
port
The port.
password
The password to authenticatie with. Optional.
memcached
`````````
Check that a memcached server is present (`memcache` also works).
host
The host.
port
The port.
Building wheels
---------------
To allow for easier/more portable distribution of this tool you can build
conn-check and all it's dependencies as `Python wheels <http://legacy.python.org/dev/peps/pep-0427/>`_::
make clean-wheels
make build-wheels
EXTRA=amqp make build-wheels-extra
EXTRA=redis make build-wheels-extra
The `build-wheels` make target will build conn-check and it's base
dependencies, but to include the optional extra dependencies for other
checks such as amqp, redis or postgres you need to use the
`build-wheels-extra` target with the `EXTRA` env value.
By default all the wheels will be placed in `./wheels`.
|