Documentation

Running Telegraf as a Windows service

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

Telegraf natively supports running as a Windows service.

Download and run Telegraf as a Windows service

Installing a Windows service requires administrative permissions. To run PowerShell as an administrator, see “Launch PowerShell as administrator”.

In PowerShell as an administrator, do the following:

  1. Use the following commands to download the Telegraf Windows binary and extract its contents to C:\Program Files\InfluxData\telegraf\:

    > wget https://dl.influxdata.com/telegraf/releases/telegraf-1.18.3_windows_amd64.zip -UseBasicParsing -OutFile telegraf-1.18.3_windows_amd64.zip
    > Expand-Archive .\telegraf-1.18.3_windows_amd64.zip -DestinationPath 'C:\Program Files\InfluxData\telegraf\'
    
  2. Move the telegraf.exe and telegraf.conf files from C:\Program Files\InfluxData\telegraf\telegraf-1.18.3 up a level to C:\Program Files\InfluxData\telegraf:

    > cd "C:\Program Files\InfluxData\telegraf"
    > mv .\telegraf-1.18.3\telegraf.* .
    

    Or create a Windows symbolic link (Symlink) to point to this directory.

    The instructions below assume that either the telegraf.exe and telegraf.conf files are stored in C:\Program Files\InfluxData\telegraf, or you’ve created a Symlink to point to this directory.

  3. Install Telegraf as a service:

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

    Make sure to provide the absolute path of the telegraf.conf configuration file, otherwise the Windows service may fail to start.

  4. To test that the installation works, run:

    > C:\"Program Files"\InfluxData\telegraf\telegraf.exe --config C:\"Program Files"\InfluxData\telegraf\telegraf.conf --test
    
  5. 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.

Windows service commands

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

Upgrade to InfluxDB Cloud or InfluxDB 2.0!

InfluxDB Cloud and InfluxDB OSS 2.0 ready for production.