-
Notifications
You must be signed in to change notification settings - Fork 85
/
redis_info.py
285 lines (230 loc) · 9.88 KB
/
redis_info.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
# redis-collectd-plugin - redis_info.py
#
# This program is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by the
# Free Software Foundation; only version 2 of the License is applicable.
#
# This program is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
# Authors:
# Garret Heaton <powdahound at gmail.com>
# Contributors:
# Pierre Mavro <[email protected]> / Deimosfr <deimos at deimos.fr>
# https://github.com/powdahound/redis-collectd-plugin/graphs/contributors
#
# About this plugin:
# This plugin uses collectd's Python plugin to record Redis information.
#
# collectd:
# http://collectd.org
# Redis:
# http://redis.googlecode.com
# collectd-python:
# http://collectd.org/documentation/manpages/collectd-python.5.shtml
import collectd
import socket
import re
# Verbose logging on/off. Override in config by specifying 'Verbose'.
VERBOSE_LOGGING = False
CONFIGS = []
def fetch_info(conf):
"""Connect to Redis server and request info"""
try:
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.connect((conf['host'], conf['port']))
log_verbose('Connected to Redis at %s:%s' % (conf['host'], conf['port']))
except socket.error as e:
collectd.error('redis_info plugin: Error connecting to %s:%d - %r'
% (conf['host'], conf['port'], e))
return None
fp = s.makefile('r', newline='\r\n')
if conf['auth'] is not None:
log_verbose('Sending auth command')
s.sendall(str.encode('auth %s\r\n' % (conf['auth'])))
status_line = fp.readline()
if not status_line.startswith('+OK'):
# -ERR invalid password
# -ERR Client sent AUTH, but no password is set
collectd.error('redis_info plugin: Error sending auth to %s:%d - %r'
% (conf['host'], conf['port'], status_line))
return None
log_verbose('Sending info command')
s.sendall(str.encode('info\r\n'))
status_line = fp.readline()
if status_line.startswith('-'):
collectd.error('redis_info plugin: Error response from %s:%d - %r'
% (conf['host'], conf['port'], status_line))
s.close()
return None
content_length = int(status_line[1:-1]) # status_line looks like: $<content_length>
data = fp.read(content_length)
log_verbose('Received data: %s' % data)
# process 'info commandstats'
log_verbose('Sending info commandstats command')
s.sendall(str.encode('info commandstats\r\n'))
fp.readline() # skip first line in the response because it is empty
status_line = fp.readline()
log_verbose('Received line: %s' % status_line)
content_length = int(status_line[1:-1]) # status_line looks like: $<content_length>
datac = fp.read(content_length) # fetch commandstats to different data buffer
log_verbose('Received data: %s' % datac)
# process 'info server'
log_verbose('Sending info server command')
s.sendall(str.encode('info server\r\n'))
fp.readline() # skip first line in the response because it is empty
status_line = fp.readline()
log_verbose('Received line: %s' % status_line)
content_length = int(status_line[1:-1]) # status_line looks like: $<content_length>
datas = fp.read(content_length) # fetch server to different data buffer
log_verbose('Received data: %s' % datas)
# process 'cluster info'
if conf['cluster']:
log_verbose('Sending cluster info command')
s.sendall(str.encode('cluster info\r\n'))
fp.readline() # skip first line in the response because it is empty
status_line = fp.readline()
log_verbose('Received line: %s' % status_line)
content_length = int(status_line[1:-1]) # status_line looks like: $<content_length>
datacluster = fp.read(content_length) # fetch cluster info to different data buffer
log_verbose('Received data: %s' % datacluster)
s.close()
linesep = '\r\n' if '\r\n' in data else '\n' # assuming all is done in the same connection...
data_dict = parse_info(data.split(linesep))
datac_dict = parse_info(datac.split(linesep))
datas_dict = parse_info(datas.split(linesep))
if conf['cluster']:
datacluster_dict = parse_info(datacluster.split(linesep))
# let us see more raw data just in case
log_verbose('Data: %s' % len(data_dict))
log_verbose('Datac: %s' % len(datac_dict))
log_verbose('Datas: %s' % len(datas_dict))
if conf['cluster']:
log_verbose('Datacluster: %s' % len(datacluster_dict))
# merge three data sets into one
data_full = data_dict.copy()
data_full.update(datac_dict)
data_full.update(datas_dict)
if conf['cluster']:
data_full.update(datacluster_dict)
log_verbose('Data Full: %s' % len(data_full))
# this generates hundreds of lines but helps in debugging a lot
if VERBOSE_LOGGING:
for key in data_full:
log_verbose('Data Full detail: %s = %s' % (key, data_full[key]))
return data_full
def parse_info(info_lines):
"""Parse info response from Redis"""
info = {}
for line in info_lines:
if "" == line or line.startswith('#'):
continue
if ':' not in line:
collectd.warning('redis_info plugin: Bad format for info line: %s'
% line)
continue
key, val = line.split(':')
# Handle multi-value keys (for dbs and slaves).
# db lines look like "db0:keys=10,expire=0"
# slave lines look like "slave0:ip=192.168.0.181,port=6379,state=online,offset=1650991674247,lag=1"
if ',' in val:
split_val = val.split(',')
for sub_val in split_val:
k, _, v = sub_val.rpartition('=')
sub_key = "{0}_{1}".format(key, k)
info[sub_key] = v
else:
info[key] = val
# compatibility with pre-2.6 redis (used changes_since_last_save)
info["changes_since_last_save"] = info.get("changes_since_last_save", info.get("rdb_changes_since_last_save"))
return info
def configure_callback(conf):
"""Receive configuration block"""
host = None
port = None
auth = None
cluster = True
instance = None
redis_info = {}
for node in conf.children:
key = node.key.lower()
val = node.values[0]
log_verbose('Analyzing config %s key (value: %s)' % (key, val))
searchObj = re.search(r'redis_(.*)$', key, re.M|re.I)
if key == 'host':
host = val
elif key == 'port':
port = int(val)
elif key == 'auth':
auth = val
elif key == 'cluster':
cluster = bool(node.values[0])
elif key == 'verbose':
global VERBOSE_LOGGING
VERBOSE_LOGGING = bool(node.values[0]) or VERBOSE_LOGGING
elif key == 'instance':
instance = val
elif searchObj:
log_verbose('Matching expression found: key: %s - value: %s' % (searchObj.group(1), val))
redis_info[searchObj.group(1), val] = True
else:
collectd.warning('redis_info plugin: Unknown config key: %s.' % key)
continue
log_verbose('Configured with host=%s, port=%s, instance name=%s, using_auth=%s, cluster=%s, redis_info_len=%s' % (host, port, instance, auth!=None, cluster, len(redis_info)))
CONFIGS.append({'host': host, 'port': port, 'auth': auth, 'instance': instance, 'cluster': cluster, 'redis_info': redis_info})
def dispatch_value(info, key, type, plugin_instance=None, type_instance=None):
"""Read a key from info response data and dispatch a value"""
if key not in info:
collectd.warning('redis_info plugin: Info key not found: %s, Instance: %s' % (key, plugin_instance))
return
if plugin_instance is None:
plugin_instance = 'unknown redis'
collectd.error('redis_info plugin: plugin_instance is not set, Info key: %s' % key)
if not type_instance:
type_instance = key
try:
value = int(info[key])
except ValueError:
value = float(info[key])
except TypeError:
log_verbose('No info for key: %s' % key)
return
log_verbose('Sending value: %s=%s' % (type_instance, value))
val = collectd.Values(plugin='redis_info')
val.type = type
val.type_instance = type_instance
val.plugin_instance = plugin_instance
val.values = [value]
val.dispatch()
def read_callback():
for conf in CONFIGS:
get_metrics(conf)
def get_metrics(conf):
info = fetch_info(conf)
if not info:
collectd.error('redis plugin: No info received')
return
plugin_instance = conf['instance']
if plugin_instance is None:
plugin_instance = '{host}:{port}'.format(host=conf['host'], port=conf['port'])
for keyTuple, val in conf['redis_info'].items():
key, val = keyTuple
if key == 'total_connections_received' and val == 'counter':
dispatch_value(info, 'total_connections_received', 'counter', plugin_instance, 'connections_received')
elif key == 'total_commands_processed' and val == 'counter':
dispatch_value(info, 'total_commands_processed', 'counter', plugin_instance, 'commands_processed')
else:
dispatch_value(info, key, val, plugin_instance)
def log_verbose(msg):
if not VERBOSE_LOGGING:
return
collectd.info('redis plugin [verbose]: %s' % msg)
# register callbacks
collectd.register_config(configure_callback)
collectd.register_read(read_callback)