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

chore(inputs): add descriptions to config in README.md (#10962)

This commit is contained in:
Sebastian Spaink 2022-04-12 08:29:02 -05:00 committed by GitHub
parent b355be5ccb
commit 5676326ae9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 56 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
plugins/inputs/conntrack/README.md
View File

@ -21,20 +21,20 @@ For more information on conntrack-tools, see the
## Configuration ## Configuration
```toml ```toml
# Collects conntrack stats from the configured directories and files. # Collects conntrack stats from the configured directories and files.
[[inputs.conntrack]] [[inputs.conntrack]]
## The following defaults would work with multiple versions of conntrack. ## The following defaults would work with multiple versions of conntrack.
## Note the nf_ and ip_ filename prefixes are mutually exclusive across ## Note the nf_ and ip_ filename prefixes are mutually exclusive across
## kernel versions, as are the directory locations. ## kernel versions, as are the directory locations.
## Superset of filenames to look for within the conntrack dirs. ## Superset of filenames to look for within the conntrack dirs.
## Missing files will be ignored. ## Missing files will be ignored.
files = ["ip_conntrack_count","ip_conntrack_max", files = ["ip_conntrack_count","ip_conntrack_max",
"nf_conntrack_count","nf_conntrack_max"] "nf_conntrack_count","nf_conntrack_max"]
## Directories to search within for the conntrack files above. ## Directories to search within for the conntrack files above.
## Missing directories will be ignored. ## Missing directories will be ignored.
dirs = ["/proc/sys/net/ipv4/netfilter","/proc/sys/net/netfilter"] dirs = ["/proc/sys/net/ipv4/netfilter","/proc/sys/net/netfilter"]
``` ```
## Measurements & Fields ## Measurements & Fields

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

@ -13,6 +13,7 @@ This section contains the default TOML to configure the plugin. You can
generate it using `telegraf --usage <plugin-name>`. generate it using `telegraf --usage <plugin-name>`.
```toml ```toml
# This is an example plugin
[[inputs.example]] [[inputs.example]]
example_option = "example_value" example_option = "example_value"
``` ```

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

@ -7,6 +7,7 @@ The httpjson plugin collects data from HTTP URLs which respond with JSON. It fl
## Configuration ## Configuration
```toml ```toml
# Read flattened metrics from one or more JSON HTTP endpoints
[[inputs.httpjson]] [[inputs.httpjson]]
## NOTE This plugin only reads numerical measurements, strings and booleans ## NOTE This plugin only reads numerical measurements, strings and booleans
## will be ignored. ## will be ignored.

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

@ -21,6 +21,7 @@ submits data to InfluxDB determines the destination database.
## Configuration ## Configuration
```toml ```toml
# Accept metrics over InfluxDB 1.x HTTP API
[[inputs.influxdb_listener]] [[inputs.influxdb_listener]]
## Address and port to host HTTP listener on ## Address and port to host HTTP listener on
service_address = ":8186" service_address = ":8186"

3
plugins/inputs/mqtt_consumer/README.md
View File

@ -6,6 +6,7 @@ and creates metrics using one of the supported [input data formats][].
## Configuration ## Configuration
```toml ```toml
# Read metrics from MQTT topic(s)
[[inputs.mqtt_consumer]] [[inputs.mqtt_consumer]]
## Broker URLs for the MQTT server or cluster. To connect to multiple ## Broker URLs for the MQTT server or cluster. To connect to multiple
## clusters or standalone servers, use a separate plugin instance. ## clusters or standalone servers, use a separate plugin instance.
@ -75,7 +76,7 @@ and creates metrics using one of the supported [input data formats][].
data_format = "influx" data_format = "influx"
## Enable extracting tag values from MQTT topics ## Enable extracting tag values from MQTT topics
## _ denotes an ignored entry in the topic path ## _ denotes an ignored entry in the topic path
# [[inputs.mqtt_consumer.topic_parsing]] # [[inputs.mqtt_consumer.topic_parsing]]
# topic = "" # topic = ""
# measurement = "" # measurement = ""

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

@ -9,6 +9,7 @@ instances of telegraf can read from a NATS cluster in parallel.
## Configuration ## Configuration
```toml ```toml
# Read metrics from NATS subject(s)
[[inputs.nats_consumer]] [[inputs.nats_consumer]]
## urls of NATS servers ## urls of NATS servers
servers = ["nats://localhost:4222"] servers = ["nats://localhost:4222"]

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

@ -33,6 +33,7 @@ More information about the meaning of these metrics can be found in the [Postgre
## Configuration ## Configuration
```toml ```toml
# Read metrics from one or many postgresql servers
[[inputs.postgresql]] [[inputs.postgresql]]
## specify address via a url matching: ## specify address via a url matching:
## postgres://[pqgotest[:password]]@localhost[/dbname]?sslmode=[disable|verify-ca|verify-full] ## postgres://[pqgotest[:password]]@localhost[/dbname]?sslmode=[disable|verify-ca|verify-full]

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

@ -7,6 +7,7 @@ The `RAS` plugin gathers and counts errors provided by [RASDaemon](https://githu
## Configuration ## Configuration
```toml ```toml
# RAS plugin exposes counter metrics for Machine Check Errors provided by RASDaemon (sqlite3 output is required).
[[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/sflow/README.md
View File

@ -21,6 +21,7 @@ avoid cardinality issues:
## Configuration ## Configuration
```toml ```toml
# SFlow V5 Protocol Listener
[[inputs.sflow]] [[inputs.sflow]]
## Address to listen for sFlow packets. ## Address to listen for sFlow packets.
## example: service_address = "udp://:6343" ## example: service_address = "udp://:6343"

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

@ -11,6 +11,7 @@ In this example, the plugin will gather value of OIDS:
- `.1.3.6.1.2.1.2.2.1.4.1` - `.1.3.6.1.2.1.2.2.1.4.1`
```toml ```toml
# DEPRECATED! PLEASE USE inputs.snmp INSTEAD.
[[inputs.snmp_legacy]] [[inputs.snmp_legacy]]
## Use 'oids.txt' file to translate oids to names ## Use 'oids.txt' file to translate oids to names
## To generate 'oids.txt' you need to run: ## To generate 'oids.txt' you need to run:

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

@ -14,6 +14,7 @@ path onto the global path variable
## Configuration ## Configuration
```toml ```toml
# Receive SNMP traps
[[inputs.snmp_trap]] [[inputs.snmp_trap]]
## Transport, local address, and port to listen on. Transport must ## Transport, local address, and port to listen on. Transport must
## be "udp://". Omit local address to listen on all interfaces. ## be "udp://". Omit local address to listen on all interfaces.

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

@ -11,6 +11,7 @@ This section contains the default TOML to configure the plugin. You can
generate it using `telegraf --usage <plugin-name>`. generate it using `telegraf --usage <plugin-name>`.
```toml ```toml
# Read metrics from SQL queries
[[inputs.sql]] [[inputs.sql]]
## Database Driver ## Database Driver
## See https://github.com/influxdata/telegraf/blob/master/docs/SQL_DRIVERS_INPUT.md for ## See https://github.com/influxdata/telegraf/blob/master/docs/SQL_DRIVERS_INPUT.md for

54
plugins/inputs/sqlserver/README.md
View File

@ -89,10 +89,6 @@ Remove User Id and Password keywords from the connection string in your config f
## Configuration ## Configuration
```toml ```toml
[agent]
## Default data collection interval for all inputs, can be changed as per collection interval needs
interval = "10s"
# Read metrics from Microsoft SQL Server # Read metrics from Microsoft SQL Server
[[inputs.sqlserver]] [[inputs.sqlserver]]
## Specify instances to monitor with a list of connection strings. ## Specify instances to monitor with a list of connection strings.
@ -122,24 +118,24 @@ Remove User Id and Password keywords from the connection string in your config f
## A list of queries to explicitly ignore. ## A list of queries to explicitly ignore.
exclude_query = ["SQLServerAvailabilityReplicaStates", "SQLServerDatabaseReplicaStates"] exclude_query = ["SQLServerAvailabilityReplicaStates", "SQLServerDatabaseReplicaStates"]
## Queries enabled by default for database_type = "SQLServer" are - ## Queries enabled by default for database_type = "SQLServer" are -
## SQLServerPerformanceCounters, SQLServerWaitStatsCategorized, SQLServerDatabaseIO, SQLServerProperties, SQLServerMemoryClerks, ## SQLServerPerformanceCounters, SQLServerWaitStatsCategorized, SQLServerDatabaseIO, SQLServerProperties, SQLServerMemoryClerks,
## SQLServerSchedulers, SQLServerRequests, SQLServerVolumeSpace, SQLServerCpu, SQLServerAvailabilityReplicaStates, SQLServerDatabaseReplicaStates ## SQLServerSchedulers, SQLServerRequests, SQLServerVolumeSpace, SQLServerCpu, SQLServerAvailabilityReplicaStates, SQLServerDatabaseReplicaStates
## Queries enabled by default for database_type = "AzureSQLDB" are - ## Queries enabled by default for database_type = "AzureSQLDB" are -
## AzureSQLDBResourceStats, AzureSQLDBResourceGovernance, AzureSQLDBWaitStats, AzureSQLDBDatabaseIO, AzureSQLDBServerProperties, ## AzureSQLDBResourceStats, AzureSQLDBResourceGovernance, AzureSQLDBWaitStats, AzureSQLDBDatabaseIO, AzureSQLDBServerProperties,
## AzureSQLDBOsWaitstats, AzureSQLDBMemoryClerks, AzureSQLDBPerformanceCounters, AzureSQLDBRequests, AzureSQLDBSchedulers ## AzureSQLDBOsWaitstats, AzureSQLDBMemoryClerks, AzureSQLDBPerformanceCounters, AzureSQLDBRequests, AzureSQLDBSchedulers
## Queries enabled by default for database_type = "AzureSQLManagedInstance" are - ## Queries enabled by default for database_type = "AzureSQLManagedInstance" are -
## AzureSQLMIResourceStats, AzureSQLMIResourceGovernance, AzureSQLMIDatabaseIO, AzureSQLMIServerProperties, AzureSQLMIOsWaitstats, ## AzureSQLMIResourceStats, AzureSQLMIResourceGovernance, AzureSQLMIDatabaseIO, AzureSQLMIServerProperties, AzureSQLMIOsWaitstats,
## AzureSQLMIMemoryClerks, AzureSQLMIPerformanceCounters, AzureSQLMIRequests, AzureSQLMISchedulers ## AzureSQLMIMemoryClerks, AzureSQLMIPerformanceCounters, AzureSQLMIRequests, AzureSQLMISchedulers
## Queries enabled by default for database_type = "AzureSQLPool" are - ## Queries enabled by default for database_type = "AzureSQLPool" are -
## AzureSQLPoolResourceStats, AzureSQLPoolResourceGovernance, AzureSQLPoolDatabaseIO, AzureSQLPoolWaitStats, ## AzureSQLPoolResourceStats, AzureSQLPoolResourceGovernance, AzureSQLPoolDatabaseIO, AzureSQLPoolWaitStats,
## AzureSQLPoolMemoryClerks, AzureSQLPoolPerformanceCounters, AzureSQLPoolSchedulers ## AzureSQLPoolMemoryClerks, AzureSQLPoolPerformanceCounters, AzureSQLPoolSchedulers
## Following are old config settings ## Following are old config settings
## You may use them only if you are using the earlier flavor of queries, however it is recommended to use ## You may use them only if you are using the earlier flavor of queries, however it is recommended to use
## the new mechanism of identifying the database_type there by use it's corresponding queries ## the new mechanism of identifying the database_type there by use it's corresponding queries
## Optional parameter, setting this to 2 will use a new version ## Optional parameter, setting this to 2 will use a new version
@ -151,18 +147,18 @@ Remove User Id and Password keywords from the connection string in your config f
## If you are using AzureDB, setting this to true will gather resource utilization metrics ## If you are using AzureDB, setting this to true will gather resource utilization metrics
# azuredb = false # azuredb = false
## Toggling this to true will emit an additional metric called "sqlserver_telegraf_health". ## Toggling this to true will emit an additional metric called "sqlserver_telegraf_health".
## This metric tracks the count of attempted queries and successful queries for each SQL instance specified in "servers". ## This metric tracks the count of attempted queries and successful queries for each SQL instance specified in "servers".
## The purpose of this metric is to assist with identifying and diagnosing any connectivity or query issues. ## The purpose of this metric is to assist with identifying and diagnosing any connectivity or query issues.
## This setting/metric is optional and is disabled by default. ## This setting/metric is optional and is disabled by default.
# health_metric = false # health_metric = false
## Possible queries accross different versions of the collectors ## Possible queries accross different versions of the collectors
## Queries enabled by default for specific Database Type ## Queries enabled by default for specific Database Type
## database_type = AzureSQLDB by default collects the following queries ## database_type = AzureSQLDB by default collects the following queries
## - AzureSQLDBWaitStats ## - AzureSQLDBWaitStats
## - AzureSQLDBResourceStats ## - AzureSQLDBResourceStats
## - AzureSQLDBResourceGovernance ## - AzureSQLDBResourceGovernance
## - AzureSQLDBDatabaseIO ## - AzureSQLDBDatabaseIO
## - AzureSQLDBServerProperties ## - AzureSQLDBServerProperties
@ -173,11 +169,11 @@ Remove User Id and Password keywords from the connection string in your config f
## - AzureSQLDBSchedulers ## - AzureSQLDBSchedulers
## database_type = AzureSQLManagedInstance by default collects the following queries ## database_type = AzureSQLManagedInstance by default collects the following queries
## - AzureSQLMIResourceStats ## - AzureSQLMIResourceStats
## - AzureSQLMIResourceGovernance ## - AzureSQLMIResourceGovernance
## - AzureSQLMIDatabaseIO ## - AzureSQLMIDatabaseIO
## - AzureSQLMIServerProperties ## - AzureSQLMIServerProperties
## - AzureSQLMIOsWaitstats ## - AzureSQLMIOsWaitstats
## - AzureSQLMIMemoryClerks ## - AzureSQLMIMemoryClerks
## - AzureSQLMIPerformanceCounters ## - AzureSQLMIPerformanceCounters
## - AzureSQLMIRequests ## - AzureSQLMIRequests
@ -187,17 +183,17 @@ Remove User Id and Password keywords from the connection string in your config f
## - AzureSQLPoolResourceStats ## - AzureSQLPoolResourceStats
## - AzureSQLPoolResourceGovernance ## - AzureSQLPoolResourceGovernance
## - AzureSQLPoolDatabaseIO ## - AzureSQLPoolDatabaseIO
## - AzureSQLPoolOsWaitStats, ## - AzureSQLPoolOsWaitStats,
## - AzureSQLPoolMemoryClerks ## - AzureSQLPoolMemoryClerks
## - AzureSQLPoolPerformanceCounters ## - AzureSQLPoolPerformanceCounters
## - AzureSQLPoolSchedulers ## - AzureSQLPoolSchedulers
## database_type = SQLServer by default collects the following queries ## database_type = SQLServer by default collects the following queries
## - SQLServerPerformanceCounters ## - SQLServerPerformanceCounters
## - SQLServerWaitStatsCategorized ## - SQLServerWaitStatsCategorized
## - SQLServerDatabaseIO ## - SQLServerDatabaseIO
## - SQLServerProperties ## - SQLServerProperties
## - SQLServerMemoryClerks ## - SQLServerMemoryClerks
## - SQLServerSchedulers ## - SQLServerSchedulers
## - SQLServerRequests ## - SQLServerRequests
## - SQLServerVolumeSpace ## - SQLServerVolumeSpace

3
plugins/inputs/suricata/README.md
View File

@ -9,6 +9,7 @@ It can also report for triggered Suricata IDS/IPS alerts.
## Configuration ## Configuration
```toml ```toml
# Suricata stats and alerts plugin
[[inputs.suricata]] [[inputs.suricata]]
## Data sink for Suricata stats log. ## Data sink for Suricata stats log.
# This is expected to be a filename of a # This is expected to be a filename of a
@ -19,7 +20,7 @@ It can also report for triggered Suricata IDS/IPS alerts.
# becomes "detect_alert" when delimiter is "_". # becomes "detect_alert" when delimiter is "_".
delimiter = "_" delimiter = "_"
# Detect alert logs # Detect alert logs
alerts = false alerts = false
``` ```

3
plugins/inputs/tail/README.md
View File

@ -22,6 +22,7 @@ The plugin expects messages in one of the
## Configuration ## Configuration
```toml ```toml
# Parse the new lines appended to a file
[[inputs.tail]] [[inputs.tail]]
## File names or a pattern to tail. ## File names or a pattern to tail.
## These accept standard unix glob matching rules, but with the addition of ## These accept standard unix glob matching rules, but with the addition of
@ -81,7 +82,7 @@ The plugin expects messages in one of the
## multi-line event. ## multi-line event.
#match_which_line = "previous" #match_which_line = "previous"
## The invert_match can be true or false (defaults to false). ## The invert_match can be true or false (defaults to false).
## If true, a message not matching the pattern will constitute a match of the multiline filter and the what will be applied. (vice-versa is also true) ## If true, a message not matching the pattern will constitute a match of the multiline filter and the what will be applied. (vice-versa is also true)
#invert_match = false #invert_match = false

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

@ -16,6 +16,7 @@ sudo service telegraf start
## Configuration ## Configuration
```toml ```toml
# A Webhooks Event collector
[[inputs.webhooks]] [[inputs.webhooks]]
## Address and port to host Webhook listener on ## Address and port to host Webhook listener on
service_address = ":1619" service_address = ":1619"

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

@ -11,6 +11,7 @@ Telegraf minimum version: Telegraf 1.16.0
### Configuration ### Configuration
```toml ```toml
# Input plugin to collect Windows Event Log messages
[[inputs.win_eventlog]] [[inputs.win_eventlog]]
## Telegraf should have Administrator permissions to subscribe for some Windows Events channels ## Telegraf should have Administrator permissions to subscribe for some Windows Events channels
## (System log, for example) ## (System log, for example)

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

@ -7,6 +7,7 @@ Monitoring some services may require running Telegraf with administrator privile
## Configuration ## Configuration
```toml ```toml
# Input plugin to report Windows services info.
[[inputs.win_services]] [[inputs.win_services]]
## Names of the services to monitor. Leave empty to monitor all the available services on the host. Globs accepted. Case sensitive. ## Names of the services to monitor. Leave empty to monitor all the available services on the host. Globs accepted. Case sensitive.
service_names = [ service_names = [