chore: Document linux only plugins (part 1) (#12764)

plugins/inputs/bcache/README.md

@@ -64,6 +64,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 ```toml @sample.conf
 # Read metrics of bcache from stats_total and dirty_data
+# This plugin ONLY supports Linux
 [[inputs.bcache]]
   ## Bcache sets path
   ## If not specified, then default is:

plugins/inputs/bcache/bcache.go

@@ -1,7 +1,5 @@
 //go:generate ../../../tools/readme_config_includer/generator
-//go:build !windows
+//go:build linux
-
-// bcache doesn't aim for Windows
 
 package bcache
 

plugins/inputs/bcache/bcache_notlinux.go

@@ -0,0 +1,3 @@
+//go:build !linux
+
+package bcache

plugins/inputs/bcache/bcache_test.go

@@ -1,4 +1,4 @@
-//go:build !windows
+//go:build linux
 
 package bcache
 

plugins/inputs/bcache/bcache_windows.go

@@ -1,3 +0,0 @@
-//go:build windows
-
-package bcache

plugins/inputs/bcache/sample.conf

@@ -1,4 +1,5 @@
 # Read metrics of bcache from stats_total and dirty_data
+# This plugin ONLY supports Linux
 [[inputs.bcache]]
   ## Bcache sets path
   ## If not specified, then default is:

plugins/inputs/conntrack/README.md

@@ -37,6 +37,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 ```toml @sample.conf
 # Collects conntrack stats from the configured directories and files.
+# This plugin ONLY supports Linux
 [[inputs.conntrack]]
   ## The following defaults would work with multiple versions of conntrack.
   ## Note the nf_ and ip_ filename prefixes are mutually exclusive across

plugins/inputs/conntrack/sample.conf

@@ -1,4 +1,5 @@
 # Collects conntrack stats from the configured directories and files.
+# This plugin ONLY supports Linux
 [[inputs.conntrack]]
   ## The following defaults would work with multiple versions of conntrack.
   ## Note the nf_ and ip_ filename prefixes are mutually exclusive across

plugins/inputs/dpdk/README.md

@@ -57,6 +57,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 ```toml @sample.conf
 # Reads metrics from DPDK applications using v2 telemetry interface.
+# This plugin ONLY supports Linux
 [[inputs.dpdk]]
   ## Path to DPDK telemetry socket. This shall point to v2 version of DPDK
   ## telemetry interface.

plugins/inputs/dpdk/sample.conf

@@ -1,4 +1,5 @@
 # Reads metrics from DPDK applications using v2 telemetry interface.
+# This plugin ONLY supports Linux
 [[inputs.dpdk]]
   ## Path to DPDK telemetry socket. This shall point to v2 version of DPDK
   ## telemetry interface.

plugins/inputs/hugepages/README.md

@@ -21,6 +21,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 ```toml @sample.conf
 # Gathers huge pages measurements.
+# This plugin ONLY supports Linux
 [[inputs.hugepages]]
   ## Supported huge page types:
   ##   - "root"     - based on root huge page control directory:

plugins/inputs/hugepages/sample.conf

@@ -1,4 +1,5 @@
 # Gathers huge pages measurements.
+# This plugin ONLY supports Linux
 [[inputs.hugepages]]
   ## Supported huge page types:
   ##   - "root"     - based on root huge page control directory:

plugins/inputs/intel_dlb/README.md

@@ -66,6 +66,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 ```toml @sample.conf
 ## Reads metrics from DPDK using v2 telemetry interface.
+## This plugin ONLY supports Linux
 [[inputs.intel_dlb]]
   ## Path to DPDK telemetry socket.
   # socket_path = "/var/run/dpdk/rte/dpdk_telemetry.v2"

plugins/inputs/intel_dlb/sample.conf

@@ -1,4 +1,5 @@
 ## Reads metrics from DPDK using v2 telemetry interface.
+## This plugin ONLY supports Linux
 [[inputs.intel_dlb]]
   ## Path to DPDK telemetry socket.
   # socket_path = "/var/run/dpdk/rte/dpdk_telemetry.v2"

plugins/inputs/intel_powerstat/README.md

@@ -23,6 +23,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 ```toml @sample.conf
 # Intel PowerStat plugin enables monitoring of platform metrics (power, TDP)
 # and per-CPU metrics like temperature, power and utilization.
+# This plugin ONLY supports Linux
 [[inputs.intel_powerstat]]
   ## The user can choose which package metrics are monitored by the plugin with
   ## the package_metrics setting:

plugins/inputs/intel_powerstat/sample.conf

@@ -1,5 +1,6 @@
 # Intel PowerStat plugin enables monitoring of platform metrics (power, TDP)
 # and per-CPU metrics like temperature, power and utilization.
+# This plugin ONLY supports Linux
 [[inputs.intel_powerstat]]
   ## The user can choose which package metrics are monitored by the plugin with
   ## the package_metrics setting:

plugins/inputs/iptables/README.md

@@ -76,6 +76,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 ```toml @sample.conf
 # Gather packets and bytes throughput from iptables
+# This plugin ONLY supports Linux
 [[inputs.iptables]]
   ## iptables require root access on most systems.
   ## Setting 'use_sudo' to true will make use of sudo to run iptables.

plugins/inputs/iptables/sample.conf

@@ -1,4 +1,5 @@
 # Gather packets and bytes throughput from iptables
+# This plugin ONLY supports Linux
 [[inputs.iptables]]
   ## iptables require root access on most systems.
   ## Setting 'use_sudo' to true will make use of sudo to run iptables.

plugins/inputs/ipvs/README.md

@@ -18,6 +18,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 ```toml @sample.conf
 # Collect virtual and real server stats from Linux IPVS
+# This plugin ONLY supports Linux
 [[inputs.ipvs]]
   # no configuration
 ```

plugins/inputs/ipvs/sample.conf

@@ -1,3 +1,4 @@
 # Collect virtual and real server stats from Linux IPVS
+# This plugin ONLY supports Linux
 [[inputs.ipvs]]
   # no configuration

plugins/inputs/kernel_vmstat/README.md

@@ -124,6 +124,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 ```toml @sample.conf
 # Get kernel statistics from /proc/vmstat
+# This plugin ONLY supports Linux
 [[inputs.kernel_vmstat]]
   # no configuration
 ```

plugins/inputs/kernel_vmstat/sample.conf

@@ -1,3 +1,4 @@
 # Get kernel statistics from /proc/vmstat
+# This plugin ONLY supports Linux
 [[inputs.kernel_vmstat]]
   # no configuration

plugins/inputs/linux_cpu/README.md

@@ -15,6 +15,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 ```toml @sample.conf
 # Provides Linux CPU metrics
+# This plugin ONLY supports Linux
 [[inputs.linux_cpu]]
   ## Path for sysfs filesystem.
   ## See https://www.kernel.org/doc/Documentation/filesystems/sysfs.txt

plugins/inputs/linux_cpu/sample.conf

@@ -1,4 +1,5 @@
 # Provides Linux CPU metrics
+# This plugin ONLY supports Linux
 [[inputs.linux_cpu]]
   ## Path for sysfs filesystem.
   ## See https://www.kernel.org/doc/Documentation/filesystems/sysfs.txt

plugins/inputs/lustre2/README.md

@@ -19,6 +19,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
 
 ```toml @sample.conf
 # Read metrics from local Lustre service on OST, MDS
+# This plugin ONLY supports Linux
 [[inputs.lustre2]]
   ## An array of /proc globs to search for Lustre stats
   ## If not specified, the default will work on Lustre 2.5.x

plugins/inputs/lustre2/lustre2.go

@@ -1,5 +1,5 @@
 //go:generate ../../../tools/readme_config_includer/generator
-//go:build !windows
+//go:build linux
 
 // Package lustre2 (doesn't aim for Windows)
 // Lustre 2.x Telegraf plugin

plugins/inputs/lustre2/lustre2_notlinux.go

@@ -0,0 +1,3 @@
+//go:build !linux
+
+package lustre2

plugins/inputs/lustre2/lustre2_test.go

@@ -1,4 +1,4 @@
-//go:build !windows
+//go:build linux
 
 package lustre2
 

plugins/inputs/lustre2/lustre2_windows.go

@@ -1,3 +0,0 @@
-//go:build windows
-
-package lustre2

plugins/inputs/lustre2/sample.conf

@@ -1,4 +1,5 @@
 # Read metrics from local Lustre service on OST, MDS
+# This plugin ONLY supports Linux
 [[inputs.lustre2]]
   ## An array of /proc globs to search for Lustre stats
   ## If not specified, the default will work on Lustre 2.5.x