CL-Softwares
/
telegraf
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: Document linux only plugins (part 2) (#12765)

This commit is contained in:
Joshua Powers 2023-03-01 14:22:29 -07:00 committed by GitHub
parent 5e65077860
commit 3a0a9f0f92
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
20 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
plugins/inputs/intel_pmu/README.md
View File

@ -27,6 +27,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# Intel Performance Monitoring Unit plugin exposes Intel PMU metrics available through Linux Perf subsystem # Intel Performance Monitoring Unit plugin exposes Intel PMU metrics available through Linux Perf subsystem
# This plugin ONLY supports Linux on amd64
[[inputs.intel_pmu]] [[inputs.intel_pmu]]
## List of filesystem locations of JSON files that contain PMU event definitions. ## List of filesystem locations of JSON files that contain PMU event definitions.
event_definitions = ["/var/cache/pmu/GenuineIntel-6-55-4-core.json", "/var/cache/pmu/GenuineIntel-6-55-4-uncore.json"] event_definitions = ["/var/cache/pmu/GenuineIntel-6-55-4-core.json", "/var/cache/pmu/GenuineIntel-6-55-4-uncore.json"]

1
plugins/inputs/intel_pmu/sample.conf
View File

@ -1,4 +1,5 @@
# Intel Performance Monitoring Unit plugin exposes Intel PMU metrics available through Linux Perf subsystem # Intel Performance Monitoring Unit plugin exposes Intel PMU metrics available through Linux Perf subsystem
# This plugin ONLY supports Linux on amd64
[[inputs.intel_pmu]] [[inputs.intel_pmu]]
## List of filesystem locations of JSON files that contain PMU event definitions. ## List of filesystem locations of JSON files that contain PMU event definitions.
event_definitions = ["/var/cache/pmu/GenuineIntel-6-55-4-core.json", "/var/cache/pmu/GenuineIntel-6-55-4-uncore.json"] event_definitions = ["/var/cache/pmu/GenuineIntel-6-55-4-core.json", "/var/cache/pmu/GenuineIntel-6-55-4-uncore.json"]

1
plugins/inputs/intel_rdt/README.md
View File

@ -104,6 +104,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# Read Intel RDT metrics # Read Intel RDT metrics
# This plugin ONLY supports non-Windows
[[inputs.intel_rdt]] [[inputs.intel_rdt]]
## Optionally set sampling interval to Nx100ms. ## Optionally set sampling interval to Nx100ms.
## This value is propagated to pqos tool. Interval format is defined by pqos itself. ## This value is propagated to pqos tool. Interval format is defined by pqos itself.

1
plugins/inputs/intel_rdt/sample.conf
View File

@ -1,4 +1,5 @@
# Read Intel RDT metrics # Read Intel RDT metrics
# This plugin ONLY supports non-Windows
[[inputs.intel_rdt]] [[inputs.intel_rdt]]
## Optionally set sampling interval to Nx100ms. ## Optionally set sampling interval to Nx100ms.
## This value is propagated to pqos tool. Interval format is defined by pqos itself. ## This value is propagated to pqos tool. Interval format is defined by pqos itself.

1
plugins/inputs/mdstat/README.md
View File

@ -26,6 +26,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# Get kernel statistics from /proc/mdstat # Get kernel statistics from /proc/mdstat
# This plugin ONLY supports Linux
[[inputs.mdstat]] [[inputs.mdstat]]
## Sets file path ## Sets file path
## If not specified, then default is /proc/mdstat ## If not specified, then default is /proc/mdstat

1
plugins/inputs/mdstat/sample.conf
View File

@ -1,4 +1,5 @@
# Get kernel statistics from /proc/mdstat # Get kernel statistics from /proc/mdstat
# This plugin ONLY supports Linux
[[inputs.mdstat]] [[inputs.mdstat]]
## Sets file path ## Sets file path
## If not specified, then default is /proc/mdstat ## If not specified, then default is /proc/mdstat

1
plugins/inputs/postfix/README.md
View File

@ -20,6 +20,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# Measure postfix queue statistics # Measure postfix queue statistics
# This plugin ONLY supports non-Windows
[[inputs.postfix]] [[inputs.postfix]]
## Postfix queue directory. If not provided, telegraf will try to use ## Postfix queue directory. If not provided, telegraf will try to use
## 'postconf -h queue_directory' to determine it. ## 'postconf -h queue_directory' to determine it.

1
plugins/inputs/postfix/sample.conf
View File

@ -1,4 +1,5 @@
# Measure postfix queue statistics # Measure postfix queue statistics
# This plugin ONLY supports non-Windows
[[inputs.postfix]] [[inputs.postfix]]
## Postfix queue directory. If not provided, telegraf will try to use ## Postfix queue directory. If not provided, telegraf will try to use
## 'postconf -h queue_directory' to determine it. ## 'postconf -h queue_directory' to determine it.

1
plugins/inputs/ras/README.md
View File

@ -19,6 +19,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# RAS plugin exposes counter metrics for Machine Check Errors provided by RASDaemon (sqlite3 output is required). # RAS plugin exposes counter metrics for Machine Check Errors provided by RASDaemon (sqlite3 output is required).
# This plugin ONLY supports Linux on 386, amd64, arm, and arm64
[[inputs.ras]] [[inputs.ras]]
## Optional path to RASDaemon sqlite3 database. ## Optional path to RASDaemon sqlite3 database.
## Default: /var/lib/rasdaemon/ras-mc_event.db ## Default: /var/lib/rasdaemon/ras-mc_event.db

1
plugins/inputs/ras/sample.conf
View File

@ -1,4 +1,5 @@
# RAS plugin exposes counter metrics for Machine Check Errors provided by RASDaemon (sqlite3 output is required). # RAS plugin exposes counter metrics for Machine Check Errors provided by RASDaemon (sqlite3 output is required).
# This plugin ONLY supports Linux on 386, amd64, arm, and arm64
[[inputs.ras]] [[inputs.ras]]
## Optional path to RASDaemon sqlite3 database. ## Optional path to RASDaemon sqlite3 database.
## Default: /var/lib/rasdaemon/ras-mc_event.db ## Default: /var/lib/rasdaemon/ras-mc_event.db

1
plugins/inputs/sensors/README.md
View File

@ -19,6 +19,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# Monitor sensors, requires lm-sensors package # Monitor sensors, requires lm-sensors package
# This plugin ONLY supports Linux
[[inputs.sensors]] [[inputs.sensors]]
## Remove numbers from field names. ## Remove numbers from field names.
## If true, a field name like 'temp1_input' will be changed to 'temp_input'. ## If true, a field name like 'temp1_input' will be changed to 'temp_input'.

1
plugins/inputs/sensors/sample.conf
View File

@ -1,4 +1,5 @@
# Monitor sensors, requires lm-sensors package # Monitor sensors, requires lm-sensors package
# This plugin ONLY supports Linux
[[inputs.sensors]] [[inputs.sensors]]
## Remove numbers from field names. ## Remove numbers from field names.
## If true, a field name like 'temp1_input' will be changed to 'temp_input'. ## If true, a field name like 'temp1_input' will be changed to 'temp_input'.

1
plugins/inputs/slab/README.md
View File

@ -27,6 +27,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# Get slab statistics from procfs # Get slab statistics from procfs
# This plugin ONLY supports Linux
[[inputs.slab]] [[inputs.slab]]
# no configuration - please see the plugin's README for steps to configure # no configuration - please see the plugin's README for steps to configure
# sudo properly # sudo properly

1
plugins/inputs/slab/sample.conf
View File

@ -1,4 +1,5 @@
# Get slab statistics from procfs # Get slab statistics from procfs
# This plugin ONLY supports Linux
[[inputs.slab]] [[inputs.slab]]
# no configuration - please see the plugin's README for steps to configure # no configuration - please see the plugin's README for steps to configure
# sudo properly # sudo properly

1
plugins/inputs/socketstat/README.md
View File

@ -22,6 +22,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# Gather indicators from established connections, using iproute2's ss command. # Gather indicators from established connections, using iproute2's ss command.
# This plugin ONLY supports non-Windows
[[inputs.socketstat]] [[inputs.socketstat]]
## ss can display information about tcp, udp, raw, unix, packet, dccp and sctp sockets ## ss can display information about tcp, udp, raw, unix, packet, dccp and sctp sockets
## Specify here the types you want to gather ## Specify here the types you want to gather

1
plugins/inputs/socketstat/sample.conf
View File

@ -1,4 +1,5 @@
# Gather indicators from established connections, using iproute2's ss command. # Gather indicators from established connections, using iproute2's ss command.
# This plugin ONLY supports non-Windows
[[inputs.socketstat]] [[inputs.socketstat]]
## ss can display information about tcp, udp, raw, unix, packet, dccp and sctp sockets ## ss can display information about tcp, udp, raw, unix, packet, dccp and sctp sockets
## Specify here the types you want to gather ## Specify here the types you want to gather

1
plugins/inputs/sysstat/README.md
View File

@ -19,6 +19,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# Sysstat metrics collector # Sysstat metrics collector
# This plugin ONLY supports Linux
[[inputs.sysstat]] [[inputs.sysstat]]
## Path to the sadc command. ## Path to the sadc command.
# #

1
plugins/inputs/sysstat/sample.conf
View File

@ -1,4 +1,5 @@
# Sysstat metrics collector # Sysstat metrics collector
# This plugin ONLY supports Linux
[[inputs.sysstat]] [[inputs.sysstat]]
## Path to the sadc command. ## Path to the sadc command.
# #

1
plugins/inputs/varnish/README.md
View File

@ -15,6 +15,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# A plugin to collect stats from Varnish HTTP Cache # A plugin to collect stats from Varnish HTTP Cache
# This plugin ONLY supports non-Windows
[[inputs.varnish]] [[inputs.varnish]]
## If running as a restricted user you can prepend sudo for additional access: ## If running as a restricted user you can prepend sudo for additional access:
#use_sudo = false #use_sudo = false

1
plugins/inputs/varnish/sample.conf
View File

@ -1,4 +1,5 @@
# A plugin to collect stats from Varnish HTTP Cache # A plugin to collect stats from Varnish HTTP Cache
# This plugin ONLY supports non-Windows
[[inputs.varnish]] [[inputs.varnish]]
## If running as a restricted user you can prepend sudo for additional access: ## If running as a restricted user you can prepend sudo for additional access:
#use_sudo = false #use_sudo = false