Difference between revisions of "VnStat"

From ArchWiki
Jump to: navigation, search
(Configuration: A database must be initialized to monitor a particular network (why was this not stated already?!))
 
(19 intermediate revisions by 12 users not shown)
Line 1: Line 1:
[[Category:Networking]]
 
 
{{lowercase title}}
 
{{lowercase title}}
[http://humdi.net/vnstat/ vnStat] is a lightweight network traffic monitor. It keeps a network traffic log on selectable interfaces. Through the command line the network traffic statistics can be shown.
+
[[Category:Networking]]
==Installation==
+
[[ja:VnStat]]
The {{Pkg|vnStat}} package is available in [community]:
+
[[ru:VnStat]]
# pacman -S vnstat
+
[http://humdi.net/vnstat/ vnStat] is a lightweight (command line) network traffic monitor. It monitors selectable interfaces and stores network traffic logs in a database for later analysis.
==Configuration==
+
===Setting the interfaces===
+
First introduce every interface that needs to be logged to vnStat. For example a wired interface:
+
# vnstat -u -i eth0
+
Or a wireless interface:
+
# vnstat -u -i wlan0
+
  
When introducing an interface for the first time there will be an error message saying 'unable to read database'. If this message is followed by an info message saying 'a new database has been created' the interface is successfully introduced. If this is not the case check that the specified interface is valid.
+
== Installation ==
  
===Updating method===
+
[[Install]] {{Pkg|vnstat}} from the [[official repositories]].
After introducing the interface(s) set one of the update methods.
+
 
{{Warning| Only use one of the methods, do not use them at the same time!}}
+
== Configuration ==
====Cron====
+
 
The first method is using [[Cron]]. A sample of Cron usage is provided with vnStat at {{ic|/usr/share/doc/vnstat/examples/vnstat.cron}}.
+
Pick a preferred network interface and edit the {{ic|Interface}} variable in the {{ic|/etc/vnstat.conf}} accordingly. To the list all interfaces available to vnstat, use {{ic|vnstat --iflist}}.
====Daemon====
+
 
The second way of updating is using a daemon provided by vnStat. Add vnstat to your daemons in [[rc.conf#Daemons]].
+
To start monitoring a particular interface you must initialize a database first. Each interface needs its own database. The command to initialize one for the {{ic|eth0}} interface is:
  DAEMONS=(... network vnstat ...)
+
  # vnstat -u -i eth0
====Service====
+
 
The third way is using [[systemd]] (and the provided service):
+
=== Start Systemd Service ===
 +
 
 +
After introducing the interface(s) and checking the config file. You can start the monitoring process via [[systemd]]
 
  # systemctl start vnstat.service
 
  # systemctl start vnstat.service
 +
To make this service permanent use
 +
# systemctl enable vnstat.service
  
===Global settings===
+
== Usage ==
Other settings, like settings to control the daemon, can be done in {{ic|/etc/vnstat.conf}}.
+
  
==Usage==
 
 
Query the network traffic:
 
Query the network traffic:
 
  # vnstat -q
 
  # vnstat -q
Line 36: Line 31:
 
  # vnstat -l
 
  # vnstat -l
  
For all the other options, use:
+
To find more options, use:
 
  # vnstat --help
 
  # vnstat --help
Or for a complete list, use:
 
# vnstat --longhelp
 
 
==See Also==
 
[http://wiki.gotux.net/config/vnstat VnStat Custom WebUI]
 

Latest revision as of 12:52, 29 April 2016

vnStat is a lightweight (command line) network traffic monitor. It monitors selectable interfaces and stores network traffic logs in a database for later analysis.

Installation

Install vnstat from the official repositories.

Configuration

Pick a preferred network interface and edit the Interface variable in the /etc/vnstat.conf accordingly. To the list all interfaces available to vnstat, use vnstat --iflist.

To start monitoring a particular interface you must initialize a database first. Each interface needs its own database. The command to initialize one for the eth0 interface is:

# vnstat -u -i eth0 

Start Systemd Service

After introducing the interface(s) and checking the config file. You can start the monitoring process via systemd

# systemctl start vnstat.service

To make this service permanent use

# systemctl enable vnstat.service

Usage

Query the network traffic:

# vnstat -q

Viewing live network traffic usage:

# vnstat -l

To find more options, use:

# vnstat --help