---
title: speedtest
description: Runs Speedtest results using speedtest-cli
breadcrumbs: Docs > Integrations > speedtest
---

# speedtest
Supported OS Integration version2.0.0
## Overview{% #overview %}

This check monitors [Speedtest](https://www.speedtest.net/apps/cli) through the Datadog Agent.

## Setup{% #setup %}

The Speedtest check is not included in the [Datadog Agent](https://app.datadoghq.com/account/settings/agent/latest) package, so you need to install it.

### Installation{% #installation %}

For Agent v7.21+ / v6.21+, follow the instructions below to install the Speedtest check on your host. See [Use Community Integrations](https://docs.datadoghq.com/agent/guide/use-community-integrations/) to install with the Docker Agent or earlier versions of the Agent.

1. Run the following command to install the Agent integration:

   ```shell
   datadog-agent integration install -t datadog-speedtest==<INTEGRATION_VERSION>
   ```

1. Configure your integration similar to core [integrations](https://docs.datadoghq.com/getting_started/integrations/).

**Note**: For all hosts, you need to install the [Speedtest CLI](https://www.speedtest.net/apps/cli) and accept the agreement as the Datadog Agent user prior to use, for example: `sudo -u dd-agent speedtest`.

### Configuration{% #configuration %}

1. 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](https://github.com/DataDog/integrations-extras/blob/master/speedtest/datadog_checks/speedtest/data/conf.yaml.example) for all available configuration options.

1. [Restart the Agent](https://docs.datadoghq.com/agent/guide/agent-commands/#start-stop-and-restart-the-agent).

### Validation{% #validation %}

Run the [Agent's status subcommand](https://docs.datadoghq.com/agent/guide/agent-commands/#agent-status-and-information) and look for `speedtest` under the Checks section.

## Data Collected{% #data-collected %}

### Metrics{% #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{% #events %}

The Speedtest check does not include any events.

### Service Checks{% #service-checks %}

**speedtest.run**

Returns `CRITICAL` if the check can't run the test, or `OK` results available.

*Statuses: ok, critical*

## Troubleshooting{% #troubleshooting %}

Need help? Contact [Datadog support](https://docs.datadoghq.com/help/).