---
title: Syncthing
description: Track overall statistics from your Syncthing instance
breadcrumbs: Docs > Integrations > Syncthing
---

# Syncthing
Supported OS Integration version1.1.0
## Overview{% #overview %}

Syncthing synchronizes files between two or more computers in real time. This integration allows you to monitor [Syncthing](https://syncthing.net/) using Datadog.

## Setup{% #setup %}

The Syncthing 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 Syncthing check on your host. See [Use Community Integrations](https://docs.datadoghq.com/agent/guide/use-community-integrations/) to install the Syncthing check 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-syncthing==<INTEGRATION_VERSION>
   ```

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

### Configuration{% #configuration %}

1. Edit the `syncthing.d/conf.yaml` file in the `conf.d/` folder at the root of your [Agent's configuration directory](https://docs.datadoghq.com/agent/guide/agent-configuration-files/#agent-configuration-directory) to start collecting your Syncthing metrics. See the [sample syncthing.d/conf.yaml](https://github.com/DataDog/integrations-extras/blob/master/syncthing/datadog_checks/syncthing/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/#service-status) and look for `syncthing` under the Checks section.

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

### Metrics{% #metrics %}

|  |
|  |
| **syncthing.connections.connected**(gauge)                   | The number of connected endpoints*Shown as connection*           |
| **syncthing.connections.paused**(gauge)                      | The number of paused endpoints*Shown as connection*              |
| **syncthing.connections.count**(gauge)                       | The number of endpoints*Shown as connection*                     |
| **syncthing.folder.bytes**(gauge)                            | The size of the folder*Shown as byte*                            |
| **syncthing.folder.errors**(count)                           | The errors count for folder*Shown as error*                      |
| **syncthing.folder.files**(gauge)                            | The count of files in the folder*Shown as file*                  |
| **syncthing.folder.global.bytes**(gauge)                     | The global size of the folder*Shown as byte*                     |
| **syncthing.folder.global.deleted**(gauge)                   | The global count of the deleted files*Shown as file*             |
| **syncthing.folder.global.directories**(gauge)               | The global count of directories*Shown as file*                   |
| **syncthing.folder.global.files**(gauge)                     | The global count of files*Shown as file*                         |
| **syncthing.folder.global.total\_items**(gauge)              | The global total count of items*Shown as item*                   |
| **syncthing.folder.local.bytes**(gauge)                      | The local size of the folder*Shown as byte*                      |
| **syncthing.folder.local.deleted**(gauge)                    | The local count of the deleted files*Shown as file*              |
| **syncthing.folder.local.directories**(gauge)                | The local count of directories*Shown as file*                    |
| **syncthing.folder.local.files**(gauge)                      | The local count of files*Shown as file*                          |
| **syncthing.folder.local.total\_items**(gauge)               | The local total count of items*Shown as item*                    |
| **syncthing.folder.need.bytes**(gauge)                       | The need to sync size*Shown as byte*                             |
| **syncthing.folder.need.deletes**(gauge)                     | The need to delete files count*Shown as file*                    |
| **syncthing.folder.need.directories**(gauge)                 | The need to sync directories count*Shown as file*                |
| **syncthing.folder.need.files**(gauge)                       | The need to sync files count*Shown as file*                      |
| **syncthing.folder.need.total\_items**(gauge)                | The need to sync total items count*Shown as item*                |
| **syncthing.folder.pull\_errors**(count)                     | The pull errors count*Shown as error*                            |
| **syncthing.folder.last\_scan**(gauge)                       | The time from the last folder scan*Shown as second*              |
| **syncthing.errors**(count)                                  | The system errors count*Shown as error*                          |
| **syncthing.stats.device.last\_seen**(gauge)                 | The time from the last device seen*Shown as second*              |
| **syncthing.stats.device.last\_connection\_duration**(gauge) | The time of the last device connection duration*Shown as second* |

### Events{% #events %}

Syncthing does not include any events.

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

**syncthing.can\_connect**

Returns `CRITICAL` if the Agent can't connect to the Syncthing endpoint, OK otherwise

*Statuses: ok, critical*

## Troubleshooting{% #troubleshooting %}

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