Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/telegraf/v1.22/install.md

12 KiB
Raw Blame History

title description menu aliases
Install Telegraf Install Telegraf on your operating system.
telegraf_1_22
name weight
Install 20
/telegraf/v1.22/introduction/installation/

This page provides directions for installing, starting, and configuring Telegraf. To install Telegraf, do the following:

  1. Download Telegraf
  2. Review requirements
  3. Complete the installation

Download

Download the latest Telegraf release at the InfluxData download page.

Requirements

Installation of the Telegraf package may require root or administrator privileges in order to complete successfully.

Networking

Telegraf offers multiple service input plugins that may require custom ports. Modify port mappings through the configuration file (telegraf.conf).

For Linux distributions, this file is located at /etc/telegraf for default installations.

For Windows distributions, the configuration file is located in the directory where you unzipped the Telegraf ZIP archive. The default location is C:\InfluxData\telegraf.

NTP

Telegraf uses a host's local time in UTC to assign timestamps to data. Use the Network Time Protocol (NTP) to synchronize time between hosts. If hosts' clocks aren't synchronized with NTP, the timestamps on the data might be inaccurate.

Installation

{{< tabs-wrapper >}} {{% tabs style="even-wrap" %}} Ubuntu & Debian RedHat & CentOS SLES & openSUSE FreeBSD/PC-BSD macOS Windows {{% /tabs %}}

{{% tab-content %}} Debian and Ubuntu users can install the latest stable version of Telegraf using the apt-get package manager.

Ubuntu & Debian

Install Telegraf from the InfluxData repository with the following commands:

{{< code-tabs-wrapper >}} {{% code-tabs %}} wget curl {{% /code-tabs %}}

{{% code-tab-content %}}

# influxdata-archive_compat.key GPG Fingerprint: 9D539D90D3328DC7D6C8D3B9D8FF8E1F7DF8B07E
wget -q https://repos.influxdata.com/influxdata-archive_compat.key
echo '393e8779c89ac8d958f81f942f9ad7fb82a25e133faddaf92e15b16e6ac9ce4c influxdata-archive_compat.key' | sha256sum -c && cat influxdata-archive_compat.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg > /dev/null
echo 'deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg] https://repos.influxdata.com/debian stable main' | sudo tee /etc/apt/sources.list.d/influxdata.list
sudo apt-get update && sudo apt-get install telegraf

{{% /code-tab-content %}}

{{% code-tab-content %}}

# influxdata-archive_compat.key GPG Fingerprint: 9D539D90D3328DC7D6C8D3B9D8FF8E1F7DF8B07E
curl -s https://repos.influxdata.com/influxdata-archive_compat.key > influxdata-archive_compat.key
echo '393e8779c89ac8d958f81f942f9ad7fb82a25e133faddaf92e15b16e6ac9ce4c influxdata-archive_compat.key' | sha256sum -c && cat influxdata-archive_compat.key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg > /dev/null
echo 'deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive_compat.gpg] https://repos.influxdata.com/debian stable main' | sudo tee /etc/apt/sources.list.d/influxdata.list
sudo apt-get update && sudo apt-get install telegraf

{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}

Install from a .deb file:

To manually install the Debian package from a .deb file:

  1. Download the latest Telegraf .deb release from the Telegraf section of the downloads page.

  2. Run the following command (making sure to supply the correct version number for the downloaded file):

    sudo dpkg -i telegraf_{{< latest-patch >}}-1_amd64.deb

{{% telegraf/verify %}}

Configuration

Create a configuration file with default input and output plugins.

Every plugin will be in the file, but most will be commented out.

telegraf config > telegraf.conf

Create a configuration file with specific inputs and outputs

telegraf --input-filter <pluginname>[:<pluginname>] --output-filter <outputname>[:<outputname>] config > telegraf.conf

For more advanced configuration details, see the configuration documentation. {{% /tab-content %}}

{{% tab-content %}} For instructions on how to manually install the RPM package from a file, please see the downloads page.

RedHat and CentOS: Install the latest stable version of Telegraf using the yum package manager:

cat <<EOF | sudo tee /etc/yum.repos.d/influxdb.repo
[influxdb]
name = InfluxData Repository - Stable
baseurl = https://repos.influxdata.com/stable/\$basearch/main
enabled = 1
gpgcheck = 1
gpgkey = https://repos.influxdata.com/influxdata-archive_compat.key
EOF

Install telegraf once the repository is added to the yum configuration:

sudo yum install telegraf

{{% telegraf/verify %}}

Configuration

Create a configuration file with default input and output plugins

Every plugin will be in the file, but most will be commented out.

telegraf config > telegraf.conf

Create a configuration file with specific inputs and outputs

telegraf --input-filter <pluginname>[:<pluginname>] --output-filter <outputname>[:<outputname>] config > telegraf.conf

For more advanced configuration details, see the configuration documentation. {{% /tab-content %}}

{{% tab-content %}} There are RPM packages provided by openSUSE Build Service for SUSE Linux users:

# add go repository
zypper ar -f obs://devel:languages:go/ go
# install latest telegraf
zypper in telegraf

{{% telegraf/verify %}}

Configuration

Create a configuration file with default input and output plugins.

Every plugin will be in the file, but most will be commented out.

telegraf config > telegraf.conf

Create a configuration file with specific inputs and outputs

telegraf --input-filter <pluginname>[:<pluginname>] --output-filter <outputname>[:<outputname>] config > telegraf.conf

For more advanced configuration details, see the configuration documentation. {{% /tab-content %}}

{{% tab-content %}} Telegraf is part of the FreeBSD package system. It can be installed by running:

sudo pkg install telegraf

The configuration file is located at /usr/local/etc/telegraf.conf with examples in /usr/local/etc/telegraf.conf.sample.

{{% telegraf/verify %}}

Configuration

Create a configuration file with default input and output plugins.

Every plugin will be in the file, but most will be commented out.

telegraf config > telegraf.conf

Create a configuration file with specific inputs and outputs

telegraf --input-filter <pluginname>[:<pluginname>] --output-filter <outputname>[:<outputname>] config > telegraf.conf

For more advanced configuration details, see the configuration documentation. {{% /tab-content %}}

{{% tab-content %}} Users of macOS 10.8 and higher can install Telegraf using the Homebrew package manager. Once brew is installed, you can install Telegraf by running:

brew update
brew install telegraf

To have launchd start telegraf at next login:

ln -sfv /usr/local/opt/telegraf/*.plist ~/Library/LaunchAgents

To load telegraf now:

launchctl load ~/Library/LaunchAgents/homebrew.mxcl.telegraf.plist

Or, if you don't want/need launchctl, you can just run:

telegraf -config /usr/local/etc/telegraf.conf

{{% telegraf/verify %}}

Configuration

Create a configuration file with default input and output plugins.

Every plugin will be in the file, but most will be commented out.

telegraf config > telegraf.conf

Create a configuration file with specific inputs and outputs

telegraf --input-filter <pluginname>[:<pluginname>] --output-filter <outputname>[:<outputname>] config > telegraf.conf

For more advanced configuration details, see the configuration documentation. {{% /tab-content %}}

{{% tab-content %}}

Download and run Telegraf as a Windows service

{{% note %}} Installing a Windows service requires administrative permissions. To run PowerShell as an administrator, see Launch PowerShell as administrator. {{% /note %}}

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-{{% latest-patch %}}_windows_amd64.zip -UseBasicParsing -OutFile telegraf-{{< latest-patch >}}_windows_amd64.zip
> Expand-Archive .\telegraf-{{% latest-patch %}}_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-{{% latest-patch %}} up a level to C:\Program Files\InfluxData\telegraf:

    > cd "C:\Program Files\InfluxData\telegraf"
> mv .\telegraf-{{% latest-patch %}}\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 Viewer→Windows Logs→Application.

Windows service commands

The following commands are available:

Command Effect
telegraf.exe --service install Install telegraf as a service
telegraf.exe --service uninstall Remove the telegraf service
telegraf.exe --service start Start the telegraf service
telegraf.exe --service stop Stop the telegraf service

{{< /tab-content >}} {{< /tabs-wrapper >}}