github.com/influxdata/telegraf@v1.30.3/README.md (about)

     1  # ![tiger](assets/TelegrafTigerSmall.png "tiger") Telegraf
     2  
     3  [![GoDoc](https://img.shields.io/badge/doc-reference-00ADD8.svg?logo=go)](https://godoc.org/github.com/influxdata/telegraf)  [![Docker pulls](https://img.shields.io/docker/pulls/library/telegraf.svg)](https://hub.docker.com/_/telegraf/) [![Go Report Card](https://goreportcard.com/badge/github.com/influxdata/telegraf)](https://goreportcard.com/report/github.com/influxdata/telegraf) [![Circle CI](https://circleci.com/gh/influxdata/telegraf.svg?style=svg)](https://circleci.com/gh/influxdata/telegraf)
     4  
     5  Telegraf is an agent for collecting, processing, aggregating, and writing
     6  metrics, logs, and other arbitrary data.
     7  
     8  * Offers a comprehensive suite of over 300 plugins, covering a wide range of
     9    functionalities including system monitoring, cloud services, and message
    10    passing
    11  * Enables the integration of user-defined code to collect, transform, and
    12    transmit data efficiently
    13  * Compiles into a standalone static binary without any external dependencies,
    14    ensuring a streamlined deployment process
    15  * Utilizes TOML for configuration, providing a user-friendly and unambiguous
    16    setup experience
    17  * Developed with contributions from a diverse community of over 1,200
    18    contributors
    19  
    20  Users can choose plugins from a wide range of topics, including but not limited
    21  to:
    22  
    23  * Devices: [OPC UA][], [Modbus][]
    24  * Logs: [File][], [Tail][], [Directory Monitor][]
    25  * Messaging: [AMQP][], [Kafka][], [MQTT][]
    26  * Monitoring: [OpenTelemetry][], [Prometheus][]
    27  * Networking: [Cisco TelemetryMDT][], [gNMI][]
    28  * System monitoring: [CPU][], [Memory][], [Disk][], [Network][], [SMART][],
    29    [Docker][], [Nvidia SMI][], etc.
    30  * Universal: [Exec][], [HTTP][], [HTTP Listener][], [SNMP][], [SQL][]
    31  * Windows: [Event Log][], [Management Instrumentation][],
    32    [Performance Counters][]
    33  
    34  ## 🔨 Installation
    35  
    36  For binary builds, Docker images, RPM & DEB packages, and other builds of
    37  Telegraf, please see the [install guide](/docs/INSTALL_GUIDE.md).
    38  
    39  See the [releases documentation](/docs/RELEASES.md) for details on versioning
    40  and when releases are made.
    41  
    42  ## đŸ’ģ Usage
    43  
    44  Users define a TOML configuration with the plugins and settings they wish to
    45  use, then pass that configuration to Telegraf. The Telegraf agent then
    46  collects data from inputs at each interval and sends data to outputs at each
    47  flush interval.
    48  
    49  For a basic walkthrough see [quick start](/docs/QUICK_START.md).
    50  
    51  ## 📖 Documentation
    52  
    53  For a full list of documentation including tutorials, reference and other
    54  material, start with the [/docs directory](/docs/README.md).
    55  
    56  Additionally, each plugin has its own README that includes details about how to
    57  configure, use, and sometimes debug or troubleshoot. Look under the
    58  [/plugins directory](/plugins/) for specific plugins.
    59  
    60  Here are some commonly used documents:
    61  
    62  * [Changelog](/CHANGELOG.md)
    63  * [Configuration](/docs/CONFIGURATION.md)
    64  * [FAQ](/docs/FAQ.md)
    65  * [Releases](https://github.com/influxdata/telegraf/releases)
    66  * [Security](/SECURITY.md)
    67  
    68  ## ❤ī¸ Contribute
    69  
    70  [![Contribute](https://img.shields.io/badge/contribute-to_telegraf-blue.svg?logo=influxdb)](https://github.com/influxdata/telegraf/blob/master/CONTRIBUTING.md)
    71  
    72  We love our community of over 1,200 contributors! Many of the plugins included
    73  in Telegraf were originally contributed by community members. Check out
    74  our [contributing guide](CONTRIBUTING.md) if you are interested in helping out.
    75  Also, join us on our [Community Slack](https://influxdata.com/slack) or
    76  [Community Forums](https://community.influxdata.com/) if you have questions or
    77  comments for our engineering teams.
    78  
    79  If you are completely new to Telegraf and InfluxDB, you can also enroll for free at
    80  [InfluxDB university](https://www.influxdata.com/university/) to take courses to
    81  learn more.
    82  
    83  ## ℹī¸ Support
    84  
    85  [![Slack](https://img.shields.io/badge/slack-join_chat-blue.svg?logo=slack)](https://www.influxdata.com/slack) [![Forums](https://img.shields.io/badge/discourse-join_forums-blue.svg?logo=discourse)](https://community.influxdata.com/)
    86  
    87  Please use the [Community Slack](https://influxdata.com/slack) or
    88  [Community Forums](https://community.influxdata.com/) if you have questions or
    89  comments for our engineering teams. GitHub issues are limited to actual issues
    90  and feature requests only.
    91  
    92  ## 📜 License
    93  
    94  [![MIT](https://img.shields.io/badge/license-MIT-blue)](https://github.com/influxdata/telegraf/blob/master/LICENSE)
    95  
    96  [OPC UA]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/opcua
    97  [Modbus]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/modbus
    98  [File]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/file
    99  [Tail]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/tail
   100  [Directory Monitor]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/directory_monitor
   101  [AMQP]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/amqp_consumer
   102  [Kafka]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/kafka_consumer
   103  [MQTT]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/mqtt_consumer
   104  [OpenTelemetry]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/opentelemetry
   105  [Prometheus]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/prometheus
   106  [Cisco TelemetryMDT]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/cisco_telemetry_mdt
   107  [gNMI]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/gnmi
   108  [CPU]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/cpu
   109  [Memory]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/mem
   110  [Disk]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/disk
   111  [Network]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/net
   112  [SMART]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/smartctl
   113  [Docker]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/docker
   114  [Nvidia SMI]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/nvidia_smi
   115  [Exec]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/exec
   116  [HTTP]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/http
   117  [HTTP Listener]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/http_listener_v2
   118  [SNMP]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/snmp
   119  [SQL]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/sql
   120  [Event Log]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/win_eventlog
   121  [Management Instrumentation]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/win_wmi
   122  [Performance Counters]: https://github.com/influxdata/telegraf/tree/master/plugins/inputs/win_perf_counters