-
Notifications
You must be signed in to change notification settings - Fork 1
/
varnish.py
301 lines (249 loc) · 8.49 KB
/
varnish.py
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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
#!/usr/bin/env python
# -*- coding: utf-8 -*-
u"""get various information about varnish"""
__VERSION__ = '0.1.0'
import re
import subprocess
import json
import requests
from blackbird.plugins import base
class ConcreteJob(base.JobBase):
u"""This Class is called by "Executer".
ConcreteJob is registerd as a job of Executer.
"""
def __init__(self, options, queue=None, logger=None):
super(ConcreteJob, self).__init__(options,
queue,
logger
)
self.hostname = options.get('hostname')
def build_items(self):
u"""This method called by Executer.
"""
# ping item
self._ping()
# detect varnish version
self._get_version()
# varnishstat
for stat in self.get_varnishstat():
self.enqueue(VarnishItem(
key='varnish.varnishstat[{0}]'.format(
stat.get('key').replace('.', ',')
),
value=stat.get("value"),
host=self.hostname,
))
# ban.list
self.enqueue(VarnishItem(
key="varnish.varnishadm[ban.list]",
value=self.count_banlist(),
host=self.hostname,
))
host = self.options.get('response_check_host')
port = self.options.get('response_check_port')
uri = self.options.get('response_check_uri')
vhost = (
self.options.get('response_check_vhost')
or
self.options.get('response_check_host')
)
host = self.options.get('response_check_host')
user_agent = self.options.get('response_check_uagent')
scheme = 'https' if self.options.get('response_check_ssl') else 'http'
ext_headers = {}
try:
(response, time) = self._get_response(
scheme=scheme, host=host, port=port, uri=uri,
vhost=vhost, user_agent=user_agent, ext_headers=ext_headers,
)
except requests.exceptions.RequestException as exception:
self.logger.debug(exception)
else:
self.enqueue(VarnishItem(
key='varnish.stat[response_check,time]',
value=time,
host=self.options['hostname'],
))
self.enqueue(VarnishItem(
key='varnish.stat[response_check,status_code]',
value=response.status_code,
host=self.options['hostname'],
))
def build_discovery_items(self):
# lld storage
lld_values = []
for storage in self.get_storages():
lld_values.append({
"{#STORAGE_NAME}": storage,
"{#STORAGE_TYPE}": "file",
})
self.enqueue(VarnishDicoveryItem(
key="varnish.storage.LLD",
value={'data': lld_values},
host=self.hostname,
))
def _ping(self):
"""
send ping item
"""
self.enqueue(
VarnishItem(
key='blackbird.varnish.ping',
value=1,
host=self.options['hostname']
)
)
self.enqueue(
VarnishItem(
key='blackbird.varnish.version',
value=__VERSION__,
host=self.options['hostname']
)
)
def _get_version(self):
"""
detect varnish version
$ varnishd -V
varnishd (varnish-N.N.N revision ....)
Copyright (c) ....
"""
varnish_version = 'Unknown'
try:
output = subprocess.Popen([self.options['path'], '-V'],
stderr=subprocess.PIPE).communicate()[1]
match = re.match(r"varnishd \(varnish-(\S+) ", output)
if match:
varnish_version = match.group(1)
except OSError:
self.logger.debug(
'can not exec "{0} -V", failed to get varnish version'
''.format(self.options['path'])
)
self.enqueue(
VarnishItem(
key='varnish.version',
value=varnish_version,
host=self.options['hostname']
)
)
@staticmethod
def get_varnishstat():
u"""get stat from varnishstat"""
cwd = "/tmp"
cmdline = "varnishstat -1"
out, _ = subprocess.Popen(
cmdline, shell=True, cwd=cwd, stdin=subprocess.PIPE,
stdout=subprocess.PIPE, stderr=subprocess.STDOUT, close_fds=True,
).communicate()
result = []
lines = out.splitlines()
for line in lines:
parts = re.split(' +', line, 3)
result.append({"key": parts[0], "value": parts[1]})
return result
@staticmethod
def count_banlist():
u"""count ban.list from varnishadm"""
cwd = "/tmp"
vadm = subprocess.Popen(
"varnishadm ban.list", shell=True, cwd=cwd, stdout=subprocess.PIPE,
)
wcl = subprocess.Popen(
"wc -l", shell=True, stdin=vadm.stdout, stdout=subprocess.PIPE,
)
out, _ = wcl.communicate()
result = out.splitlines()[0]
return result
@staticmethod
def get_storages():
u"""get storage information"""
cwd = "/tmp"
cmdline = "varnishadm storage.list |grep file"
out, _ = subprocess.Popen(
cmdline, shell=True, cwd=cwd, stdin=subprocess.PIPE,
stdout=subprocess.PIPE, stderr=subprocess.STDOUT, close_fds=True,
).communicate()
result = []
lines = out.splitlines()
for line in lines:
match = re.search(r"storage\.(.*) = file", line)
if match:
result.append(match.group(1))
return result
@staticmethod
def _get_response(scheme="http", host="localhost", port=80,
uri="/", vhost=None, user_agent=None, ext_headers=None):
u"""get response and measure latency"""
if not ext_headers:
ext_headers = {}
url = (
'{scheme}://{host}:{port}{uri}'
''.format(
scheme=scheme,
host=host,
port=port,
uri=uri
)
)
headers = {}
if vhost is not None:
headers['Host'] = vhost
if user_agent is not None:
headers['User-Agent'] = user_agent
headers.update(ext_headers)
with base.Timer() as timer:
response = requests.get(url, headers=headers)
time = timer.sec
return (response, time)
class VarnishItem(base.ItemBase):
u"""."""
def __init__(self, key, value, host):
super(VarnishItem, self).__init__(key, value, host)
self._data = {}
self._generate()
@property
def data(self):
u"""Dequeued data. ListType object.
[{key1:value1}, {key2:value2}...]
"""
return self._data
class VarnishDicoveryItem(base.ItemBase):
u"""."""
def __init__(self, key, value, host):
super(VarnishDicoveryItem, self).__init__(key, value, host)
self._data = {}
self._generate()
@property
def data(self):
u"""Dequeued data. ListType object.
[{key1:value1}, {key2:value2}...]
"""
return self._data
def _generate(self):
self._data['host'] = self.host
self._data['clock'] = self.clock
self._data['key'] = self.key
self._data['value'] = json.dumps(self.value)
class Validator(base.ValidatorBase):
def __init__(self):
self.__spec = None
self.__module = None
@property
def spec(self):
self.__spec = (
"[{0}]".format(__name__),
"response_check_host = string(default='127.0.0.1')",
"response_check_port = integer(0, 65535, default=80)",
"response_check_timeout = integer(0, 600, default=3)",
"response_check_vhost = string(default='localhost')",
"response_check_uagent = string(default='blackbird response check')",
"response_check_ssl = boolean(default=False)",
"path = string(default='/usr/sbin/varnishd')",
"hostname = string(default={0})".format(self.detect_hostname()),
)
return self.__spec
if __name__ == '__main__':
OPTIONS = {
}
BBL_VARNISH = ConcreteJob(options=OPTIONS)
BBL_VARNISH.build_items()