Documentation for network performance metrics.

The total number of bytes received by a network interface.

The total number of bytes transmitted by a network interface.

The total number of loss-of-carrier-signal events detected by the device driver. If this value is high, especially when it has only been active for a short time, it means the connection is going up and down a lot. This can be caused by problems either on the device, the device on the other end, or a faulty ethernet cable plugged in to the device.

The number of packet collisions detected when transmitting. Packet collisions occur when multiple devices use a shared resource (such as an ethernet cable) to transmit a packet at the same time. Frequent packet collisions degrade network performance.

Number of compressed packets received by a network interface.

Number of compressed packets sent by a network interface.

Number of packets dropped and otherwise not received by a network interface. This means that your system is unable to process incoming packets fast enough, overwhelming its buffer, or there is an issue in your cabling leading to packet loss.

Number of packets dropped by a network interface. This means that your system is unable to process outgoing packets fast enough, overwhelming its buffer.

Number of malformed packets received by a network interface. Errors are typically caused by bursts of traffic causing overloads, a speed/duplex mismatch with the connecting port on the other end, or a large number of security rules.

Number of errors detected by a network interface when transmitting. Errors are typically caused by bursts of traffic causing overloads, a speed/duplex mismatch with the connecting port on the other end, or a large number of security rules.

The number of receiving queue errors detected by a network interface. This is often caused by receiving more packets than the computer can process, leading to buffer overflows.

The number of transmitting queue errors detected by a network interface. This is often caused by trying to send more packets than the network connection can handle, leading to buffer overflows.

Number of packets received by an interface with framing errors. This is often a physical issue (faulty cables or bad Network Interface Card), though it may be caused by mismatched duplex settings.

Number of multicast frames received by a network interface.

Number of packets received by a network interface.

Number of packets transmitted by a network interface.

Percentage of a network interface's maximum bandwidth being used for receiving packets.

Note: The data received is reported in bytes while bandwidth is in megabits per second, so some conversion is necessary to ensure the units match.

Percentage of a network interface's maximum bandwidth being used for transmitting packets.

Note: The data transmitted is reported in bytes while bandwidth is in megabits per second, so some conversion is necessary to ensure the units match.

Average percentage of the maximum bandwidth across all interfaces (except loopback) being used for receiving packets.

Note: The data received is reported in bytes while bandwidth is in megabits per second, so some conversion is necessary to ensure the units match.

Average percentage of the maximum bandwidth across all interfaces (except loopback) being used for transmitting packets.

Note: The data transmitted is reported in bytes while bandwidth is in megabits per second, so some conversion is necessary to ensure the units match.

===

To contribute to this documentation, see the contributing guide. Any updates to the documentation should be tagged.

$ git tag -a <major.minor.patch> -m "[UPDATE] version."
$ git push origin <major.minor.patch>

Use semantic versioning (semvar) for communicating versions.

• Any new metrics should be communicated as minor updates.
• Any corrections/value modifications should be patches.
• Any documentation restructuring (changing field names, removing fields, etc) should be communicated as a major update.

===

The documentation is stored as JSON, a lightweight data-interchange format. Many languages provide JSON support: JavaScript, Python, Go, PHP, Java, Haskell, and others.

You are free to use the JSON documentation, as is. Simply copy the file and use accordingly.

For those using package managers to manage dependencies, we provide package manager support, as outlined below.

The documentation is registered as a Bower package. Bower provides a straightforward means for managing dependencies.

In order to use Bower, you must first install Node.js and Git. Once the prerequisites are installed,

$ npm install -g bower

To install the latest documentation,

$ bower install doc-metrix-network

Bower will place the documentation in a bower_components/ directory within the current working directory.

To update to the latest documentation,

$ bower update doc-metrix-network

List of utilities using this documentation:

• Node.js Module

MIT license.

Copyright © 2014. NodePrime.