Repository files navigation

Get network traffic statistics fromvnStat.

varvnstat=require('vnstat-dumpdb')();// Get traffic per dayvnstat.getStats('eth0',function(err,data){if(err){console.log(err);return;}console.log(data.traffic.days);});// Read config settingvnstat.getConfig(function(err,config){if(err){console.log(err);return;}console.log('Interfaces updating every '+config.UpdateInterval+' minutes');});

Make sure you havevnStat v1.13 or later.

npm install vnstat-dumpdb

The module loads as a function to override the defaults:

Each method below takes a callbackfunction which gets two arguments:

• err - Instance ofError ornull
• data - Resultobject or not set when error

functionmyCallback(err,data){if(err){console.log(err);console.log(err.stack);return;}console.log(data);}

Get statistics for one, multiple or all interfaces.

• One:vnstat.getStats ('eth0', callback)
• All:vnstat.getStats (false, callback)

// Get traffic for interface en1vnstat.getStats('en1',console.log);// Output{id:'en1',nick:'en1',created:{date:{year:2012,month:11,day:21}},updated:{date:{year:2013,month:10,day:28},time:{hour:3,minute:25}},traffic:{total:{rx:593576855,tx:63746811},days:[{id:0,date:{year:2013,month:10,day:28},rx:4083261,tx:119674},{id:1,date:{year:2013,month:10,day:27},rx:2206367,tx:52314},        ...],months:[{id:0,date:{year:2013,month:10},rx:158176326,tx:7740561},{id:1,date:{year:2013,month:9},rx:119230002,tx:3394278},        ...],tops:[{id:0,date:{year:2013,month:10,day:5},time:{hour:0,minute:10},rx:22445455,tx:601967},{id:1,date:{year:2013,month:9,day:23},time:{hour:0,minute:0},rx:20201102,tx:461492},        ...],hours:[]}}

Get vnStat configuration.

vnstat.getConfig(function(err,config){if(err){console.log(err);return;}console.log('Interfaces updating every '+config.UpdateInterval+' seconds');});

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, ordistribute this software, either in source code form or as a compiledbinary, for any purpose, commercial or non-commercial, and by anymeans.

In jurisdictions that recognize copyright laws, the author or authorsof this software dedicate any and all copyright interest in thesoftware to the public domain. We make this dedication for the benefitof the public at large and to the detriment of our heirs andsuccessors. We intend this dedication to be an overt act ofrelinquishment in perpetuity of all present and future rights to thissoftware under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OROTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OROTHER DEALINGS IN THE SOFTWARE.

For more information, please refer tohttp://unlicense.org

Franklin van de Meent