chore(inputs): update dashboard and doc for inputs#1456
Open
kongfei605 wants to merge 7 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes input-plugin documentation and adds/updates companion Grafana/Nightingale dashboards across a wide set of Categraf inputs, aiming to make plugin usage and visualization more “out-of-the-box”.
Changes:
- Added many new
README.md/README_CN.mdfiles to document configuration, metrics, and usage notes for inputs. - Added many new
dashboard.jsonfiles providing basic reference dashboards per input. - Made a few targeted tweaks to existing docs/alerts (e.g., Redis alert threshold, formatting/section ordering in some READMEs).
Reviewed changes
Copilot reviewed 215 out of 216 changed files in this pull request and generated 13 comments.
Show a summary per file
| File | Description |
|---|---|
| inputs/xskyapi/README.md | Add English README for xskyapi input. |
| inputs/xskyapi/README_CN.md | Add Chinese README for xskyapi input. |
| inputs/xskyapi/dashboard.json | Add basic xskyapi capacity/status dashboard. |
| inputs/whois/README.md | Rewrite README to English + add guidance and dashboard note. |
| inputs/whois/README_CN.md | Add Chinese README for whois input. |
| inputs/whois/dashboard.json | Add domain expiry tracking dashboard. |
| inputs/weblogic/README.md | Expand WebLogic monitoring guidance (via Jolokia) + dashboard note. |
| inputs/weblogic/README_CN.md | Add Chinese README for WebLogic (via Jolokia). |
| inputs/weblogic/dashboard.json | Add minimal WebLogic via Jolokia dashboard. |
| inputs/vsphere/README.md | Add English README for vSphere input. |
| inputs/vsphere/README_CN.md | Add Chinese README for vSphere input. |
| inputs/tpl/README.md | Update template README to English with development steps. |
| inputs/tpl/README_CN.md | Add Chinese README for template plugin. |
| inputs/tpl/dashboard.json | Add placeholder dashboard for template plugin. |
| inputs/systemd/dashboard.json | Add systemd services dashboard. |
| inputs/supervisor/dashboard.json | Add supervisor process dashboard. |
| inputs/sqlserver/README.md | Modify SQL Server README (needs corrections per review). |
| inputs/sockstat/README_CN.md | Add Chinese README for sockstat input. |
| inputs/snmp/dashboard.json | Add SNMP base interfaces dashboard. |
| inputs/snmp_zabbix/dashboard.json | Add Zabbix SNMP template-style dashboard. |
| inputs/snmp_trap/README.md | Reorder/format fields-to-labels section in config example. |
| inputs/snmp_trap/dashboard.json | Add SNMP trap event dashboard. |
| inputs/smart/dashboard.json | Add S.M.A.R.T. disk health dashboard. |
| inputs/self_metrics/README.md | Add English README for self metrics input. |
| inputs/self_metrics/README_CN.md | Add Chinese README for self metrics input. |
| inputs/self_metrics/dashboard.json | Add Categraf self-monitoring dashboard. |
| inputs/rocketmq_offset/README.md | Add English README for RocketMQ offset input. |
| inputs/rocketmq_offset/README_CN.md | Add Chinese README for RocketMQ offset input. |
| inputs/rocketmq_offset/dashboard.json | Add RocketMQ consumer lag dashboard. |
| inputs/redis/alerts.json | Adjust Redis uptime alert threshold. |
| inputs/redis_sentinel/redis_sentinel.go | Formatting-only change (trailing newline/brace). |
| inputs/redis_sentinel/README.md | Add English README for Redis Sentinel input. |
| inputs/redis_sentinel/README_CN.md | Add Chinese README for Redis Sentinel input. |
| inputs/redis_sentinel/dashboard.json | Add Redis Sentinel status dashboard. |
| inputs/redfish/README.md | Add English README for Redfish input. |
| inputs/redfish/README_CN.md | Add Chinese README for Redfish input. |
| inputs/redfish/dashboard.json | Add Redfish temperature/power dashboard. |
| inputs/rabbitmq/README.md | Minor README wording/link formatting change. |
| inputs/prometheus/README_CN.md | Add Chinese README for prometheus input. |
| inputs/prometheus/dashboard.json | Add minimal prometheus “info” dashboard. |
| inputs/processes/README.md | Add English README for processes input. |
| inputs/processes/README_CN.md | Add Chinese README for processes input. |
| inputs/processes/dashboard.json | Add OS processes dashboard. |
| inputs/ping/README.md | Remove some explanatory/example output content. |
| inputs/phpfpm/README_CN.md | Add Chinese README for PHP-FPM input. |
| inputs/oracle/README.md | Remove ORA-01804 troubleshooting note. |
| inputs/nvidia_smi/README_CN.md | Add Chinese README for nvidia_smi input. |
| inputs/nvidia_smi/dashboard.json | Add NVIDIA GPU metrics dashboard. |
| inputs/nsq/README_CN.md | Add Chinese README for NSQ input. |
| inputs/node_exporter/README.md | Add English README for node_exporter input. |
| inputs/node_exporter/README_CN.md | Add Chinese README for node_exporter input. |
| inputs/nginx/README.md | Update nginx README formatting/content (needs markdown fixes per review). |
| inputs/nfsclient/README.md | Add English README for NFS client input. |
| inputs/nfsclient/README_CN.md | Add Chinese README for NFS client input. |
| inputs/netstat/README.md | Add English README for netstat input. |
| inputs/netstat/README_CN.md | Add Chinese README for netstat input. |
| inputs/netstat/dashboard.json | Add netstat connection-state dashboard. |
| inputs/netstat_filter/README_CN.md | Add Chinese README for netstat_filter input. |
| inputs/netstat_filter/dashboard.json | Add netstat_filter dashboard. |
| inputs/net/README.md | Add English README for net (interfaces) input. |
| inputs/net/README_CN.md | Add Chinese README for net (interfaces) input. |
| inputs/nats/README.md | Add English README for NATS input. |
| inputs/nats/README_CN.md | Add Chinese README for NATS input. |
| inputs/mtail/dashboard.json | Add mtail reference dashboard. |
| inputs/mongodb/README.md | Minor formatting/link text changes. |
| inputs/mem/README.md | Add English README for mem input. |
| inputs/mem/README_CN.md | Add Chinese README for mem input. |
| inputs/mem/dashboard.json | Add memory dashboard. |
| inputs/linux_sysctl_fs/README.md | Add English README for linux_sysctl_fs input. |
| inputs/linux_sysctl_fs/README_CN.md | Add Chinese README for linux_sysctl_fs input. |
| inputs/ldap/README_CN.md | Add Chinese README for ldap input. |
| inputs/kubernetes/README.md | Minor README link formatting change. |
| inputs/kubelet/README.md | Add Kubelet scraping guidance (needs config link fix per review). |
| inputs/kubelet/README_CN.md | Add Chinese Kubelet scraping guidance (needs config link fix per review). |
| inputs/kube_proxy/README.md | Add Kube-Proxy scraping guidance (needs config link fix per review). |
| inputs/kube_proxy/README_CN.md | Add Chinese Kube-Proxy scraping guidance (needs config link fix per review). |
| inputs/kernel/README.md | Add English README for kernel input. |
| inputs/kernel/README_CN.md | Add Chinese README for kernel input. |
| inputs/kernel/dashboard.json | Add kernel metrics dashboard. |
| inputs/kernel_vmstat/dashboard.json | Add kernel_vmstat dashboard. |
| inputs/kafka/README.md | Minor formatting change. |
| inputs/kafka_connect/README.md | Add English README for Kafka Connect (via Jolokia) + placeholder dashboard. |
| inputs/kafka_connect/README_CN.md | Add Chinese README for Kafka Connect (via Jolokia). |
| inputs/kafka_connect/dashboard.json | Add placeholder Kafka Connect dashboard. |
| inputs/jolokia/README.md | Add README clarifying shared library vs plugin. |
| inputs/jolokia/README_CN.md | Add Chinese README for Jolokia shared lib. |
| inputs/jolokia/dashboard.json | Add placeholder Jolokia shared-lib dashboard. |
| inputs/jolokia_proxy/README.md | Add English README for jolokia_proxy. |
| inputs/jolokia_proxy/README_CN.md | Add Chinese README for jolokia_proxy. |
| inputs/jolokia_proxy/dashboard.json | Add placeholder jolokia_proxy dashboard. |
| inputs/jolokia_agent/README.md | Add English README for jolokia_agent. |
| inputs/jolokia_agent/README_CN.md | Add Chinese README for jolokia_agent. |
| inputs/jolokia_agent/dashboard.json | Add placeholder jolokia_agent dashboard. |
| inputs/jenkins/README.md | Add English README for Jenkins input. |
| inputs/jenkins/README_CN.md | Add Chinese README for Jenkins input. |
| inputs/jboss/README.md | Add English README for JBoss (via Jolokia) + placeholder dashboard. |
| inputs/jboss/README_CN.md | Add Chinese README for JBoss (via Jolokia). |
| inputs/jboss/dashboard.json | Add placeholder JBoss dashboard. |
| inputs/ipvs/README_CN.md | Add Chinese README for IPVS input. |
| inputs/ipvs/dashboard.json | Add IPVS metrics dashboard. |
| inputs/huatuo/dashboard.json | Add placeholder Huatuo eBPF dashboard. |
| inputs/http_response/README.md | Add metric description section (Chinese) to README. |
| inputs/hadoop_hdfs/README.md | Add English README for HDFS (via Jolokia) (needs path fix per review). |
| inputs/hadoop_hdfs/README_CN.md | Add Chinese README for HDFS (via Jolokia). |
| inputs/hadoop_hdfs/dashboard.json | Add placeholder HDFS dashboard. |
| inputs/greenplum/README.md | Add English README for Greenplum input. |
| inputs/greenplum/README_CN.md | Add Chinese README for Greenplum input. |
| inputs/greenplum/dashboard.json | Add Greenplum mirror status dashboard. |
| inputs/googlecloud/README_CN.md | Add Chinese README for googlecloud input. |
| inputs/googlecloud/dashboard.json | Add placeholder googlecloud dashboard. |
| inputs/gnmi/dashboard.json | Add placeholder gNMI dashboard. |
| inputs/filecount/README.md | Minor formatting/link text change. |
| inputs/filecount/README_CN.md | Add Chinese README for filecount input. |
| inputs/filecount/dashboard.json | Add filecount dashboard. |
| inputs/exec/README_CN.md | Add Chinese README for exec input (needs spelling fix per review). |
| inputs/exec/dashboard.json | Add placeholder exec dashboard. |
| inputs/elasticsearch/README.md | Minor formatting fix + remove a config doc section. |
| inputs/docker/README_CN.md | Add Chinese README for docker input. |
| inputs/docker/dashboard.json | Add Docker containers dashboard. |
| inputs/dns_query/README_CN.md | Add Chinese README for dns_query input. |
| inputs/dns_query/dashboard.json | Add DNS query quality dashboard. |
| inputs/diskio/README.md | Add English README for diskio input. |
| inputs/diskio/README_CN.md | Add Chinese README for diskio input. |
| inputs/diskio/dashboard.json | Add DiskIO dashboard. |
| inputs/disk/README.md | Add English README for disk input. |
| inputs/disk/README_CN.md | Add Chinese README for disk input. |
| inputs/disk/dashboard.json | Add disk usage dashboard. |
| inputs/dcgm/README.md | Add English README for dcgm input. |
| inputs/dcgm/README_CN.md | Add Chinese README for dcgm input. |
| inputs/cpu/README.md | Add English README for cpu input. |
| inputs/cpu/README_CN.md | Add Chinese README for cpu input. |
| inputs/cpu/dashboard.json | Add CPU dashboard. |
| inputs/consul/README_CN.md | Add Chinese README for consul input. |
| inputs/conntrack/README.md | Add English README for conntrack input. |
| inputs/conntrack/README_CN.md | Add Chinese README for conntrack input. |
| inputs/conntrack/dashboard.json | Add conntrack dashboard. |
| inputs/cloudwatch/dashboard.json | Add AWS CloudWatch example dashboard. |
| inputs/clickhouse/README.md | Update clickhouse README (TLS path needs consistency fix per review). |
| inputs/clickhouse/dashboard.json | Add ClickHouse dashboard. |
| inputs/cassandra/README.md | Add English README for Cassandra (via Jolokia). |
| inputs/cassandra/README_CN.md | Add Chinese README for Cassandra (via Jolokia). |
| inputs/cadvisor/dashboard.json | Add cAdvisor dashboard. |
| inputs/bitbucket/README.md | Add English README for Bitbucket (via Jolokia). |
| inputs/bitbucket/README_CN.md | Add Chinese README for Bitbucket (via Jolokia). |
| inputs/bitbucket/dashboard.json | Add Bitbucket (Jolokia) dashboard. |
| inputs/bind/README.md | Add English README for BIND 9 input. |
| inputs/bind/README_CN.md | Add Chinese README for BIND 9 input. |
| inputs/arp_packet/README.md | Add English README for arp_packet input. |
| inputs/arp_packet/README_CN.md | Add Chinese README for arp_packet input. |
| inputs/arp_packet/dashboard.json | Add ARP packet dashboard. |
| inputs/appdynamics/README.md | Add English README for AppDynamics input. |
| inputs/appdynamics/README_CN.md | Add Chinese README for AppDynamics input. |
| inputs/appdynamics/dashboard.json | Add AppDynamics dashboard. |
| inputs/apache/README.md | Add English README for Apache input. |
| inputs/apache/README_CN.md | Add Chinese README for Apache input. |
| inputs/amd_rocm_smi/README_CN.md | Add Chinese README for amd_rocm_smi input. |
| inputs/aliyun/README.md | Update Aliyun README (config key needs fix per review). |
| inputs/activemq/README.md | Add English README for ActiveMQ (via Jolokia). |
| inputs/activemq/README_CN.md | Add Chinese README for ActiveMQ (via Jolokia). |
Comments suppressed due to low confidence (1)
inputs/sqlserver/README.md:13
- SQL 初始化与连接串示例当前未使用代码块包裹，并且把真实风格的连接串（含密码）直接裸露在正文里，Markdown 可读性较差且容易被误复制。建议将 SQL 语句/连接串放入代码块，并将敏感字段改为占位符。
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.