Documentation

Running Telegraf as a Windows service

This page documents an earlier version of Telegraf. Telegraf v1.16 is the latest stable version. View this page in the v1.16 documentation.

Telegraf natively supports running as a Windows service.

The following commands are available:

CommandEffect
telegraf.exe --service installInstall telegraf as a service
telegraf.exe --service uninstallRemove the telegraf service
telegraf.exe --service startStart the telegraf service
telegraf.exe --service stopStop the telegraf service

Outlined below are the general steps to install Telegraf as a Service.

Installing a Windows service requires administrative permissions. Be sure to launch Powershell as administrator.

  1. Download the Telegraf binary and unzip its contents to C:\Program Files\InfluxData\Telegraf.
  2. In PowerShell, run the following as an administrator:

    > cd "C:\Program Files\InfluxData\Telegraf"
    > .\telegraf.exe --service install --config "C:\Program Files\InfluxData\Telegraf\telegraf.conf"

    When installing Telegraf as a Windows service, provide the absolute path of the Telegraf configuration file. Otherwise the Windows service may fail to start.

  3. To test that the installation works, run:

    > C:\"Program Files"\InfluxData\Telegraf\telegraf.exe --config C:\"Program Files"\InfluxData\Telegraf\telegraf.conf --test
  4. To start collecting data, run:

    telegraf.exe --service start

Logging and troubleshooting

When Telegraf runs as a Windows service, Telegraf logs messages to Windows event logs. If the Telegraf service fails to start, view error logs by selecting Event ViewerWindows LogsApplication.


New! Cloud or OSS?

InfluxDB OSS 2.0 release candidate

InfluxDB OSS v2.0.rc includes breaking changes that require a manual upgrade from all alpha and beta versions. For information, see:

Upgrade to InfluxDB OSS v2.0.rc