From 8e5c2d0538f39d583fbc10130f40996463152d8d Mon Sep 17 00:00:00 2001 From: Joshua Powers Date: Mon, 6 Mar 2023 04:18:43 -0700 Subject: [PATCH] chore: Specify distro support (part 3) (#12792) --- plugins/inputs/cgroup/README.md | 1 + plugins/inputs/cgroup/sample.conf | 1 + plugins/inputs/diskio/README.md | 1 + plugins/inputs/diskio/sample.conf | 1 + plugins/inputs/dmcache/README.md | 1 + plugins/inputs/dmcache/sample.conf | 1 + plugins/inputs/ethtool/README.md | 1 + plugins/inputs/ethtool/sample.conf | 1 + plugins/inputs/infiniband/README.md | 1 + plugins/inputs/infiniband/sample.conf | 1 + plugins/inputs/kernel/README.md | 1 + plugins/inputs/kernel/sample.conf | 1 + plugins/inputs/nats/README.md | 1 + plugins/inputs/nats/sample.conf | 1 + plugins/inputs/processes/README.md | 1 + plugins/inputs/processes/sample.conf | 1 + plugins/inputs/synproxy/README.md | 1 + plugins/inputs/synproxy/sample.conf | 1 + plugins/inputs/wireless/README.md | 1 + plugins/inputs/wireless/sample.conf | 1 + plugins/inputs/zfs/README.md | 1 + plugins/inputs/zfs/sample.conf | 1 + 22 files changed, 22 insertions(+) diff --git a/plugins/inputs/cgroup/README.md b/plugins/inputs/cgroup/README.md index 7e7f6f41d..e88f6b896 100644 --- a/plugins/inputs/cgroup/README.md +++ b/plugins/inputs/cgroup/README.md @@ -51,6 +51,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Read specific statistics per cgroup +# This plugin ONLY supports Linux [[inputs.cgroup]] ## Directories in which to look for files, globs are supported. ## Consider restricting paths to the set of cgroups you really diff --git a/plugins/inputs/cgroup/sample.conf b/plugins/inputs/cgroup/sample.conf index f931a11a7..fd7192fb3 100644 --- a/plugins/inputs/cgroup/sample.conf +++ b/plugins/inputs/cgroup/sample.conf @@ -1,4 +1,5 @@ # Read specific statistics per cgroup +# This plugin ONLY supports Linux [[inputs.cgroup]] ## Directories in which to look for files, globs are supported. ## Consider restricting paths to the set of cgroups you really diff --git a/plugins/inputs/diskio/README.md b/plugins/inputs/diskio/README.md index 13a29605a..5c6eb6ea7 100644 --- a/plugins/inputs/diskio/README.md +++ b/plugins/inputs/diskio/README.md @@ -15,6 +15,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Read metrics about disk IO by device +# This plugin ONLY supports Linux [[inputs.diskio]] ## By default, telegraf will gather stats for all devices including ## disk partitions. diff --git a/plugins/inputs/diskio/sample.conf b/plugins/inputs/diskio/sample.conf index 99ff4aa71..76eb27dd6 100644 --- a/plugins/inputs/diskio/sample.conf +++ b/plugins/inputs/diskio/sample.conf @@ -1,4 +1,5 @@ # Read metrics about disk IO by device +# This plugin ONLY supports Linux [[inputs.diskio]] ## By default, telegraf will gather stats for all devices including ## disk partitions. diff --git a/plugins/inputs/dmcache/README.md b/plugins/inputs/dmcache/README.md index b7118d386..42ccf2552 100644 --- a/plugins/inputs/dmcache/README.md +++ b/plugins/inputs/dmcache/README.md @@ -22,6 +22,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Provide a native collection for dmsetup based statistics for dm-cache +# This plugin ONLY supports Linux [[inputs.dmcache]] ## Whether to report per-device stats or not per_device = true diff --git a/plugins/inputs/dmcache/sample.conf b/plugins/inputs/dmcache/sample.conf index d21d2ba7e..37e987322 100644 --- a/plugins/inputs/dmcache/sample.conf +++ b/plugins/inputs/dmcache/sample.conf @@ -1,4 +1,5 @@ # Provide a native collection for dmsetup based statistics for dm-cache +# This plugin ONLY supports Linux [[inputs.dmcache]] ## Whether to report per-device stats or not per_device = true diff --git a/plugins/inputs/ethtool/README.md b/plugins/inputs/ethtool/README.md index 2000c2c3f..7c1187b07 100644 --- a/plugins/inputs/ethtool/README.md +++ b/plugins/inputs/ethtool/README.md @@ -16,6 +16,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Returns ethtool statistics for given interfaces +# This plugin ONLY supports Linux [[inputs.ethtool]] ## List of interfaces to pull metrics for # interface_include = ["eth0"] diff --git a/plugins/inputs/ethtool/sample.conf b/plugins/inputs/ethtool/sample.conf index 020535a4f..f3b7a6505 100644 --- a/plugins/inputs/ethtool/sample.conf +++ b/plugins/inputs/ethtool/sample.conf @@ -1,4 +1,5 @@ # Returns ethtool statistics for given interfaces +# This plugin ONLY supports Linux [[inputs.ethtool]] ## List of interfaces to pull metrics for # interface_include = ["eth0"] diff --git a/plugins/inputs/infiniband/README.md b/plugins/inputs/infiniband/README.md index e358eee7a..bfff9000b 100644 --- a/plugins/inputs/infiniband/README.md +++ b/plugins/inputs/infiniband/README.md @@ -19,6 +19,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Gets counters from all InfiniBand cards and ports installed +# This plugin ONLY supports Linux [[inputs.infiniband]] # no configuration ``` diff --git a/plugins/inputs/infiniband/sample.conf b/plugins/inputs/infiniband/sample.conf index c8bb609d2..560330377 100644 --- a/plugins/inputs/infiniband/sample.conf +++ b/plugins/inputs/infiniband/sample.conf @@ -1,3 +1,4 @@ # Gets counters from all InfiniBand cards and ports installed +# This plugin ONLY supports Linux [[inputs.infiniband]] # no configuration diff --git a/plugins/inputs/kernel/README.md b/plugins/inputs/kernel/README.md index 894589e10..5c80a28d5 100644 --- a/plugins/inputs/kernel/README.md +++ b/plugins/inputs/kernel/README.md @@ -53,6 +53,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Get kernel statistics from /proc/stat +# This plugin ONLY supports Linux [[inputs.kernel]] # no configuration ``` diff --git a/plugins/inputs/kernel/sample.conf b/plugins/inputs/kernel/sample.conf index 10de9f8a4..1152d3671 100644 --- a/plugins/inputs/kernel/sample.conf +++ b/plugins/inputs/kernel/sample.conf @@ -1,3 +1,4 @@ # Get kernel statistics from /proc/stat +# This plugin ONLY supports Linux [[inputs.kernel]] # no configuration diff --git a/plugins/inputs/nats/README.md b/plugins/inputs/nats/README.md index 59600acb7..1e80f4ae6 100644 --- a/plugins/inputs/nats/README.md +++ b/plugins/inputs/nats/README.md @@ -18,6 +18,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Provides metrics about the state of a NATS server +# This plugin does NOT support FreeBSD [[inputs.nats]] ## The address of the monitoring endpoint of the NATS server server = "http://localhost:8222" diff --git a/plugins/inputs/nats/sample.conf b/plugins/inputs/nats/sample.conf index c5aaecd06..7bf144eb2 100644 --- a/plugins/inputs/nats/sample.conf +++ b/plugins/inputs/nats/sample.conf @@ -1,4 +1,5 @@ # Provides metrics about the state of a NATS server +# This plugin does NOT support FreeBSD [[inputs.nats]] ## The address of the monitoring endpoint of the NATS server server = "http://localhost:8222" diff --git a/plugins/inputs/processes/README.md b/plugins/inputs/processes/README.md index 7c3cce086..f778392b7 100644 --- a/plugins/inputs/processes/README.md +++ b/plugins/inputs/processes/README.md @@ -21,6 +21,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Get the number of processes and group them by status +# This plugin ONLY supports non-Windows [[inputs.processes]] ## Use sudo to run ps command on *BSD systems. Linux systems will read ## /proc, so this does not apply there. diff --git a/plugins/inputs/processes/sample.conf b/plugins/inputs/processes/sample.conf index d8f2cc136..8d566508f 100644 --- a/plugins/inputs/processes/sample.conf +++ b/plugins/inputs/processes/sample.conf @@ -1,4 +1,5 @@ # Get the number of processes and group them by status +# This plugin ONLY supports non-Windows [[inputs.processes]] ## Use sudo to run ps command on *BSD systems. Linux systems will read ## /proc, so this does not apply there. diff --git a/plugins/inputs/synproxy/README.md b/plugins/inputs/synproxy/README.md index 91a8f1e5c..c115dd7d9 100644 --- a/plugins/inputs/synproxy/README.md +++ b/plugins/inputs/synproxy/README.md @@ -17,6 +17,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Get synproxy counter statistics from procfs +# This plugin ONLY supports Linux [[inputs.synproxy]] # no configuration ``` diff --git a/plugins/inputs/synproxy/sample.conf b/plugins/inputs/synproxy/sample.conf index de944aa19..ef41961cd 100644 --- a/plugins/inputs/synproxy/sample.conf +++ b/plugins/inputs/synproxy/sample.conf @@ -1,3 +1,4 @@ # Get synproxy counter statistics from procfs +# This plugin ONLY supports Linux [[inputs.synproxy]] # no configuration diff --git a/plugins/inputs/wireless/README.md b/plugins/inputs/wireless/README.md index f3f843631..997cfc0ba 100644 --- a/plugins/inputs/wireless/README.md +++ b/plugins/inputs/wireless/README.md @@ -16,6 +16,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Monitor wifi signal strength and quality +# This plugin ONLY supports Linux [[inputs.wireless]] ## Sets 'proc' directory path ## If not specified, then default is /proc diff --git a/plugins/inputs/wireless/sample.conf b/plugins/inputs/wireless/sample.conf index d5f993533..f5cc488be 100644 --- a/plugins/inputs/wireless/sample.conf +++ b/plugins/inputs/wireless/sample.conf @@ -1,4 +1,5 @@ # Monitor wifi signal strength and quality +# This plugin ONLY supports Linux [[inputs.wireless]] ## Sets 'proc' directory path ## If not specified, then default is /proc diff --git a/plugins/inputs/zfs/README.md b/plugins/inputs/zfs/README.md index ac8c5b0cb..56a96f65a 100644 --- a/plugins/inputs/zfs/README.md +++ b/plugins/inputs/zfs/README.md @@ -17,6 +17,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Read metrics of ZFS from arcstats, zfetchstats, vdev_cache_stats, pools and datasets +# This plugin ONLY supports Linux & FreeBSD [[inputs.zfs]] ## ZFS kstat path. Ignored on FreeBSD ## If not specified, then default is: diff --git a/plugins/inputs/zfs/sample.conf b/plugins/inputs/zfs/sample.conf index 76b57e2ba..2ce516b5e 100644 --- a/plugins/inputs/zfs/sample.conf +++ b/plugins/inputs/zfs/sample.conf @@ -1,4 +1,5 @@ # Read metrics of ZFS from arcstats, zfetchstats, vdev_cache_stats, pools and datasets +# This plugin ONLY supports Linux & FreeBSD [[inputs.zfs]] ## ZFS kstat path. Ignored on FreeBSD ## If not specified, then default is: