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
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
|
<?php
namespace Icinga\Module\Graphite\Graphing;
use Icinga\Application\Config;
use Icinga\Data\ConfigObject;
use Icinga\Exception\ConfigurationError;
use Icinga\Module\Graphite\Util\MacroTemplate;
use Icinga\Web\UrlParams;
use InvalidArgumentException;
use RecursiveDirectoryIterator;
use RecursiveIteratorIterator;
use SplFileInfo;
/**
* Templates collection
*/
class Templates
{
/**
* All templates by their check command and name
*
* @var Template[][]
*/
protected $templates = [];
/**
* All default templates by their name
*
* @var Template[]
*/
protected $defaultTemplates = [];
/**
* Default URL params for all templates
*
* @var string[]
*/
protected $defaultUrlParams = [];
/**
* Constructor
*/
public function __construct()
{
$config = Config::module('graphite');
foreach ($config->getSection('default_url_params') as $param => $value) {
try {
$this->defaultUrlParams[$param] = new MacroTemplate($value);
} catch (InvalidArgumentException $e) {
throw new ConfigurationError(
'Invalid URL parameter "%s" ("%s") in file "%s"',
$param,
$value,
$config->getConfigFile(),
$e
);
}
}
}
/**
* Load templates as configured inside the given directory
*
* @param string $path
*
* @return $this
*
* @throws ConfigurationError If the configuration is invalid
*/
public function loadDir($path)
{
foreach (
new RecursiveIteratorIterator(
new RecursiveDirectoryIterator(
$path,
RecursiveDirectoryIterator::KEY_AS_PATHNAME | RecursiveDirectoryIterator::CURRENT_AS_FILEINFO
| RecursiveDirectoryIterator::SKIP_DOTS | RecursiveDirectoryIterator::FOLLOW_SYMLINKS
),
RecursiveIteratorIterator::LEAVES_ONLY
) as $filepath => $fileinfo
) {
/** @var SplFileInfo $fileinfo */
if ($fileinfo->isFile() && preg_match('/\A[^.].*\.ini\z/si', $fileinfo->getFilename())) {
$this->loadIni($filepath);
}
}
return $this;
}
/**
* Load templates as configured in the given INI file
*
* @param string $path
*
* @return $this
*
* @throws ConfigurationError If the configuration is invalid
*/
public function loadIni($path)
{
/** @var string[][][] $templates */
$templates = [];
foreach (Config::fromIni($path) as $section => $options) {
/** @var ConfigObject $options */
$matches = [];
if (! preg_match('/\A(.+)\.(graph|metrics_filters|urlparams|functions)\z/', $section, $matches)) {
throw new ConfigurationError('Bad section name "%s" in file "%s"', $section, $path);
}
$templates[$matches[1]][$matches[2]] = $options->toArray();
}
$checkCommands = [];
foreach ($templates as $templateName => $template) {
$checkCommands[$templateName] = isset($template['graph']['check_command'])
? array_unique(preg_split('/\s*,\s*/', $template['graph']['check_command'], -1, PREG_SPLIT_NO_EMPTY))
: [];
unset($template['graph']['check_command']);
if (isset($template['graph'])) {
switch (count($template['graph'])) {
case 0:
break;
case 1:
throw new ConfigurationError(
'Bad option for template "%s" in file "%s": "graph.%s"',
$templateName,
$path,
array_keys($template['graph'])[0]
);
default:
$standalone = array_keys($template['graph']);
sort($standalone);
throw new ConfigurationError(
'Bad options for template "%s" in file "%s": %s',
$templateName,
$path,
implode(', ', array_map(
function ($option) {
return "\"graph.$option\"";
},
$standalone
))
);
}
}
/** @var MacroTemplate[][] $curves */
$curves = [];
if (isset($template['metrics_filters'])) {
foreach ($template['metrics_filters'] as $curve => $metricsFilter) {
try {
$curves[$curve][0] = new MacroTemplate($metricsFilter);
} catch (InvalidArgumentException $e) {
throw new ConfigurationError(
'Bad metrics filter "%s" for curve "%s" of template "%s" in file "%s": %s',
$metricsFilter,
$curve,
$templateName,
$path,
$e->getMessage()
);
}
if (
count(array_intersect(
$curves[$curve][0]->getMacros(),
['host_name_template', 'service_name_template']
)) !== 1
) {
throw new ConfigurationError(
'Bad metrics filter "%s" for curve "%s" of template "%s" in file "%s": must include'
. ' either the macro $host_name_template$ or $service_name_template$, but not both',
$metricsFilter,
$curve,
$templateName,
$path
);
}
if (isset($template['functions'][$curve])) {
try {
$curves[$curve][1] = new MacroTemplate($template['functions'][$curve]);
} catch (InvalidArgumentException $e) {
throw new ConfigurationError(
'Bad function "%s" for curve "%s" of template "%s" in file "%s": %s',
$template['functions'][$curve],
$curve,
$templateName,
$path,
$e->getMessage()
);
}
unset($template['functions'][$curve]);
} else {
$curves[$curve][1] = new MacroTemplate('$metric$');
}
}
}
if (isset($template['functions'])) {
switch (count($template['functions'])) {
case 0:
break;
case 1:
throw new ConfigurationError(
'Metrics filter for curve "%s" of template "%s" in file "%s" missing',
array_keys($template['functions'])[0],
$templateName,
$path
);
default:
$standalone = array_keys($template['functions']);
sort($standalone);
throw new ConfigurationError(
'Metrics filter for curves of template "%s" in file "%s" missing: "%s"',
$templateName,
$path,
implode('", "', $standalone)
);
}
}
$urlParams = $this->defaultUrlParams;
if (isset($template['urlparams'])) {
foreach ($template['urlparams'] as $key => $value) {
try {
$urlParams[$key] = new MacroTemplate($value);
} catch (InvalidArgumentException $e) {
throw new ConfigurationError(
'Invalid URL parameter "%s" ("%s") for template "%s" in file "%s": %s',
$key,
$value,
$templateName,
$path,
$e->getMessage()
);
}
}
}
$templates[$templateName] = empty($curves) ? null : (new Template())
->setCurves($curves)
->setUrlParams($urlParams);
}
foreach ($templates as $templateName => $template) {
if ($template === null) {
if (empty($checkCommands[$templateName])) {
unset($this->defaultTemplates[$templateName]);
} else {
foreach ($checkCommands[$templateName] as $checkCommand) {
unset($this->templates[$checkCommand][$templateName]);
if (empty($this->templates[$checkCommand])) {
unset($this->templates[$checkCommand]);
}
}
}
} else {
if (empty($checkCommands[$templateName])) {
$this->defaultTemplates[$templateName] = $template;
} else {
foreach ($checkCommands[$templateName] as $checkCommand) {
$this->templates[$checkCommand][$templateName] = $template;
}
}
}
}
return $this;
}
/**
* Get all loaded templates for the given check command by their names
*
* @param string $checkCommand
*
* @return Template[]
*/
public function getTemplates($checkCommand)
{
return isset($this->templates[$checkCommand]) ? $this->templates[$checkCommand] : [];
}
/**
* Get all loaded templates for all check commands
*
* @return Template[][]
*/
public function getAllTemplates()
{
return $this->templates;
}
/**
* Get all loaded default templates by their names
*
* @return Template[]
*/
public function getDefaultTemplates()
{
return $this->defaultTemplates;
}
}
|
