net.go

package net

import (
	"fmt"
	"net"
	"strings"
	"time"

	"github.com/influxdata/telegraf"
	"github.com/influxdata/telegraf/filter"
	"github.com/influxdata/telegraf/plugins/inputs"
	"github.com/influxdata/telegraf/plugins/inputs/system"
	gnet "github.com/shirou/gopsutil/net"
)

type NetIOStats struct {
	filter       filter.Filter
	ignoreFilter filter.Filter
	ps           system.PS

	skipChecks          bool
	IgnoreProtocolStats bool
	Interfaces          []string
	IgnoreInterfaces    []string `toml:"ignore_interfaces"`

	lastIOStat    map[string]gnet.IOCountersStat
	lastTimestamp time.Time
}

func (_ *NetIOStats) Description() string {
	return "Read metrics about network interface usage"
}

var netSampleConfig = `
  ## By default, telegraf gathers stats from any up interface (excluding loopback)
  ## Setting interfaces will tell it to gather these explicit interfaces,
  ## regardless of status.
  ##
  # interfaces = ["eth0"]
  ##
  ## On linux systems telegraf also collects protocol stats.
  ## Setting ignore_protocol_stats to true will skip reporting of protocol metrics.
  ##
  # ignore_protocol_stats = false
  ##
`

func (_ *NetIOStats) SampleConfig() string {
	return netSampleConfig
}

func (s *NetIOStats) Gather(acc telegraf.Accumulator) error {
	netio, err := s.ps.NetIO()
	if err != nil {
		return fmt.Errorf("error getting net io info: %s", err)
	}

	if s.filter == nil {
		if s.filter, err = filter.Compile(s.Interfaces); err != nil {
			return fmt.Errorf("error compiling filter: %s", err)
		}
	}

	if s.ignoreFilter == nil {
		if s.ignoreFilter, err = filter.Compile(s.IgnoreInterfaces); err != nil {
			return fmt.Errorf("error compiling ignore filter: %s", err)
		}
	}

	now := time.Now()
	var seconds float64 = 0
	lastIOStat := make(map[string]gnet.IOCountersStat)
	if s.lastIOStat != nil {
		seconds = now.Sub(s.lastTimestamp).Seconds()
	}

	for _, io := range netio {
		if len(s.Interfaces) != 0 {
			var found bool

			if s.filter.Match(io.Name) {
				found = true
			}

			if !found {
				continue
			}
		} else if !s.skipChecks {
			iface, err := net.InterfaceByName(io.Name)
			if err != nil {
				continue
			}

			if iface.Flags&net.FlagLoopback == net.FlagLoopback {
				continue
			}

			if iface.Flags&net.FlagUp == 0 {
				continue
			}
		}

		if len(s.IgnoreInterfaces) != 0 {
			var found bool

			if s.ignoreFilter.Match(io.Name) {
				found = true
			}
			if found {
				continue
			}
		}

		tags := map[string]string{
			"interface": io.Name,
		}

		fields := map[string]interface{}{
			"bytes_sent":   io.BytesSent,
			"bytes_recv":   io.BytesRecv,
			"packets_sent": io.PacketsSent,
			"packets_recv": io.PacketsRecv,
			"err_in":       io.Errin,
			"err_out":      io.Errout,
			"drop_in":      io.Dropin,
			"drop_out":     io.Dropout,
		}

		lastIOStat[io.Name] = gnet.IOCountersStat{
			BytesRecv:   io.BytesRecv,
			BytesSent:   io.BytesSent,
			PacketsSent: io.PacketsSent,
			PacketsRecv: io.PacketsRecv,
		}
		if seconds > 0 {
			if stat, ok := s.lastIOStat[io.Name]; ok {
				sendRate := float64(io.BytesSent-stat.BytesSent) / seconds
				fields["send_rate"] = sendRate
				recvRate := float64(io.BytesRecv-stat.BytesRecv) / seconds
				fields["recv_rate"] = recvRate
				pkgSendRate := float64(io.PacketsSent-stat.PacketsSent) / seconds
				fields["pkg_send_rate"] = pkgSendRate
				pkgRecvRate := float64(io.PacketsRecv-stat.PacketsRecv) / seconds
				fields["pkg_recv_rate"] = pkgRecvRate
			}
		}

		acc.AddCounter("net", fields, tags)
	}

	s.lastIOStat = lastIOStat
	s.lastTimestamp = now

	// Get system wide stats for different network protocols
	// (ignore these stats if the call fails)
	if !s.IgnoreProtocolStats {
		netprotos, _ := s.ps.NetProto()
		fields := make(map[string]interface{})
		for _, proto := range netprotos {
			for stat, value := range proto.Stats {
				name := fmt.Sprintf("%s_%s", strings.ToLower(proto.Protocol),
					strings.ToLower(stat))
				fields[name] = value
			}
		}
		tags := map[string]string{
			"interface": "all",
		}
		acc.AddFields("net", fields, tags)
	}

	return nil
}

func init() {
	inputs.Add("net", func() telegraf.Input {
		return &NetIOStats{ps: system.NewSystemPS()}
	})
}