Difference between revisions of "VnStat"

From ArchWiki
Jump to: navigation, search
m (lowercase title)
m (Updating method: moved systemd up, since it is the new default)
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:Networking (English)]]
+
[[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.
 
[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.
 
==Installation==
 
==Installation==
The {{Package Official|vnStat}} package is available in [community]:
+
The {{Pkg|vnStat}} package is available in [community]:
 
  # pacman -S vnstat
 
  # pacman -S vnstat
 
==Configuration==
 
==Configuration==
Line 16: Line 16:
 
===Updating method===
 
===Updating method===
 
After introducing the interface(s) set one of the update methods.
 
After introducing the interface(s) set one of the update methods.
{{Warning| Only use one of the methods, don't use them both at the same time!}}
+
{{Warning| Only use one of the methods, do not use them at the same time!}}
 
====Cron====
 
====Cron====
The first method is using [[Cron]]. A sample of Cron usage is provided with vnStat at {{Filename|/usr/share/doc/vnstat/examples/vnstat.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}}.
 +
====Service====
 +
The second way is using [[systemd]] (and the provided service):
 +
# systemctl start vnstat.service
 
====Daemon====
 
====Daemon====
The second way of updating is using a daemon provided by vnStat. Add vnstat to your daemons in [[rc.conf#Daemons]].
+
The third way of updating is using a daemon provided by vnStat. Add vnstat to your daemons in [[rc.conf#Daemons]].
 
  DAEMONS=(... network vnstat ...)
 
  DAEMONS=(... network vnstat ...)
  
 
===Global settings===
 
===Global settings===
Other settings, like settings to control the daemon, can be done in {{Filename|/etc/vnstat.conf}}.
+
Other settings, like settings to control the daemon, can be done in {{ic|/etc/vnstat.conf}}.
  
 
==Usage==
 
==Usage==
Line 37: Line 40:
 
Or for a complete list, use:
 
Or for a complete list, use:
 
  # vnstat --longhelp
 
  # vnstat --longhelp
 +
 +
==See Also==
 +
[http://wiki.gotux.net/config/vnstat VnStat Custom WebUI]

Revision as of 00:27, 3 January 2013

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.

Installation

The vnStat package is available in [community]:

# pacman -S vnstat

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.

Updating method

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!

Cron

The first method is using Cron. A sample of Cron usage is provided with vnStat at /usr/share/doc/vnstat/examples/vnstat.cron.

Service

The second way is using systemd (and the provided service):

# systemctl start vnstat.service

Daemon

The third way of updating is using a daemon provided by vnStat. Add vnstat to your daemons in rc.conf#Daemons.

DAEMONS=(... network vnstat ...)

Global settings

Other settings, like settings to control the daemon, can be done in /etc/vnstat.conf.

Usage

Query the network traffic:

# vnstat -q

Viewing live network traffic usage:

# vnstat -l

For all the other options, use:

# vnstat --help

Or for a complete list, use:

# vnstat --longhelp

See Also

VnStat Custom WebUI