-
Notifications
You must be signed in to change notification settings - Fork 314
Add detailed plugin documentation for Telegraf v1.36.1 #6408
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
👍 |
Sorry, I just noticed this typo and also made some style fixes: #6416 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR adds detailed plugin descriptions for Telegraf v1.36.1, making navigation to GitHub superfluous by providing comprehensive documentation for input plugins directly in the documentation.
- Adds detailed plugin pages for 30+ input plugins across various categories (hardware, system, network, applications, containers, etc.)
- Each plugin page includes standardized sections: introduction, configuration, metrics, and example output
- Provides consistent documentation structure with plugin metadata, requirements, and usage examples
Reviewed Changes
Copilot reviewed 116 out of 352 changed files in this pull request and generated no comments.
Show a summary per file
File | Description |
---|---|
content/telegraf/v1/input-plugins/leofs/_index.md | Comprehensive documentation for LeoFS input plugin with metrics collection via SNMP |
content/telegraf/v1/input-plugins/ldap/_index.md | Complete LDAP monitoring plugin documentation for OpenLDAP and 389ds servers |
content/telegraf/v1/input-plugins/lanz/_index.md | Arista LANZ Consumer plugin documentation for network latency monitoring |
content/telegraf/v1/input-plugins/kubernetes/_index.md | Kubernetes metrics collection plugin with kubelet API integration |
content/telegraf/v1/input-plugins/kube_inventory/_index.md | Kubernetes inventory plugin for resource monitoring across clusters |
content/telegraf/v1/input-plugins/knx_listener/_index.md | KNX home automation bus listener plugin documentation |
content/telegraf/v1/input-plugins/kinesis_consumer/_index.md | AWS Kinesis data stream consumer plugin configuration |
content/telegraf/v1/input-plugins/kafka_consumer/_index.md | Apache Kafka consumer plugin with comprehensive configuration options |
content/telegraf/v1/input-plugins/jti_openconfig_telemetry/_index.md | Juniper Telemetry Interface OpenConfig plugin documentation |
content/telegraf/v1/input-plugins/jolokia2_proxy/_index.md | Jolokia2 proxy plugin for JMX metrics collection |
content/telegraf/v1/input-plugins/jolokia2_agent/_index.md | Jolokia2 agent plugin with detailed JMX configuration examples |
content/telegraf/v1/input-plugins/jenkins/_index.md | Jenkins monitoring plugin for nodes and jobs metrics |
content/telegraf/v1/input-plugins/ipvs/_index.md | IPVS virtual server metrics collection via netlink |
content/telegraf/v1/input-plugins/iptables/_index.md | Iptables firewall metrics collection with permissions setup |
content/telegraf/v1/input-plugins/ipset/_index.md | Linux IP sets monitoring plugin documentation |
content/telegraf/v1/input-plugins/ipmi_sensor/_index.md | IPMI sensor monitoring with comprehensive hardware support |
content/telegraf/v1/input-plugins/interrupts/_index.md | System interrupts monitoring from /proc/interrupts |
content/telegraf/v1/input-plugins/internet_speed/_index.md | Internet speed monitoring using speedtest.net service |
content/telegraf/v1/input-plugins/internal/_index.md | Telegraf internal metrics collection plugin |
content/telegraf/v1/input-plugins/intel_rdt/_index.md | Intel Resource Director Technology monitoring plugin |
content/telegraf/v1/input-plugins/intel_powerstat/_index.md | Comprehensive Intel PowerStat plugin with extensive CPU model support |
content/telegraf/v1/input-plugins/intel_pmu/_index.md | Intel Performance Monitoring Unit plugin for hardware counters |
content/telegraf/v1/input-plugins/intel_pmt/_index.md | Intel Platform Monitoring Technology plugin with detailed metrics table |
content/telegraf/v1/input-plugins/intel_dlb/_index.md | Intel Dynamic Load Balancer plugin for DPDK applications |
content/telegraf/v1/input-plugins/intel_baseband/_index.md | Intel Baseband Accelerator plugin for 5G/4G vRAN workloads |
content/telegraf/v1/input-plugins/influxdb_v2_listener/_index.md | InfluxDB v2 HTTP API listener plugin documentation |
content/telegraf/v1/input-plugins/kibana/_index.md | Kibana monitoring plugin with service status metrics |
content/telegraf/v1/input-plugins/kernel_vmstat/_index.md | Linux kernel virtual memory statistics collection |
content/telegraf/v1/input-plugins/kernel/_index.md | Linux kernel metrics including entropy, KSM, and PSI |
content/telegraf/v1/input-plugins/kapacitor/_index.md | Comprehensive Kapacitor monitoring with detailed field descriptions |
Closes #
This PR adds detailed plugin descriptions for Telegraf making navigation to Github superfluous.
@jstirnaman with this being merged, maybe it would be useful to add a direct link to the plugins in the short plugin-list to directly navigate to these pages?
(if necessary)