文档文档

安装 Telegraf

本页提供安装、启动和配置 Telegraf 的说明。要安装 Telegraf,请执行以下操作

要求

安装 Telegraf 软件包可能需要 root 或管理员权限才能成功完成。

网络

Telegraf 提供多种服务 输入插件,这些插件可能需要自定义端口。通过配置文件 (telegraf.conf) 修改端口映射。

对于 Linux 发行版,默认安装时此文件位于 /etc/telegraf

对于 Windows 发行版,配置文件位于您解压缩 Telegraf ZIP 存档的目录中。默认位置是 C:\InfluxData\telegraf

NTP

Telegraf 使用主机的本地 UTC 时间为数据分配时间戳。使用网络时间协议 (NTP) 同步主机之间的时间。如果主机的时钟未与 NTP 同步,则数据上的时间戳可能不准确。

下载并安装 Telegraf

推荐::在打开和安装软件包以及下载的文件之前,请使用 SHA 校验和验证和 GPG 签名验证,以确保文件完整且真实。

SHA 校验和与 GPG 签名验证是互补的检查。

对于某些 Linux 平台,安装说明 包括验证下载的软件包和二进制文件的步骤。

有关更多信息,请参阅以下内容

使用 SHA-256 验证下载完整性

使用 GPG 验证文件完整性和真实性

Debian 和 Ubuntu 用户可以使用 apt-get 软件包管理器安装最新稳定版本的 Telegraf。

从 InfluxData 存储库安装

运行以下使用 apt-get 的命令,从 InfluxData 存储库安装 Telegraf

curl --silent --location -O \
https://repos.influxdata.com/influxdata-archive.key \
&& echo "943666881a1b8d9b849b74caebf02d3465d6beb716510d86a39f6c8e8dac7515  influxdata-archive.key" \
| sha256sum -c - && cat influxdata-archive.key \
| gpg --dearmor \
| sudo tee /etc/apt/trusted.gpg.d/influxdata-archive.gpg > /dev/null \
&& echo 'deb [signed-by=/etc/apt/trusted.gpg.d/influxdata-archive.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
# influxdata-archive_compat.key GPG Fingerprint: 9D539D90D3328DC7D6C8D3B9D8FF8E1F7DF8B07E
curl --silent --location -O \
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

.deb 文件安装

要从 .deb 文件手动安装 Debian 软件包

  1. 下载页面 下载最新的 Telegraf .deb 发行版。

  2. 运行以下命令(确保为下载的文件提供正确的版本号)

    sudo dpkg -i telegraf_1.34.1-1_amd64.deb
    

要了解如何从文件手动安装 RPM 软件包,请参阅 下载页面

要使用 yum 软件包管理器安装最新稳定版本的 Telegraf,请按照以下步骤操作

  1. 在您的终端中,输入以下命令以将 InfluxData 存储库添加到 yum 配置

    cat <<EOF | sudo tee /etc/yum.repos.d/influxdata.repo
    [influxdata]
    name = InfluxData Repository - Stable
    baseurl = https://repos.influxdata.com/stable/$basearch/main
    enabled = 1
    gpgcheck = 1
    gpgkey = file:///etc/pki/rpm-gpg/RPM-GPG-KEY-influxdata
    EOF
    
  2. 输入以下命令以从存储库安装 telegraf

    sudo yum install telegraf
    

telegraf 配置文件安装在 /etc/telegraf/telegraf.conf

openSUSE Build Service 为 SUSE Linux 提供 RPM 软件包。

要使用 zypper 软件包管理器安装最新稳定版本的 Telegraf,请按照以下步骤操作

  1. 在您的终端中,输入以下命令以将 Go 存储库添加到 zypper 配置

    # add go repository
    zypper ar -f obs://devel:languages:go/ go
    
  2. 输入以下命令以安装 telegraf

    # install latest telegraf
    zypper in telegraf
    

Telegraf 是 FreeBSD 软件包系统的一部分。

要使用 pkg 软件包管理器安装最新稳定版本的 Telegraf,请输入以下命令

sudo pkg install telegraf

telegraf 配置文件安装在 /usr/local/etc/telegraf.conf。示例安装在 /usr/local/etc/telegraf.conf.sample

从以下选项中选择以安装适用于 Linux AMD 的 Telegraf 二进制文件

在 Linux AMD64 上下载并安装

curl -s --location -O \
https://dl.influxdata.com/telegraf/releases/telegraf-1.34.1_linux_amd64.tar.gz \
&& echo "21e781cc2352713e4eabf0931e3eeea640a2014850a33ea04f86b4dc288d6add  telegraf-1.34.1_linux_amd64.tar.gz" \
| sha256sum -c -

替换以下内容

  • 21e781cc2352713e4eabf0931e3eeea640a2014850a33ea04f86b4dc288d6add:来自 下载页面 的 SHA 校验和

从以下选项中选择以安装适用于 Linux ARM 的 Telegraf 二进制文件

在 Linux ARMv8 上下载并安装

curl -s --location -O \
https://dl.influxdata.com/telegraf/releases/telegraf-1.34.1_linux_arm64.tar.gz \
&& echo "7782bbcf50e67e73229fd0703c532d733e4fa259aa4b246debd012421f65c969  telegraf-1.34.1_linux_arm64.tar.gz" \
| sha256sum -c -

替换以下内容

  • 7782bbcf50e67e73229fd0703c532d733e4fa259aa4b246debd012421f65c969:来自 下载页面 的 SHA 校验和

从以下选项中选择以安装适用于 macOS 的 Telegraf

使用 Homebrew 安装

macOS 10.8 及更高版本的用户可以使用 Homebrew 软件包管理器安装 Telegraf。

Homebrew 安装的 telegraf 二进制文件与 下载页面 提供的 macOS .dmg 构建版本不同。

  • telegraf (Homebrew) 不是静态二进制文件。
  • telegraf (Homebrew) 可以与 Telegraf CPU 插件配合使用(由于 Homebrew 支持 Cgo)。下载页面 提供的 .dmg 构建版本不支持 CPU 插件。

要使用 Homebrew 安装,请执行以下操作

  1. 如果您尚未安装,请按照说明安装 Homebrew 软件包管理器。

  2. 输入以下命令以更新 brew 并安装 Telegraf

    brew update && brew install telegraf
    

    brew 安装 telegraf.conf 配置文件的路径取决于您的系统架构

    • 基于 ARM (Apple Silicon) 的系统: /opt/homebrew/etc/telegraf.conf
    • 基于 Intel (x86_64) 的系统: /usr/local/etc/telegraf.conf
  3. 选择以下方法之一来启动 Telegraf 并开始收集和处理指标

在您的终端中运行 Telegraf

要在您的终端中运行 telegraf(在前台而不是作为服务),请输入以下命令

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

将 Telegraf 作为后台服务运行

在您的终端中,输入以下命令以将 telegraf 添加到系统的 LaunchAgents

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

下次您登录时,launchd 将启动 telegraf 服务。

要立即启动 telegraf 服务,请输入以下命令

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

下载并以 Windows 服务形式运行 Telegraf

安装 Windows 服务需要管理员权限。要以管理员身份运行 PowerShell,请参阅 以管理员权限启动 PowerShell

在 PowerShell 中以管理员身份,执行以下操作

  1. 使用以下命令下载 Telegraf Windows 二进制文件并将其内容提取到 C:\Program Files\InfluxData\telegraf\

    wget `
    https://dl.influxdata.com/telegraf/releases/telegraf-1.34.1_windows_amd64.zip `
    -UseBasicParsing `
    -OutFile telegraf-1.34.1_windows_amd64.zip
    Expand-Archive .\telegraf-1.34.1_windows_amd64.zip `
    -DestinationPath 'C:\Program Files\InfluxData\telegraf\'
    
  2. 选择以下步骤之一,将您的 telegraf.exetelegraf.conf 文件放置在 C:\Program Files\InfluxData\telegraf

    • telegraf.exetelegraf.conf 文件从 C:\Program Files\InfluxData\telegraf\telegraf-1.34.1 移动到父目录 C:\Program Files\InfluxData\telegraf——例如

      cd "C:\Program Files\InfluxData\telegraf";
      mv .\telegraf-1.34.1\telegraf.* .
      
    • 或者,为 C:\Program Files\InfluxData\telegraf 创建一个 Windows 符号链接 (Symlink),指向提取的目录。

以下说明假设 telegraf.exetelegraf.conf 文件存储在 C:\Program Files\InfluxData\telegraf 中,或者您创建了一个指向此目录的 Symlink。

  1. 可选:启用插件以收集 Windows 特定指标——例如,取消注释 inputs.win_services 插件 配置行

    ...
    # # Input plugin to report Windows services info.
    # # This plugin ONLY supports Windows
    [[inputs.win_services]]
    ...
    
  2. 运行以下命令以将 Telegraf 和配置安装为 Windows 服务。对于 --config 选项,传递 telegraf.conf 配置文件的绝对路径。

    .\telegraf.exe --service install `
    --config "C:\Program Files\InfluxData\telegraf\telegraf.conf"
    
  3. 要测试安装是否有效,请输入以下命令

    .\telegraf.exe `
    --config C:\"Program Files"\InfluxData\telegraf\telegraf.conf --test
    

    在测试模式下运行(使用 --test 标志)时,Telegraf 运行一次,收集指标,将其输出到控制台,然后退出。它不运行处理器、聚合器或输出插件。

  4. 要开始收集数据,请运行

    .\telegraf.exe --service start
    

日志记录和故障排除

当 Telegraf 作为 Windows 服务运行时,Telegraf 会将消息记录到 Windows 事件日志中。如果 Telegraf 服务启动失败,请通过选择 事件查看器Windows 日志应用程序 查看错误日志。

Windows 服务命令

以下命令可用

命令效果
telegraf.exe --service install将 telegraf 安装为服务
telegraf.exe --service uninstall移除 telegraf 服务
telegraf.exe --service start启动 telegraf 服务
telegraf.exe --service stop停止 telegraf 服务

生成配置文件

telegraf config 命令允许您从 Telegraf 的 插件列表 生成配置文件。

创建具有默认输入和输出插件的配置文件

要生成启用默认输入和输出插件的配置文件,请在终端中输入以下命令

telegraf config > telegraf.conf
.\telegraf.exe config > telegraf.conf

创建具有特定输入和输出插件的配置文件

要生成仅包含特定插件设置的配置文件,请使用 --input-filter--output-filter 选项来指定 输入插件输出插件——例如

telegraf \
--input-filter 
cpu
:
http
\
--output-filter
influxdb_v2
:
file
\
config > telegraf.conf
.\telegraf.exe `
--input-filter 
cpu
:
http
`
--output-filter
influxdb_v2
:
file
`
config > telegraf.conf

有关更高级的配置详细信息,请参阅 配置文档

自定义编译 Telegraf

使用 Telegraf 自定义构建器工具编译 Telegraf,仅包含您需要的插件,并减小 Telegraf 二进制文件的大小。

  1. 先决条件
  2. 构建自定义构建器工具
  3. 运行自定义构建器以创建 telegraf 二进制文件

先决条件

构建自定义构建器工具

  1. 克隆 Telegraf 存储库,然后更改到存储库目录——例如,在您的终端中输入以下命令

    git clone https://github.com/influxdata/telegraf.git && cd ./telegraf
    
  2. 要构建 Telegraf 自定义构建器工具,请输入以下命令

    make build_tools
    

运行自定义构建器以创建 telegraf 二进制文件

自定义构建器构建一个 telegraf 二进制文件,其中仅包含指定配置文件或目录中包含的插件。

运行 custom_builder 工具,并至少使用一个 --config--config-directory 标志来指定要从中构建的 Telegraf 配置文件。

  • --config:接受本地文件路径和 URL。
  • --config-dir:接受本地目录路径。

您可以包含多个 --config--config-dir 标志。

示例

单个 Telegraf 配置
./tools/custom_builder/custom_builder --config /etc/telegraf.conf
单个 Telegraf 配置和 Telegraf 配置目录
./tools/custom_builder/custom_builder \
--config /etc/telegraf.conf \
--config-dir /etc/telegraf/telegraf.d
远程 Telegraf 配置
./tools/custom_builder/custom_builder \
--config http://url-to-remote-telegraf/telegraf.conf

成功构建后,您可以在 Telegraf 存储库的顶层查看自定义的 telegraf 二进制文件。

更新您的自定义二进制文件

要从自定义 Telegraf 构建中添加或删除插件,请编辑您的配置文件,然后 运行自定义构建器 以重新生成 Telegraf 二进制文件。


此页面对您有帮助吗?

感谢您的反馈!


Flux 的未来

Flux 即将进入维护模式。您可以继续像现在这样使用它,而无需对您的代码进行任何更改。

阅读更多

现已全面上市

InfluxDB 3 Core 和 Enterprise

快速启动。更快扩展。

获取更新

InfluxDB 3 Core 是一个开源、高速的最新数据引擎,可实时收集和处理数据,并将其持久化到本地磁盘或对象存储。InfluxDB 3 Enterprise 构建在 Core 的基础上,增加了高可用性、读取副本、增强的安全性以及数据压缩,以实现更快的查询和优化的存储。InfluxDB 3 Enterprise 的免费层可供非商业家庭或业余爱好者使用。

有关更多信息,请查看