telegraf README

The project's README from github.com/influxdata/telegraf. As one markdown file: README.md.

tiger Telegraf

GoDoc Docker pulls Go Report Card Circle CI

Telegraf is an agent for collecting, processing, aggregating, and writing metrics, logs, and other arbitrary data.

Users can choose plugins from a wide range of topics, including but not limited to:

🔨 Installation

For binary builds, Docker images, RPM & DEB packages, and other builds of Telegraf, please see the install guide.

See the releases documentation for details on versioning and when releases are made.

💻 Usage

Users define a TOML configuration with the plugins and settings they wish to use, then pass that configuration to Telegraf. The Telegraf agent then collects data from inputs at each interval and sends data to outputs at each flush interval.

For a basic walkthrough see quick start.

📖 Documentation

For a full list of documentation including tutorials, reference and other material, start with the /docs directory.

Additionally, each plugin has its own README that includes details about how to configure, use, and sometimes debug or troubleshoot. Look under the /plugins directory for specific plugins.

Here are some commonly used documents:

❤️ Contribute

Contribute

We love our community of over 1,200 contributors! Many of the plugins included in Telegraf were originally contributed by community members. Check out our contributing guide if you are interested in helping out. Also, join us on our Community Slack or Community Forums if you have questions or comments for our engineering teams.

If you are completely new to Telegraf and InfluxDB, you can also enroll for free at InfluxDB university to take courses to learn more.

ℹ️ Support

Slack Forums

Please use the Community Slack or Community Forums if you have questions or comments for our engineering teams. GitHub issues are limited to actual issues and feature requests only.

📜 License

MIT

telegraf (influxdata/telegraf)

Searching Database…

17.9K ·GitHub
What is this?Telegraf is an open-source agent for collecting, processing, aggregating, and writing metrics, logs, and other arbitrary data. It ships with 300+ plugins covering system monitoring, cloud services, and messaging.
So it's one agent I install on every machine I want to watch?Yes — it compiles into a standalone static binary with no external dependencies, so deploying it is just dropping one binary on each machine and pointing its outputs at your backend.
How do I get it running?Install a binary build, Docker image, or RPM/DEB package from the install guide, then write a TOML config listing your plugins and run it — the agent collects from inputs at each interval and flushes to outputs at each flush interval.
Is there a dashboard, or is everything done through config files?There is no UI mentioned — you describe everything in a TOML config file and hand it to the agent. The TOML setup is designed to be user-friendly and unambiguous, but it is all text files.
Does it run on Windows servers too, or is it Linux-only?It runs cross-platform: binaries, Docker images, and RPM/DEB packages are published, and there is a dedicated Windows plugin family — Event Log, Management Instrumentation (WMI), and Performance Counters.
What kinds of data sources can it pull from out of the box?Over 300 plugins: system stats (CPU, memory, disk, network, SMART, Docker, Nvidia SMI), devices (OPC UA, Modbus), logs (file, tail, directory monitor), messaging (Kafka, MQTT, AMQP), monitoring (OpenTelemetry, Prometheus), networking (Cisco Telemetry MDT, gNMI), plus SNMP, SQL, HTTP, and Windows Event Log.
Do I have to use InfluxDB as the backend?Nothing in the README requires it — outputs are plugins you pick yourself. Telegraf comes from InfluxData, and if you are completely new to both, InfluxDB University offers free courses.
How do I figure out the settings for a particular plugin?Each plugin has its own README under the /plugins directory covering how to configure, use, and sometimes debug or troubleshoot it; the /docs folder holds the general documentation.
Creator
influxdata
Size
86.1 MB
Stars
17.9K
Age
11y
Commits · 90 Days