Git Product home page Git Product logo

vnstat-ruby's Introduction

vnstat-ruby

Build Status Coverage Status Gem Version

Vnstat is a tool that tracks the traffic on your network interfaces. This tiny library is intended to provide network traffic information through an easy-to-use API.

It depends on the vnstat command line utility which is maintained by Teemu Toivola.

Prerequisites

  • Ruby 2.3.0 or greater
  • Make sure you have vnstat CLI installed by running which vnstat.

On Ubuntu you can get the vnstat package via apt-get install vnstat.

Getting Started

Setup

Once the dependent package is installed, you are ready to install the vnstat-ruby gem.

gem install vnstat-ruby

Or, add the following line to the Gemfile of your project and run the bundle install command:

gem 'vnstat-ruby'

Configuration

By default, vnstat-ruby tries to automatically determine the location of your vnstat executable. If you need to change this path for some reason, you can override the default:

Vnstat.config.executable_path = '/usr/bin/vnstat'

Usage

Network Interfaces

To retrieve a list of all known network interfaces:

Vnstat.interfaces # => #<Vnstat::InterfaceCollection ...>
Vnstat.interfaces.ids # => ['eth01', 'eth02']

To only retrieve traffic stats for a single interface:

Vnstat.interfaces.first # => #<Vnstat::Interface id: "eth01">

If you know the name of a network interface, you can also retrieve the stats of that particular one:

Vnstat['eth01'] # => #<Vnstat::Interface id: "eth01">

Traffic Information

Total
interface = Vnstat['eth01']
interface.total # => #<Vnstat::Result ...>
interface.total.bytes_received # => 1024000
interface.total.bytes_sent # => 2048000
interface.total.bytes_transmitted # => 3072000
By Month
interface.months # => #<Vnstat::Traffic::Monthly ...>
interface.months.first
interface.months[2015, 9]
# => #<Vnstat::Result::Month year: 2015, month: 9, ...>
interface.months[2015, 10].bytes_received # => 3072000
By Day
interface.days # => #<Vnstat::Traffic::Daily ...>
interface.days.first
interface.days[Date.new(2015, 11, 23)]
interface.days[2015, 11, 23]
# => #<Vnstat::Result::Day date: #<Date: 2015-11-23>, ...>
interface.days[2015, 11, 23].bytes_received # => 2048000
By Hour
interface.hours # => #<Vnstat::Traffic::Hourly ...>
interface.hours.first
interface.hours[Date.new(2015, 9, 22), 10]
interface.hours[2015, 9, 22, 10]
# => #<Vnstat::Result::Hour date: #<Date: 2015-11-23>, hour: 10>
interface.hours[2015, 9, 22, 10].bytes_received # => 2048000
Tops
interface.tops #=> #<Vnstat::Traffic::Tops ...>
interface.tops.count #=> 10
interface.tops.each do |top|
  # ...
end
interface.tops.first
interface.tops[2]
# => #<Vnstat::Result::Minute time: 2015-11-05 09:03:42 +0000>
interface.tops[1].bytes_received # => 1024000

Contributing to vnstat-ruby

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2015-2020 Tobias Casper. See LICENSE.txt for further details.

vnstat-ruby's People

Contributors

dependabot[bot] avatar tlux avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

mtncn felixding

vnstat-ruby's Issues

Vnstat.interfaces returns nil

My env:

  • Ubuntu 18.04 deployed on Vultr
  • vnStat 2.6 by Teemu Toivola
  • ruby 2.7.0p0

Vnstat.interfaces returns #<Vnstat::InterfaceCollection ids: [nil]>

Vnstat::InterfaceCollection.load_data returns XML:

<vnstat version=\"2.6\" xmlversion=\"2\">\n <interface name=\"ens3\">\n  <name>ens3</name>\n  <alias></alias>\n  <created><date><year>2020</year><month>05</month><day>18</day></date></created>\n  <updated><date><year>2020</year><month>05</month><day>18</day></date><time><hour>11</hour><minute>09</minute></time></updated>\n  <traffic>\n   <total><rx>138591761</rx><tx>2255297</tx></total>\n   <fiveminutes>\n    <fiveminute id=\"2\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>09</hour><minute>30</minute></time><rx>31226247</rx><tx>405618</tx></fiveminute>\n    <fiveminute id=\"1\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>09</hour><minute>35</minute></time><rx>95922279</rx><tx>1357442</tx></fiveminute>\n    <fiveminute id=\"3\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>09</hour><minute>40</minute></time><rx>10790118</rx><tx>246844</tx></fiveminute>\n    <fiveminute id=\"4\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>09</hour><minute>45</minute></time><rx>253334</rx><tx>37866</tx></fiveminute>\n    <fiveminute id=\"5\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>09</hour><minute>50</minute></time><rx>22910</rx><tx>718</tx></fiveminute>\n    <fiveminute id=\"6\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>09</hour><minute>55</minute></time><rx>7269</rx><tx>566</tx></fiveminute>\n    <fiveminute id=\"7\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>00</minute></time><rx>27478</rx><tx>786</tx></fiveminute>\n    <fiveminute id=\"8\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>05</minute></time><rx>15156</rx><tx>920</tx></fiveminute>\n    <fiveminute id=\"9\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>10</minute></time><rx>26431</rx><tx>462</tx></fiveminute>\n    <fiveminute id=\"10\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>15</minute></time><rx>18445</rx><tx>1595</tx></fiveminute>\n    <fiveminute id=\"11\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>20</minute></time><rx>14542</rx><tx>1078</tx></fiveminute>\n    <fiveminute id=\"12\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>25</minute></time><rx>35224</rx><tx>352</tx></fiveminute>\n    <fiveminute id=\"13\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>30</minute></time><rx>9469</rx><tx>252</tx></fiveminute>\n    <fiveminute id=\"14\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>35</minute></time><rx>18968</rx><tx>1371</tx></fiveminute>\n    <fiveminute id=\"15\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>40</minute></time><rx>21524</rx><tx>378</tx></fiveminute>\n    <fiveminute id=\"16\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>45</minute></time><rx>12226</rx><tx>364</tx></fiveminute>\n    <fiveminute id=\"17\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>50</minute></time><rx>32844</rx><tx>294</tx></fiveminute>\n    <fiveminute id=\"18\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>55</minute></time><rx>9978</rx><tx>420</tx></fiveminute>\n    <fiveminute id=\"19\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>11</hour><minute>00</minute></time><rx>75353</rx><tx>97684</tx></fiveminute>\n    <fiveminute id=\"20\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>11</hour><minute>05</minute></time><rx>51966</rx><tx>100287</tx></fiveminute>\n   </fiveminutes>\n   <hours>\n    <hour id=\"1\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>09</hour><minute>00</minute></time><rx>138222157</rx><tx>2049054</tx></hour>\n    <hour id=\"2\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>10</hour><minute>00</minute></time><rx>242285</rx><tx>8272</tx></hour>\n    <hour id=\"3\"><date><year>2020</year><month>05</month><day>18</day></date><time><hour>11</hour><minute>00</minute></time><rx>127319</rx><tx>197971</tx></hour>\n   </hours>\n   <days>\n    <day id=\"1\"><date><year>2020</year><month>05</month><day>18</day></date><rx>138591761</rx><tx>2255297</tx></day>\n   </days>\n   <months>\n    <month id=\"1\"><date><year>2020</year><month>05</month></date><rx>138591761</rx><tx>2255297</tx></month>\n   </months>\n   <years>\n    <year id=\"1\"><date><year>2020</year><month>01</month><day>01</day></date><time><hour>00</hour><minute>00</minute></time><rx>138591761</rx><tx>2255297</tx></year>\n   </years>\n   <tops>\n    <top id=\"1\"><date><year>2020</year><month>05</month><day>18</day></date><rx>138591761</rx><tx>2255297</tx></top>\n   </tops>\n  </traffic>\n </interface>\n</vnstat>

Maybe something to do with parsing the XML?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.