2021-08-04 05:03:33 +08:00
# Telegraf
2022-03-28 23:47:02 +08:00
2021-08-04 05:03:33 +08:00
2022-09-07 20:59:38 +08:00
[](https://github.com/influxdata/telegraf/blob/master/CONTRIBUTING.md) [](https://www.influxdata.com/slack) [](https://circleci.com/gh/influxdata/telegraf) [](https://godoc.org/github.com/influxdata/telegraf) [](https://hub.docker.com/_/telegraf/) [](https://goreportcard.com/report/github.com/influxdata/telegraf)
2015-05-20 13:26:13 +08:00
2021-10-21 04:05:57 +08:00
Telegraf is an agent for collecting, processing, aggregating, and writing metrics. Based on a
plugin system to enable developers in the community to easily add support for additional
metric collection. There are four distinct types of plugins:
2016-11-04 22:12:22 +08:00
2021-09-22 01:39:48 +08:00
1. [Input Plugins ](/docs/INPUTS.md ) collect metrics from the system, services, or 3rd party APIs
2. [Processor Plugins ](/docs/PROCESSORS.md ) transform, decorate, and/or filter metrics
3. [Aggregator Plugins ](/docs/AGGREGATORS.md ) create aggregate metrics (e.g. mean, min, max, quantiles, etc.)
4. [Output Plugins ](/docs/OUTPUTS.md ) write metrics to various destinations
2016-11-04 22:12:22 +08:00
2021-10-21 04:05:57 +08:00
New plugins are designed to be easy to contribute, pull requests are welcomed, and we work to
incorporate as many pull requests as possible. Consider looking at the
[list of external plugins ](EXTERNAL_PLUGINS.md ) as well.
2017-05-10 04:44:34 +08:00
2019-12-05 09:16:00 +08:00
## Minimum Requirements
Telegraf shares the same [minimum requirements][] as Go:
2021-10-21 04:05:57 +08:00
2019-12-05 09:16:00 +08:00
- Linux kernel version 2.6.23 or later
- Windows 7 or later
- FreeBSD 11.2 or later
- MacOS 10.11 El Capitan or later
[minimum requirements]: https://github.com/golang/go/wiki/MinimumRequirements#minimum-requirements
2021-10-21 04:05:57 +08:00
## Obtaining Telegraf
View the [changelog ](/CHANGELOG.md ) for the latest updates and changes by version.
### Binary Downloads
Binary downloads are available from the [InfluxData downloads ](https://www.influxdata.com/downloads )
page or from each [GitHub Releases ](https://github.com/influxdata/telegraf/releases ) page.
2015-05-20 13:26:13 +08:00
2021-10-21 04:05:57 +08:00
### Package Repository
2016-03-17 23:53:55 +08:00
2021-10-21 04:05:57 +08:00
InfluxData also provides a package repo that contains both DEB and RPM downloads.
2016-01-31 02:53:17 +08:00
2021-10-27 21:11:43 +08:00
For deb-based platforms (e.g. Ubuntu and Debian) run the following to add the
repo key and setup a new sources.list entry:
2021-10-21 04:05:57 +08:00
```shell
2023-01-26 17:55:12 +08:00
# influxdata-archive_compat.key GPG fingerprint:
# 9D53 9D90 D332 8DC7 D6C8 D3B9 D8FF 8E1F 7DF8 B07E
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
2021-10-27 21:11:43 +08:00
sudo apt-get update & & sudo apt-get install telegraf
2021-10-21 04:05:57 +08:00
```
2021-10-27 21:11:43 +08:00
For RPM-based platforms (e.g. RHEL, CentOS) use the following to create a repo
file and install telegraf:
2021-10-21 04:05:57 +08:00
2021-10-27 21:11:43 +08:00
```shell
2023-01-26 17:55:12 +08:00
# influxdata-archive_compat.key GPG fingerprint:
# 9D53 9D90 D332 8DC7 D6C8 D3B9 D8FF 8E1F 7DF8 B07E
2022-03-31 21:25:07 +08:00
cat < < EOF | sudo tee / etc / yum . repos . d / influxdata . repo
[influxdata]
name = InfluxData Repository - Stable
baseurl = https://repos.influxdata.com/stable/\$basearch/main
2021-10-21 04:05:57 +08:00
enabled = 1
gpgcheck = 1
2023-01-26 17:55:12 +08:00
gpgkey = https://repos.influxdata.com/influxdata-archive_compat.key
2021-10-27 21:11:43 +08:00
EOF
sudo yum install telegraf
2021-10-21 04:05:57 +08:00
```
2016-01-31 02:53:17 +08:00
2021-10-21 04:05:57 +08:00
### Build From Source
2015-08-19 00:16:59 +08:00
2023-08-29 04:30:44 +08:00
Telegraf requires Go version 1.21 or newer and the Makefile requires GNU make.
2017-07-22 02:15:00 +08:00
2022-08-04 06:50:23 +08:00
On Windows, the makefile requires the use of a bash terminal to support all makefile targets.
An easy option to get bash for windows is using the version that comes with [git for windows ](https://gitforwindows.org/ ).
2023-03-16 00:51:32 +08:00
1. [Install Go ](https://golang.org/doc/install )
2020-01-17 06:38:06 +08:00
2. Clone the Telegraf repository:
2021-11-03 04:03:24 +08:00
```shell
2020-01-17 06:38:06 +08:00
git clone https://github.com/influxdata/telegraf.git
2018-07-25 05:57:24 +08:00
```
2021-11-03 04:03:24 +08:00
2022-08-04 06:50:23 +08:00
3. Run `make build` from the source directory
2021-11-03 04:03:24 +08:00
```shell
2021-10-21 04:05:57 +08:00
cd telegraf
2022-08-04 06:50:23 +08:00
make build
2018-07-25 05:57:24 +08:00
```
2015-08-19 00:16:59 +08:00
2017-08-24 06:42:25 +08:00
### Nightly Builds
2021-09-17 01:22:24 +08:00
[Nightly ](/docs/NIGHTLIES.md ) builds are available, generated from the master branch.
2021-05-13 09:20:04 +08:00
2021-09-17 02:14:41 +08:00
### 3rd Party Builds
2021-10-21 04:05:57 +08:00
Builds for other platforms or package formats are provided by members of theTelegraf community.
These packages are not built, tested, or supported by the Telegraf project or InfluxData. Please
get in touch with the package author if support is needed:
2021-09-17 02:14:41 +08:00
2021-10-21 04:05:57 +08:00
- [Ansible Role ](https://github.com/rossmcdonald/telegraf )
- [Chocolatey ](https://chocolatey.org/packages/telegraf ) by [ripclawffb ](https://chocolatey.org/profiles/ripclawffb )
- [Scoop ](https://github.com/ScoopInstaller/Main/blob/master/bucket/telegraf.json )
- [Snap ](https://snapcraft.io/telegraf ) by Laurent Sesquès (sajoupa)
2022-11-14 22:53:24 +08:00
- [Homebrew ](https://formulae.brew.sh/formula/telegraf#default )
2021-09-17 02:14:41 +08:00
2021-10-21 04:05:57 +08:00
## Getting Started
2015-06-20 09:53:35 +08:00
2016-10-25 20:47:38 +08:00
See usage with:
2016-01-08 06:21:10 +08:00
2021-10-21 04:05:57 +08:00
```shell
2018-09-18 02:45:08 +08:00
telegraf --help
2016-10-25 20:47:38 +08:00
```
2016-01-08 06:21:10 +08:00
2021-11-03 04:03:24 +08:00
### Generate a telegraf config file
2016-01-08 06:21:10 +08:00
2021-10-21 04:05:57 +08:00
```shell
2018-09-18 02:45:08 +08:00
telegraf config > telegraf.conf
2016-10-25 20:47:38 +08:00
```
2016-01-08 06:21:10 +08:00
2021-11-03 04:03:24 +08:00
### Generate config with only cpu input & influxdb output plugins defined
2016-10-05 20:53:43 +08:00
2021-10-21 04:05:57 +08:00
```shell
2022-06-16 03:28:18 +08:00
telegraf config --section-filter agent:inputs:outputs --input-filter cpu --output-filter influxdb
2016-10-25 20:47:38 +08:00
```
2016-01-08 06:21:10 +08:00
2021-11-03 04:03:24 +08:00
### Run a single telegraf collection, outputting metrics to stdout
2016-01-08 06:21:10 +08:00
2021-10-21 04:05:57 +08:00
```shell
2018-09-18 02:45:08 +08:00
telegraf --config telegraf.conf --test
2016-10-25 20:47:38 +08:00
```
2016-01-08 06:21:10 +08:00
2021-11-03 04:03:24 +08:00
### Run telegraf with all plugins defined in config file
2016-01-08 06:21:10 +08:00
2021-10-21 04:05:57 +08:00
```shell
2018-09-18 02:45:08 +08:00
telegraf --config telegraf.conf
2016-10-25 20:47:38 +08:00
```
2016-01-08 06:21:10 +08:00
2021-11-03 04:03:24 +08:00
### Run telegraf, enabling the cpu & memory input, and influxdb output plugins
2016-01-08 06:21:10 +08:00
2021-10-21 04:05:57 +08:00
```shell
2018-09-18 02:45:08 +08:00
telegraf --config telegraf.conf --input-filter cpu:mem --output-filter influxdb
2016-10-25 20:47:38 +08:00
```
2022-03-28 23:47:02 +08:00
## Contribute to the Project
Telegraf is an MIT licensed open source project and we love our community. The fastest way to get something fixed is to open a PR. Check out our [contributing guide ](CONTRIBUTING.md ) if you're interested in helping out. Also, join us on our [Community Slack ](https://influxdata.com/slack ) or [Community Page ](https://community.influxdata.com/ ) if you have questions or comments for our engineering teams.
If your completely new to Telegraf and InfluxDB, you can also enroll for free at [InfluxDB university ](https://www.influxdata.com/university/ ) to take courses to learn more.
2018-09-18 02:45:08 +08:00
## Documentation
2021-11-04 02:41:07 +08:00
[Latest Release Documentation ](https://docs.influxdata.com/telegraf/latest/ )
2015-05-20 13:26:13 +08:00
2021-09-22 01:39:48 +08:00
For documentation on the latest development code see the [documentation index ](/docs ).
2015-12-01 22:15:28 +08:00
2021-09-22 01:39:48 +08:00
- [Input Plugins ](/docs/INPUTS.md )
- [Output Plugins ](/docs/OUTPUTS.md )
- [Processor Plugins ](/docs/PROCESSORS.md )
- [Aggregator Plugins ](/docs/AGGREGATORS.md )
