Overview
This check monitors Speedtest through the Datadog Agent.
Setup
The Speedtest check is not included in the Datadog Agent package, so you need to install it.
Installation
For Agent v7.21+ / v6.21+, follow the instructions below to install the Speedtest check on your host. See Use Community Integrations to install with the Docker Agent or earlier versions of the Agent.
Run the following command to install the Agent integration:
datadog-agent integration install -t datadog-speedtest==<INTEGRATION_VERSION>
Configure your integration similar to core integrations.
Note: For all hosts, you need to install the Speedtest CLI and accept the agreement as the Datadog Agent user prior to use, for example: sudo -u dd-agent speedtest.
Configuration
Edit the speedtest.d/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Speedtest performance data. See the sample speedtest.d/conf.yaml for all available configuration options.
Restart the Agent.
Validation
Run the Agent’s status subcommand and look for speedtest under the Checks section.
Data Collected
Metrics
speedtest.ping.jitter
(gauge) | Jitter in milliseconds
Shown as millisecond |
speedtest.ping.latency
(gauge) | Latency in milliseconds
Shown as millisecond |
speedtest.download.bandwidth
(gauge) | Download bandwidth in mebibytes per second
Shown as mebibyte |
speedtest.download.bandwidth.bit_per_sec
(gauge) | Download bandwidth in bits per second
Shown as bit |
speedtest.download.bandwidth.byte_per_sec
(gauge) | Download bandwidth in bytes per second
Shown as byte |
speedtest.download.bytes
(gauge) | Download test payload size in bytes
Shown as byte |
speedtest.download.elapsed
(gauge) | Download test elapsed time in milliseconds
Shown as millisecond |
speedtest.upload.bandwidth
(gauge) | Upload bandwidth in mebibytes per second
Shown as mebibyte |
speedtest.upload.bandwidth.bit_per_sec
(gauge) | Upload bandwidth in bits per second
Shown as bit |
speedtest.upload.bandwidth.byte_per_sec
(gauge) | Upload bandwidth in bytes per second
Shown as byte |
speedtest.upload.bytes
(gauge) | Upload test payload size in bytes
Shown as byte |
speedtest.upload.elapsed
(gauge) | Upload test elapsed time in milliseconds
Shown as millisecond |
speedtest.packet_loss
(gauge) | Percentage of packet loss for this test
Shown as percent |
Events
The Speedtest check does not include any events.
Service Checks
speedtest.run
Returns CRITICAL if the check can’t run the test, or OK results available.
Statuses: ok, critical
Troubleshooting
Need help? Contact Datadog support.
