internet_speed

README

Internet Speed Monitor Input Plugin

The Internet Speed Monitor collects data about the internet speed on the system.

On some systems, the default settings may cause speed tests to fail; if this affects you then try enabling memory_saving_mode. This reduces the memory requirements for the test, and may reduce the runtime of the test. However, please be aware that this may also reduce the accuracy of the test for fast (>30Mb/s) connections. This setting enables the upstream Memory Saving Mode

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Monitors internet speed using speedtest.net service
[[inputs.internet_speed]]
  ## This plugin downloads many MB of data each time it is run. As such
  ## consider setting a higher interval for this plugin to reduce the
  ## demand on your internet connection.
  # interval = "60m"

  ## Enable to reduce memory usage
  # memory_saving_mode = false

  ## Caches the closest server location
  # cache = false

  ## Number of concurrent connections
  ## By default or set to zero, the number of CPU cores is used. Use this to
  ## reduce the impact on system performance or to increase the connections on
  ## faster connections to ensure the fastest speed.
  # connections = 0

  ## Test mode
  ## By default, a single sever is used for testing. This may work for most,
  ## however, setting to "multi" will reach out to multiple servers in an
  ## attempt to get closer to ideal internet speeds.
  # test_mode = "single"

  ## Server ID exclude filter
  ## Allows the user to exclude or include specific server IDs received by
  ## speedtest-go. Values in the exclude option will be skipped over. Values in
  ## the include option are the only options that will be picked from.
  ##
  ## See the list of servers speedtest-go will return at:
  ##     https://www.speedtest.net/api/js/servers?engine=js&limit=10
  ##
  # server_id_exclude = []
  # server_id_include = []

Metrics

It collects the following fields:

Name	field name	type	Unit
Download Speed	download	float64	Mbps
Upload Speed	upload	float64	Mbps
Latency	latency	float64	ms
Jitter	jitter	float64	ms
Location	location	string	-

And the following tags:

Name	tag name
Source	source
Server ID	server_id
Test Mode	test_mode

Example Output

internet_speed,source=speedtest02.z4internet.com:8080,server_id=54619,test_mode=single download=318.37580265897725,upload=30.444407341274385,latency=37.73174,jitter=1.99810,location="Somewhere, TX" 1675458921000000000

Documentation

Index

• type InternetSpeed
  • func (is *InternetSpeed) Gather(acc telegraf.Accumulator) error
  • func (is *InternetSpeed) Init() error
  • func (*InternetSpeed) SampleConfig() string

Types

type InternetSpeed

type InternetSpeed struct {
	ServerIDInclude    []string `toml:"server_id_include"`
	ServerIDExclude    []string `toml:"server_id_exclude"`
	EnableFileDownload bool     `toml:"enable_file_download" deprecated:"1.25.0;use 'memory_saving_mode' instead"`
	MemorySavingMode   bool     `toml:"memory_saving_mode"`
	Cache              bool     `toml:"cache"`
	Connections        int      `toml:"connections"`
	TestMode           string   `toml:"test_mode"`

	Log telegraf.Logger `toml:"-"`
	// contains filtered or unexported fields
}

InternetSpeed is used to store configuration values.

func (*InternetSpeed) Gather

func (is *InternetSpeed) Gather(acc telegraf.Accumulator) error

func (*InternetSpeed) Init

func (is *InternetSpeed) Init() error

func (*InternetSpeed) SampleConfig

func (*InternetSpeed) SampleConfig() string