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
Что это такое?Telegraf — агент с открытым исходным кодом для сбора, обработки и агрегации метрик, логов и других произвольных данных с последующей их записью. В комплекте больше 300 плагинов, покрывающих мониторинг системы, облачные сервисы и очереди сообщений.
То есть это один агент, который я ставлю на каждую машину, за которой хочу следить?Да — он собирается в самостоятельный статический бинарник без внешних зависимостей, так что развёртывание сводится к тому, чтобы положить один бинарник на каждую машину и направить его выводы в свой бэкенд.
Как его запустить?Установите бинарную сборку, Docker-образ или RPM/DEB-пакет по руководству по установке, затем напишите TOML-конфиг со списком плагинов и запустите — агент собирает данные с плагинов ввода на каждом интервале и отправляет их в плагины вывода на каждом интервале сброса (flush).
Там есть дашборд, или всё делается через конфиги?Про какой-либо интерфейс не упоминается — всё описывается в TOML-конфиге, который передаётся агенту. Формат TOML задуман как понятный и однозначный, но это всё равно просто текстовые файлы.
Он работает и на Windows-серверах, или только на Linux?Он кроссплатформенный: публикуются бинарники, Docker-образы и RPM/DEB-пакеты, а ещё есть отдельное семейство плагинов для Windows — Event Log, Management Instrumentation (WMI) и Performance Counters.
Из каких источников данных он умеет собирать информацию сразу, без настройки?Больше 300 плагинов: системная статистика (CPU, память, диск, сеть, SMART, Docker, Nvidia SMI), устройства (OPC UA, Modbus), логи (file, tail, directory monitor), очереди сообщений (Kafka, MQTT, AMQP), мониторинг (OpenTelemetry, Prometheus), сеть (Cisco Telemetry MDT, gNMI), плюс SNMP, SQL, HTTP и Windows Event Log.
Мне обязательно использовать InfluxDB в качестве бэкенда?В README нет такого требования — плагины вывода вы выбираете сами. Telegraf разработан компанией InfluxData, и если вы впервые сталкиваетесь и с тем, и с другим, InfluxDB University предлагает бесплатные курсы.
Как разобраться в настройках конкретного плагина?У каждого плагина есть свой README в каталоге /plugins, где описано, как его настроить, использовать, а иногда и отладить или найти неполадку; общая документация лежит в папке /docs.
Creator
influxdata
Size
85.4 MB
Stars
17.9K
Age
11y
Commits · 90 Days