Syncthing

Supported OS Linux Mac OS Windows

Integrationv1.0.0

Overview

Syncthing synchronizes files between two or more computers in real time. This integration allows you to monitor Syncthing using Datadog.

Setup

The Syncthing 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 Syncthing check on your host. See 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:

    datadog-agent integration install -t datadog-syncthing==<INTEGRATION_VERSION>
    
  2. Configure your integration similar to core integrations.

Configuration

  1. Edit the syncthing.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Syncthing metrics. See the sample syncthing.d/conf.yaml for all available configuration options.

  2. Restart the Agent

Validation

Run the Agent’s status subcommand and look for syncthing under the Checks section.

Data Collected

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.errors
(count)
The system errors count
Shown as error

Events

Syncthing does not include any events.

Service Checks

syncthing.can_connect
Returns CRITICAL if the Agent can’t connect to the Syncthing endpoint, OK otherwise
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.