3 var url = require('url');
\r
4 var http = require('http');
\r
5 var util = require('util');
\r
8 var netdata = require('netdata');
\r
10 var example_chart = {
\r
11 id: 'id', // the unique id of the chart
\r
12 name: 'name', // the name of the chart
\r
13 title: 'title', // the title of the chart
\r
14 units: 'units', // the units of the chart dimensions
\r
15 family: 'family', // the family of the chart
\r
16 category: 'category', // the category of the chart
\r
17 type: netdata.chartTypes.line, // the type of the chart
\r
18 priority: 0, // the priority relative to others in the same family and category
\r
19 update_every: 1, // the expected update frequency of the chart
\r
22 id: 'dim1', // the unique id of the dimension
\r
23 name: 'name', // the name of the dimension
\r
24 algorithm: netdata.chartAlgorithms.absolute, // the id of the netdata algorithm
\r
25 multiplier: 1, // the multiplier
\r
26 divisor: 1, // the divisor
\r
27 hidden: false, // is hidden (boolean)
\r
30 id: 'dim2', // the unique id of the dimension
\r
31 name: 'name', // the name of the dimension
\r
32 algorithm: 'absolute', // the id of the netdata algorithm
\r
33 multiplier: 1, // the multiplier
\r
34 divisor: 1, // the divisor
\r
35 hidden: false, // is hidden (boolean)
\r
37 // add as many dimensions as needed
\r
44 filename: __filename,
\r
50 incremental: 'incremental',
\r
51 absolute: 'absolute',
\r
52 percentage_of_absolute_row: 'percentage-of-absolute-row',
\r
53 percentage_of_incremental_row: 'percentage-of-incremental-row'
\r
62 services: new Array(),
\r
63 modules_configuring: 0,
\r
66 stringify: function(obj) {
\r
67 return util.inspect(obj, {depth: 10});
\r
70 // show debug info, if debug is enabled
\r
71 debug: function(msg) {
\r
72 if(this.options.DEBUG === true) {
\r
73 var now = new Date();
\r
74 console.error(now.toString() + ': ' + netdata.options.filename + ': DEBUG: ' + ((typeof(msg) === 'object')?netdata.stringify(msg):msg).toString());
\r
79 error: function(msg) {
\r
80 var now = new Date();
\r
81 console.error(now.toString() + ': ' + netdata.options.filename + ': ERROR: ' + ((typeof(msg) === 'object')?netdata.stringify(msg):msg).toString());
\r
84 // send data to netdata
\r
85 send: function(msg) {
\r
86 console.log(msg.toString());
\r
89 serviceAdd: function(service) {
\r
90 if(netdata.serviceIsInitialized(service) === false)
\r
91 netdata.serviceInit(service);
\r
93 if(service.added !== true) {
\r
94 service.updates = 0;
\r
95 service.enabled = true;
\r
96 service.added = true;
\r
97 service.running = false;
\r
98 service.started = 0;
\r
100 service._current_chart = null; // the current chart we work on
\r
101 service._queue = '';
\r
102 service.queue = function(txt) {
\r
103 this._queue += txt + '\n';
\r
106 service._send_chart_to_netdata = function(chart) {
\r
107 // internal function to send a chart to netdata
\r
108 this.queue('CHART "' + chart.id + '" "' + chart.name + '" "' + chart.title + '" "' + chart.units + '" "' + chart.family + '" "' + chart.category + '" "' + chart.type + '" ' + chart.priority.toString() + ' ' + chart.update_every.toString());
\r
110 for(var dim in chart.dimensions) {
\r
111 var d = chart.dimensions[dim];
\r
113 this.queue('DIMENSION "' + d.id + '" "' + d.name + '" "' + d.algorithm + '" ' + d.multiplier.toString() + ' ' + d.divisor.toString() + ' ' + ((d.hidden === true)?'hidden':'').toString());
\r
115 d._updated = false;
\r
118 chart._created = true;
\r
119 chart._updated = false;
\r
122 // begin data collection for a chart
\r
123 service.begin = function(chart) {
\r
124 if(this._current_chart !== null && this._current_chart !== chart) {
\r
125 netdata.serviceError(this, 'Called begin() for chart ' + chart.id + ' while chart ' + this._current_chart.id + ' is still open. Closing it.');
\r
129 if(typeof(chart.id) === 'undefined' || netdata.charts[chart.id] != chart) {
\r
130 netdata.serviceError(this, 'Called begin() for chart ' + chart.id + ' that is not mine. Where did you find it? Ignoring it.');
\r
134 if(netdata.options.DEBUG === true) netdata.debug('setting current chart to ' + chart.id);
\r
135 this._current_chart = chart;
\r
136 this._current_chart._began = true;
\r
138 if(this._current_chart._dimensions_count !== 0) {
\r
139 if(this._current_chart._created === false || this._current_chart._updated === true)
\r
140 this._send_chart_to_netdata(this._current_chart);
\r
142 var now = this.ended;
\r
143 this.queue('BEGIN ' + this._current_chart.id + ' ' + ((this._current_chart._last_updated > 0)?((now - this._current_chart._last_updated) * 1000):'').toString());
\r
145 // else netdata.serviceError(this, 'Called begin() for chart ' + chart.id + ' which is empty.');
\r
147 this._current_chart._last_updated = now;
\r
148 this._current_chart._began = true;
\r
149 this._current_chart._counter++;
\r
154 // set a collected value for a chart
\r
155 // we do most things on the first value we attempt to set
\r
156 service.set = function(dimension, value) {
\r
157 if(this._current_chart === null) {
\r
158 netdata.serviceError(this, 'Called set(' + dimension + ', ' + value + ') without an open chart.');
\r
162 if(typeof(this._current_chart.dimensions[dimension]) === 'undefined') {
\r
163 netdata.serviceError(this, 'Called set(' + dimension + ', ' + value + ') but dimension "' + dimension + '" does not exist in chart "' + this._current_chart.id + '".');
\r
167 if(this._current_chart._dimensions_count !== 0)
\r
168 this.queue('SET ' + dimension + ' = ' + value);
\r
173 // end data collection for the current chart - after calling begin()
\r
174 service.end = function() {
\r
175 if(this._current_chart !== null && this._current_chart._began === false) {
\r
176 netdata.serviceError(this, 'Called end() without an open chart.');
\r
180 if(this._current_chart._dimensions_count !== 0) {
\r
182 netdata.send(this._queue);
\r
186 this._current_chart._began = false;
\r
187 if(netdata.options.DEBUG === true) netdata.debug('committed chart ' + this._current_chart.id);
\r
188 this._current_chart = null;
\r
192 // discard the collected values for the current chart - after calling begin()
\r
193 service.flush = function() {
\r
194 if(this._current_chart === null || this._current_chart._began === false) {
\r
195 netdata.serviceError(this, 'Called flush() without an open chart.');
\r
200 this._current_chart._began = false;
\r
201 this._current_chart = null;
\r
205 // create a netdata chart
\r
206 service.chart = function(id, chart) {
\r
207 if(typeof(netdata.charts[id]) === 'undefined') {
\r
208 netdata.charts[id] = {
\r
214 _dimensions_count: 0,
\r
217 title: 'untitled chart',
\r
221 type: netdata.chartTypes.line,
\r
223 update_every: netdata.options.update_every,
\r
228 var c = netdata.charts[id];
\r
230 if(typeof(chart.name) !== 'undefined' && chart.name !== c.name) {
\r
231 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ' updated its name');
\r
232 c.name = chart.name;
\r
236 if(typeof(chart.title) !== 'undefined' && chart.title !== c.title) {
\r
237 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ' updated its title');
\r
238 c.title = chart.title;
\r
242 if(typeof(chart.units) !== 'undefined' && chart.units !== c.units) {
\r
243 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ' updated its units');
\r
244 c.units = chart.units;
\r
248 if(typeof(chart.family) !== 'undefined' && chart.family !== c.family) {
\r
249 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ' updated its family');
\r
250 c.family = chart.family;
\r
254 if(typeof(chart.category) !== 'undefined' && chart.category !== c.category) {
\r
255 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ' updated its category');
\r
256 c.category = chart.category;
\r
260 if(typeof(chart.type) !== 'undefined' && chart.type !== c.type) {
\r
261 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ' updated its type');
\r
262 c.type = chart.type;
\r
266 if(typeof(chart.priority) !== 'undefined' && chart.priority !== c.priority) {
\r
267 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ' updated its priority');
\r
268 c.priority = chart.priority;
\r
272 if(typeof(chart.update_every) !== 'undefined' && chart.update_every !== c.update_every) {
\r
273 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ' updated its update_every');
\r
274 c.update_every = chart.update_every;
\r
278 if(typeof(chart.dimensions) !== 'undefined') {
\r
279 for(var x in chart.dimensions) {
\r
280 if(typeof(c.dimensions[x]) === 'undefined') {
\r
281 c._dimensions_count++;
\r
283 c.dimensions[x] = {
\r
286 id: x, // the unique id of the dimension
\r
287 name: x, // the name of the dimension
\r
288 algorithm: netdata.chartAlgorithms.absolute, // the id of the netdata algorithm
\r
289 multiplier: 1, // the multiplier
\r
290 divisor: 1, // the divisor
\r
291 hidden: false, // is hidden (boolean)
\r
294 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ' created dimension ' + x);
\r
298 var dim = chart.dimensions[x];
\r
299 var d = c.dimensions[x];
\r
301 if(typeof(dim.name) !== 'undefined' && d.name !== dim.name) {
\r
302 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ', dimension ' + x + ' updated its name');
\r
307 if(typeof(dim.algorithm) !== 'undefined' && d.algorithm !== dim.algorithm) {
\r
308 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ', dimension ' + x + ' updated its algorithm from ' + d.algorithm + ' to ' + dim.algorithm);
\r
309 d.algorithm = dim.algorithm;
\r
313 if(typeof(dim.multiplier) !== 'undefined' && d.multiplier !== dim.multiplier) {
\r
314 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ', dimension ' + x + ' updated its multiplier');
\r
315 d.multiplier = dim.multiplier;
\r
319 if(typeof(dim.divisor) !== 'undefined' && d.divisor !== dim.divisor) {
\r
320 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ', dimension ' + x + ' updated its divisor');
\r
321 d.divisor = dim.divisor;
\r
325 if(typeof(dim.hidden) !== 'undefined' && d.hidden !== dim.hidden) {
\r
326 if(netdata.options.DEBUG === true) netdata.debug('chart ' + id + ', dimension ' + x + ' updated its hidden status');
\r
327 d.hidden = dim.hidden;
\r
331 if(d._updated) c._updated = true;
\r
335 if(netdata.options.DEBUG === true) netdata.debug(netdata.charts);
\r
336 return netdata.charts[id];
\r
339 this.services.push(service);
\r
340 if(netdata.options.DEBUG === true) netdata.debug(service.module.name + ': ' + service.name + ': service added.');
\r
344 serviceRun: function(service) {
\r
345 if(netdata.options.DEBUG === true) netdata.debug(service.module.name + ': ' + service.name + ': starting data collection...');
\r
346 service.running = true;
\r
347 service.started = new Date().getTime();
\r
350 service.module.update(service, function() {
\r
351 service.ended = new Date().getTime();
\r
352 service.duration = service.ended - service.started;
\r
353 if(netdata.options.DEBUG === true) netdata.debug(service.module.name + ': ' + service.name + ': data collection ended in ' + service.duration.toString() + ' ms.');
\r
354 service.running = false;
\r
358 runAllServices: function() {
\r
359 if(netdata.options.DEBUG === true) netdata.debug('runAllServices()');
\r
361 var now = new Date().getTime();
\r
362 var len = netdata.services.length;
\r
364 var service = netdata.services[len];
\r
366 if(service.enabled === false || service.running === true) continue;
\r
367 if(now - service.ended < service.update_every) continue;
\r
369 netdata.serviceRun(service);
\r
372 setTimeout(netdata.runAllServices, 100);
\r
375 start: function() {
\r
376 if(netdata.options.DEBUG === true) this.debug('started, services:');
\r
378 if(this.services.length === 0) {
\r
379 this.disableNodePlugin();
\r
382 else this.runAllServices();
\r
385 // disable the whole node.js plugin
\r
386 disableNodePlugin: function() {
\r
387 this.send('DISABLE');
\r
391 requestFromParams: function(protocol, hostname, port, path, method) {
\r
393 protocol: protocol,
\r
394 hostname: hostname,
\r
400 'Content-Type': 'application/x-www-form-urlencoded',
\r
401 'Connection': 'keep-alive'
\r
403 agent: new http.Agent({
\r
405 keepAliveMsecs: netdata.options.update_every,
\r
406 maxSockets: 2, // it must be 2 to work
\r
412 requestFromURL: function(a_url) {
\r
413 var u = url.parse(a_url);
\r
414 return netdata.requestFromParams(u.protocol, u.hostname, u.port, u.path, 'GET');
\r
417 processResponse: function(service, data, callback) {
\r
418 if(netdata.options.DEBUG === true) netdata.debug(service.module.name + ': ' + service.name + ': processing response...');
\r
420 callback(service, data);
\r
422 service.module.running--;
\r
423 if(service.module.running <= 0) {
\r
424 service.module.running = 0;
\r
426 // check if we run under configure
\r
427 if(service.module.configure_callback !== null) {
\r
428 if(netdata.options.DEBUG === true) this.debug(service.module.name + ': configuration finish callback called from processResponse().');
\r
429 var ccallback = service.module.configure_callback;
\r
430 service.module.configure_callback = null;
\r
436 serviceError: function(service, message) {
\r
437 if(service.error_reported === false) {
\r
438 netdata.error(service.module.name + ': ' + service.name + ': ' + message);
\r
439 service.error_reported = true;
\r
441 else if(netdata.options.DEBUG === true)
\r
442 netdata.debug(service.module.name + ': ' + service.name + ': ' + message);
\r
445 serviceErrorClear: function(service) {
\r
446 service.error_reported = false;
\r
449 serviceInit: function(service) {
\r
450 service.error_reported = false;
\r
451 service.added = false;
\r
452 service.enabled = true;
\r
455 serviceIsInitialized: function(service) {
\r
456 if(typeof service.error_reported === 'undefined')
\r
462 getResponse: function(service, response, callback) {
\r
463 if(netdata.options.DEBUG === true) netdata.debug(service.module.name + ': ' + service.name + ': got response...');
\r
467 response.setEncoding('utf8');
\r
469 if(response.statusCode !== 200) {
\r
470 if(end === false) {
\r
471 netdata.serviceError(service, ': got HTTP code ' + response.statusCode + ', failed to get data.');
\r
473 netdata.processResponse(service, null, callback);
\r
477 response.on('data', function(chunk) {
\r
478 if(end === false) data += chunk;
\r
481 response.on('error', function() {
\r
482 if(end === false) {
\r
483 netdata.serviceError(service, ': Read error, failed to get data.');
\r
485 netdata.processResponse(service, null, callback);
\r
489 response.on('end', function() {
\r
490 if(end === false) {
\r
491 netdata.serviceErrorClear(service);
\r
492 if(netdata.options.DEBUG === true) netdata.debug(service.module.name + ': ' + service.name + ': read completed.');
\r
494 netdata.processResponse(service, data, callback);
\r
499 serviceExecute: function(service, callback) {
\r
500 if(netdata.serviceIsInitialized(service) === false)
\r
501 netdata.serviceInit(service);
\r
503 service.module.running++;
\r
505 if(netdata.options.DEBUG === true) netdata.debug(service.module.name + ': ' + service.name + ': making request: ' + netdata.stringify(service.request));
\r
506 var req = http.request(service.request, function(response) {
\r
507 if(netdata.options.DEBUG === true) netdata.debug(service.module.name + ': ' + service.name + ': request done.');
\r
508 netdata.getResponse(service, response, callback);
\r
511 req.on('error', function(e) {
\r
512 netdata.serviceError(service, ': failed to make request: ' + netdata.stringify(service.request) + ', message: ' + e.message);
\r
513 netdata.processResponse(service, null, callback);
\r
516 // write data to request body
\r
517 if(typeof service.postData !== 'undefined' && service.request.method === 'POST') {
\r
518 if(netdata.options.DEBUG === true) netdata.debug(service.module.name + ': ' + service.name + ': posting data: ' + service.postData);
\r
519 req.write(service.postData);
\r
525 configure: function(module, config, callback) {
\r
526 if(netdata.options.DEBUG === true) this.debug(module.name + ': configuring (update_every: ' + this.options.update_every + ')...');
\r
528 module.running = 0;
\r
529 module.update_every = this.options.update_every;
\r
531 if(typeof config.update_every !== 'undefined')
\r
532 module.update_every = config.update_every * 1000;
\r
534 module.enable_autodetect = (config.enable_autodetect)?true:false;
\r
536 if(typeof(callback) === 'function')
\r
537 module.configure_callback = callback;
\r
539 module.configure_callback = null;
\r
541 var added = module.configure(config);
\r
543 if(netdata.options.DEBUG === true) this.debug(module.name + ': configured, reporting ' + added + ' eligible services.');
\r
545 if(module.configure_callback !== null && added === 0) {
\r
546 if(netdata.options.DEBUG === true) this.debug(module.name + ': configuration finish callback called from configure().');
\r
547 module.configure_callback = null;
\r
556 if(netdata.options.DEBUG === true) netdata.debug('loaded netdata from: ' + __filename);
\r
557 module.exports = netdata;
\r
560 var test1 = netdata.chart('test1', { name: 'test name', dimensions: { dim1: {}}});
\r
561 netdata.begin(test1);
\r
562 netdata.set('dim1', 1);
\r
564 netdata.begin(test1);
\r
565 netdata.set('dim1', 2);
\r
567 netdata.begin(test1);
\r
568 netdata.set('dim1', 3);
\r
570 netdata.begin(test1);
\r
571 netdata.set('dim1', 4);
\r