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
|
--[[
Copyright (c) 2016, Andrew Lewis <nerf@judo.za.org>
Copyright (c) 2016, Vsevolod Stakhov <vsevolod@highsecure.ru>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
]] --
local logger = require "rspamd_logger"
local mempool = require "rspamd_mempool"
local util = require "rspamd_util"
local tcp = require "rspamd_tcp"
local pool = mempool.create()
local settings = {
interval = 120,
timeout = 15,
statefile = string.format('%s/%s', rspamd_paths['DBDIR'], 'metric_exporter_last_push')
}
local VAR_NAME = 'metric_exporter_last_push'
local valid_metrics = {
'actions.add header',
'actions.greylist',
'actions.no action',
'actions.reject',
'actions.rewrite subject',
'actions.soft reject',
'bytes_allocated',
'chunks_allocated',
'chunks_freed',
'chunks_oversized',
'connections',
'control_connections',
'ham_count',
'learned',
'pools_allocated',
'pools_freed',
'scanned',
'shared_chunks_allocated',
'spam_count',
}
local function validate_metrics(settings_metrics)
if type(settings_metrics) ~= 'table' or #settings_metrics == 0 then
logger.errx(rspamd_config, 'No metrics specified for collection')
return false
end
for _, v in ipairs(settings_metrics) do
local isvalid = false
for _, vm in ipairs(valid_metrics) do
if vm == v then
isvalid = true
break
end
end
if not isvalid then
logger.errx('Invalid metric: %s', v)
return false
end
local split = rspamd_str_split(v, '.')
if #split > 2 then
logger.errx('Too many dots in metric name: %s', v)
return false
end
end
return true
end
local function load_defaults(defaults)
for k, v in pairs(defaults) do
if settings[k] == nil then
settings[k] = v
end
end
end
local function graphite_config()
load_defaults({
host = 'localhost',
port = 2003,
metric_prefix = 'rspamd'
})
return validate_metrics(settings['metrics'])
end
local function graphite_push(kwargs)
local stamp
if kwargs['time'] then
stamp = math.floor(kwargs['time'])
else
stamp = math.floor(util.get_time())
end
local metrics_str = ''
for _, v in ipairs(settings['metrics']) do
local mvalue
local mname = string.format('%s.%s', settings['metric_prefix'], v:gsub(' ', '_'))
local split = rspamd_str_split(v, '.')
if #split == 1 then
mvalue = kwargs['stats'][v]
elseif #split == 2 then
mvalue = kwargs['stats'][split[1]][split[2]]
end
metrics_str = metrics_str .. string.format('%s %s %s\n', mname, mvalue, stamp)
end
metrics_str = metrics_str .. '\n'
tcp.request({
ev_base = kwargs['ev_base'],
pool = pool,
host = settings['host'],
port = settings['port'],
timeout = settings['timeout'],
read = false,
data = {
metrics_str,
},
callback = (function (err)
if err then
logger.errx('Push failed: %1', err)
return
end
pool:set_variable(VAR_NAME, stamp)
end)
})
end
local backends = {
graphite = {
configure = graphite_config,
push = graphite_push,
},
}
local function configure_metric_exporter()
local opts = rspamd_config:get_all_opt('metric_exporter')
if not backends[opts['backend']] then
logger.errx(rspamd_config, 'Backend is invalid or unspecified')
return false
end
for k, v in pairs(opts) do
settings[k] = v
end
return backends[opts['backend']]['configure']()
end
if not configure_metric_exporter() then return end
rspamd_config:add_on_load(function (_, ev_base, worker)
-- Exit unless we're the first 'normal' worker
if not (worker:get_name() == 'normal' and worker:get_index() == 0) then return end
-- Persist mempool variable to statefile on shutdown
rspamd_config:register_finish_script(function ()
local stamp = pool:get_variable(VAR_NAME, 'double')
if not stamp then
logger.warn('No last metric exporter push to persist to disk')
return
end
local f, err = io.open(settings['statefile'], 'w')
if err then
logger.errx('Unable to write statefile to disk: %s', err)
return
end
if f then
f:write(pool:get_variable(VAR_NAME, 'double'))
f:close()
end
end)
-- Push metrics to backend
local function push_metrics(time)
logger.infox('Pushing metrics to %s backend', settings['backend'])
local args = {
ev_base = ev_base,
stats = worker:get_stat(),
}
if time then
table.insert(args, time)
end
backends[settings['backend']]['push'](args)
end
-- Push metrics at regular intervals
local function schedule_regular_push()
rspamd_config:add_periodic(ev_base, settings['interval'], function ()
push_metrics()
return true
end)
end
-- Push metrics to backend and reschedule check
local function schedule_intermediate_push(when)
rspamd_config:add_periodic(ev_base, when, function ()
push_metrics()
schedule_regular_push()
return false
end)
end
-- Try read statefile on startup
local stamp
local f, err = io.open(settings['statefile'], 'r')
if err then
logger.errx('Failed to open statefile: %s', err)
end
if f then
io.input(f)
stamp = tonumber(io.read())
pool:set_variable(VAR_NAME, stamp)
end
if not stamp then
logger.debug('No state found - pushing stats immediately')
push_metrics()
schedule_regular_push()
return
end
local time = util.get_time()
local delta = stamp - time + settings['interval']
if delta <= 0 then
logger.debug('Last push is too old - pushing stats immediately')
push_metrics(time)
schedule_regular_push()
return
end
logger.debugx('Scheduling next push in %s seconds', delta)
schedule_intermediate_push(delta)
end)
|
