Documentation
¶
Overview ¶
Package netusage gets the usage of the network devices. Usage is calculated by taking the difference between two network device snapshots, /proc/net/dev. The time elapsed between the two snapshots is stored in the TimeDelta field. Instead of returning a Go struct, it returns Flatbuffer serialized bytes. A function to deserialize the Flatbuffer serialized bytes into a structs.DevUsage struct is provided.
Note: the package name is netusage and not the final element of the import path (flat)
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Deserialize ¶
Deserialize deserializes Flatbuffer serialized bytes as structs.DevUsage.
func Get ¶
Get returns the current network device usage as Flatbuffer serialized bytes using the package's global Profiler. The profiler is lazily instantiated. If the profiler doesn't already exist, the first usage information will not be useful due to the minimal time elapsing between the initial and second snapshots used for usage calculations; the results of the first call should be discarded.
func NewTicker ¶
NewTicker returns a new Ticker containing a Data channel that delivers the data at intervals and an error channel that delivers any errors encountered. Stop the ticker to signal the ticker to stop running. Stopping the ticker does not close the Data channel; call Close to close both the ticker and the data channel.
Types ¶
type Profiler ¶
Profiler is used to process the network device usage.
func NewProfiler ¶
Returns an initialized Profiler; ready to use. Upon creation, a /proc/net/dev snapshot is taken so that any Get() will return valid information.
func (*Profiler) Get ¶
Get returns the current network device usage as Flatbuffer serialized bytes. Calculating usage requires two snapshots. This func gets the current snapshot of /proc/net/dev and calculates the difference between that and the prior snapshot. The current snapshot is stored for use as the prior snapshot on the next Get call. If ongoing usage information is desired, the Ticker should be used; it's better suited for ongoing usage information..
Source Files