diff --git a/plugins/inputs/nats/README.md b/plugins/inputs/nats/README.md index c4061071b..f81101967 100644 --- a/plugins/inputs/nats/README.md +++ b/plugins/inputs/nats/README.md @@ -1,9 +1,14 @@ -# NATS Input Plugin +# NATS Server Monitoring Input Plugin -The [NATS](http://www.nats.io/about/) monitoring plugin gathers metrics from the -NATS [monitoring http server][1]. +This plugin gathers metrics of a [NATS][nats] server instance using its +[monitoring endpoints][nats_monitoring]. -[1]: https://docs.nats.io/running-a-nats-service/nats_admin/monitoring +⭐ Telegraf v1.6.0 +🏷️ server +πŸ’» all + +[nats]: http://www.nats.io +[nats_monitoring]: https://docs.nats.io/running-a-nats-service/nats_admin/monitoring ## Global configuration options diff --git a/plugins/inputs/nats_consumer/README.md b/plugins/inputs/nats_consumer/README.md index c7e60a1a7..cf8c731b3 100644 --- a/plugins/inputs/nats_consumer/README.md +++ b/plugins/inputs/nats_consumer/README.md @@ -1,14 +1,22 @@ # NATS Consumer Input Plugin -The [NATS][nats] consumer plugin reads from the specified NATS subjects and -creates metrics using one of the supported [input data formats][]. +This service plugin consumes messages from [NATS][nats] instances in one of the +supported [data formats][data_formats]. A [Queue Group][queue_group] is used +when subscribing to subjects so multiple instances of telegraf can consume +messages in parallel. +The plugin supports authenticating via [username/password][userpass], a +[credentials file][creds] (NATS 2.0), or an [nkey seed file][nkey] (NATS 2.0). -A [Queue Group][queue group] is used when subscribing to subjects so multiple -instances of telegraf can read from a NATS cluster in parallel. +⭐ Telegraf v0.10.3 +🏷️ messaging +πŸ’» all -There are three methods of (optionally) authenticating with NATS: -[username/password][userpass], [a NATS creds file][creds] (NATS 2.0), or -an [nkey seed file][nkey] (NATS 2.0). +[nats]: https://www.nats.io/about/ +[data_formats]: /docs/DATA_FORMATS_INPUT.md +[queue_group]: https://www.nats.io/documentation/concepts/nats-queueing/ +[userpass]: https://docs.nats.io/using-nats/developer/connecting/userpass +[creds]: https://docs.nats.io/using-nats/developer/connecting/creds +[nkey]: https://docs.nats.io/using-nats/developer/connecting/nkey ## Service Input @@ -99,13 +107,6 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. data_format = "influx" ``` -[nats]: https://www.nats.io/about/ -[input data formats]: /docs/DATA_FORMATS_INPUT.md -[queue group]: https://www.nats.io/documentation/concepts/nats-queueing/ -[userpass]: https://docs.nats.io/using-nats/developer/connecting/userpass -[creds]: https://docs.nats.io/using-nats/developer/connecting/creds -[nkey]: https://docs.nats.io/using-nats/developer/connecting/nkey - ## Metrics Which data you will get depends on the subjects you consume from nats diff --git a/plugins/inputs/neoom_beaam/README.md b/plugins/inputs/neoom_beaam/README.md index 058d087bb..c7ff4ea72 100644 --- a/plugins/inputs/neoom_beaam/README.md +++ b/plugins/inputs/neoom_beaam/README.md @@ -1,12 +1,17 @@ # Neoom Beaam Input Plugin -This plugin reads metrics from the Neoom Beaam gateway using the -[Beaam API][BeaamAPI]. Usually an access token is required which can be created -in the Neoom web interface. Please follow the [developer instructions][DevPage] -to create the token! +This plugin gathers metrics from a [Neoom Beaam gateway][beaam] using the +[Beaam API][beaam_api] with access token that can be created in the Neoom web +interface. Please follow the [developer instructions][devpage] to create the +token. -[BeaamAPI]: https://developer.neoom.com/reference/concepts-terms-1 -[DevPage]:https://neoom.com/developers +⭐ Telegraf v1.33.0 +🏷️ iot +πŸ’» all + +[beaam]: https://neoom.com/en/products/beaam +[beaam_api]: https://developer.neoom.com/reference/concepts-terms-1 +[devpage]:https://neoom.com/developers ## Global configuration options diff --git a/plugins/inputs/neptune_apex/README.md b/plugins/inputs/neptune_apex/README.md index c3ab29317..2de1ff53d 100644 --- a/plugins/inputs/neptune_apex/README.md +++ b/plugins/inputs/neptune_apex/README.md @@ -1,12 +1,14 @@ # Neptune Apex Input Plugin -The Neptune Apex controller family allows an aquarium hobbyist to monitor and -control their tanks based on various probes. The data is taken directly from the -`/cgi-bin/status.xml` at the interval specified in the telegraf.conf -configuration file. +This plugin gathers metrics from [Neptune Apex controller][neptune] instances, +allowing aquarium hobbyists to monitor and control their tanks based on various +probes. -The [Neptune Apex](https://www.neptunesystems.com/) input plugin collects -real-time data from the Apex's status.xml page. +⭐ Telegraf v1.10.0 +🏷️ iot +πŸ’» all + +[neptune]: https://www.neptunesystems.com ## Global configuration options @@ -36,6 +38,30 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ``` +## Troubleshooting + +### sendRequest failure + +This indicates a problem communicating with the local Apex controller. If on +Mac/Linux, try curl: + +```sh +curl apex.local/cgi-bin/status.xml +``` + +to isolate the problem. + +### parseXML errors + +Ensure the XML being returned is valid. If you get valid XML back, open a bug +request. + +### Missing fields/data + +The neptune_apex plugin is strict on its input to prevent any conversion +errors. If you have fields in the status.xml output that are not converted to a +metric, open a feature request and paste your whole status.xml + ## Metrics The Neptune Apex controller family allows an aquarium hobbyist to monitor and @@ -80,38 +106,6 @@ considered a convenience rather than authoritative. - The time used for the metric is parsed from the status.xml page. This helps when cross-referencing events with the local system of Apex Fusion. Since the Apex uses NTP, this should not matter in most scenarios. -## Sample Queries - -Get the max, mean, and min for the temperature in the last hour: - -```sql -SELECT mean("value") FROM "neptune_apex" WHERE ("probe_type" = 'Temp') AND time >= now() - 6h GROUP BY time(20s) -``` - -## Troubleshooting - -### sendRequest failure - -This indicates a problem communicating with the local Apex controller. If on -Mac/Linux, try curl: - -```sh -curl apex.local/cgi-bin/status.xml -``` - -to isolate the problem. - -### parseXML errors - -Ensure the XML being returned is valid. If you get valid XML back, open a bug -request. - -### Missing fields/data - -The neptune_apex plugin is strict on its input to prevent any conversion -errors. If you have fields in the status.xml output that are not converted to a -metric, open a feature request and paste your whole status.xml - ## Example Output ```text diff --git a/plugins/inputs/net/README.md b/plugins/inputs/net/README.md index 02cfe91ce..f67656c20 100644 --- a/plugins/inputs/net/README.md +++ b/plugins/inputs/net/README.md @@ -1,7 +1,10 @@ -# Net Input Plugin +# Network Input Plugin -This plugin gathers metrics about network interface and protocol usage (Linux -only). +This plugin gathers metrics about network interface and protocol usage. + +⭐ Telegraf v0.1.1 +🏷️ network +πŸ’» all ## Global configuration options @@ -63,35 +66,22 @@ silently. [source]: https://elixir.bootlin.com/linux/latest/source/net/ipv4/proc.c -## Tags +Tags: * Net measurements have the following tags: * interface (the interface from which metrics are gathered) Under Linux the system wide protocol metrics have the interface=all tag. -## Sample Queries - -You can use the following query to get the upload/download traffic rate per -second for all interfaces in the last hour. The query uses the [derivative -function][deriv] which calculates the rate of change between subsequent field -values. - -[deriv]: https://docs.influxdata.com/influxdb/v1.2/query_language/functions#derivative - -```sql -SELECT derivative(first(bytes_recv), 1s) as "download bytes/sec", derivative(first(bytes_sent), 1s) as "upload bytes/sec" FROM net WHERE time > now() - 1h AND interface != 'all' GROUP BY time(10s), interface fill(0); -``` - ## Example Output -### All platforms +All platforms provide metrics like the following: ```text net,interface=eth0,host=HOST bytes_sent=451838509i,bytes_recv=3284081640i,packets_sent=2663590i,packets_recv=3585442i,err_in=0i,err_out=0i,drop_in=4i,drop_out=0i 1492834180000000000 ``` -### Linux +On Linux additional metrics might be provided: ```text net,interface=eth0,host=HOST bytes_sent=451838509i,bytes_recv=3284081640i,packets_sent=2663590i,packets_recv=3585442i,err_in=0i,err_out=0i,drop_in=4i,drop_out=0i 1492834180000000000 diff --git a/plugins/inputs/net_response/README.md b/plugins/inputs/net_response/README.md index 017571e1f..4f500103a 100644 --- a/plugins/inputs/net_response/README.md +++ b/plugins/inputs/net_response/README.md @@ -1,7 +1,11 @@ # Network Response Input Plugin -The input plugin test UDP/TCP connections response time and can optional -verify text in the response. +This plugin tests UDP/TCP connection and produces metrics from the result, the +response time and optionally verifies text in the response. + +⭐ Telegraf v0.10.3 +🏷️ network +πŸ’» all ## Global configuration options diff --git a/plugins/inputs/netflow/README.md b/plugins/inputs/netflow/README.md index c8278acb2..7454cbabe 100644 --- a/plugins/inputs/netflow/README.md +++ b/plugins/inputs/netflow/README.md @@ -1,6 +1,6 @@ # Netflow Input Plugin -The `netflow` plugin acts as a collector for Netflow v5, Netflow v9 and IPFIX +This service plugin acts as a collector for Netflow v5, Netflow v9 and IPFIX flow information. The Layer 4 protocol numbers are gathered from the [official IANA assignments][IANA assignments]. The internal field mappings for Netflow v5 fields are defined according to @@ -9,6 +9,10 @@ according to [Cisco's Netflow v9 documentation][CISCO NF9] and the [ASA extensions][ASA extensions]. Definitions for IPFIX are according to [IANA assignment document][IPFIX doc]. +⭐ Telegraf v1.25.0 +🏷️ network +πŸ’» all + [IANA assignments]: https://www.iana.org/assignments/protocol-numbers/protocol-numbers.xhtml [CISCO NF5]: https://www.cisco.com/c/en/us/td/docs/net_mgmt/netflow_collection_engine/3-6/user/guide/format.html#wp1006186 [CISCO NF9]: https://www.cisco.com/en/US/technologies/tk648/tk362/technologies_white_paper09186a00800a3db9.html diff --git a/plugins/inputs/netstat/README.md b/plugins/inputs/netstat/README.md index c76185cc2..f27fd81ea 100644 --- a/plugins/inputs/netstat/README.md +++ b/plugins/inputs/netstat/README.md @@ -1,7 +1,11 @@ -# Netstat Input Plugin +# Network Connection Statistics Input Plugin -This plugin collects TCP connections state and UDP socket counts by using -`lsof`. +This plugin collects statistics about TCP connection states and UDP socket +counts. + +⭐ Telegraf v0.2.0 +🏷️ network +πŸ’» all ## Global configuration options @@ -37,7 +41,7 @@ Supported TCP Connection states are follows. - closing - none -## TCP Connection State measurements +### TCP Connection State measurements Meta: @@ -60,7 +64,7 @@ Measurement names: If there are no connection on the state, the metric is not counted. -## UDP socket counts measurements +### UDP socket counts measurements Meta: diff --git a/plugins/inputs/nfsclient/README.md b/plugins/inputs/nfsclient/README.md index 9da100145..3b05f6e56 100644 --- a/plugins/inputs/nfsclient/README.md +++ b/plugins/inputs/nfsclient/README.md @@ -1,15 +1,22 @@ -# NFS Client Input Plugin +# Network Filesystem Input Plugin -The NFS Client input plugin collects data from /proc/self/mountstats. By -default, only a limited number of general system-level metrics are collected, -including basic read/write counts. If `fullstat` is set, a great deal of -additional metrics are collected, detailed below. +This plugin collects metrics about operations on [Network Filesystem][nfs] +mounts. By default, only a limited number of general system-level metrics are +collected, including basic read/write counts but more detailed metrics can be +enabled. -__NOTE__ Many of the metrics, even if tagged with a mount point, are really -_per-server_. Thus, if you mount these two shares: `nfs01:/vol/foo/bar` and -`nfs01:/vol/foo/baz`, there will be two near identical entries in -/proc/self/mountstats. This is a limitation of the metrics exposed by the -kernel, not the telegraf plugin. +> [!NOTE] +> Many of the metrics, even if tagged with a mount point, are really +> _per-server_. E.g. if you mount two shares: `nfs01:/vol/foo/bar` and +> `nfs01:/vol/foo/baz`, there will be two near identical entries in +> `/proc/self/mountstats`. This is a limitation of the metrics exposed by the +> kernel, not by this plugin. + +⭐ Telegraf v1.18.0 +🏷️ network, system +πŸ’» all + +[nfs]: https://www.ietf.org/rfc/rfc1813.txt?number=1813 ## Global configuration options @@ -54,48 +61,56 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ### Configuration Options -- __fullstat__ bool: Collect per-operation type metrics. Defaults to false. -- __include_mounts__ list(string): gather metrics for only these mounts. Default is to watch all mounts. -- __exclude_mounts__ list(string): gather metrics for all mounts, except those listed in this option. Excludes take precedence over includes. -- __include_operations__ list(string): List of specific NFS operations to track. See /proc/self/mountstats (the "per-op statistics" section) for complete lists of valid options for NFSv3 and NFSV4. The default is to gather all metrics, but this is almost certainly _not_ what you want (there are 22 operations for NFSv3, and well over 50 for NFSv4). A suggested 'minimal' list of operations to collect for basic usage: `['READ','WRITE','ACCESS','GETATTR','READDIR','LOOKUP','LOOKUP']` -- __exclude_operations__ list(string): Gather all metrics, except those listed. Excludes take precedence over includes. +- `fullstat`: Collect per-operation type metrics. Defaults to false. +- `include_mounts`: gather metrics for only these mounts. Default is to watch + all mounts. +- `exclude_mounts`: gather metrics for all mounts, except those listed in this + option. Excludes take precedence over includes. +- `include_operations`: List of specific NFS operations to track. See + `/proc/self/mountstats` (the "per-op statistics" section) for a complete + lists of valid options for NFSv3 and NFSV4. The default is to gather all + metrics, but this is almost certainly _not_ what you want (there are + 22 operations for NFSv3, and well over 50 for NFSv4). A suggested 'minimal' + list of operations to collect for basic usage: + `['READ','WRITE','ACCESS','GETATTR','READDIR','LOOKUP','LOOKUP']` +- `exclude_operations`: Gather all metrics, except those listed. Excludes take + precedence over includes. -_N.B._ the `include_mounts` and `exclude_mounts` arguments are both applied to -the local mount location (e.g. /mnt/NFS), not the server export -(e.g. nfsserver:/vol/NFS). Go regexp patterns can be used in either. +> [!NOTE] +> The `include_mounts` and `exclude_mounts` arguments are both applied to the +> local mount location (e.g. /mnt/NFS), not the server export (e.g. +> nfsserver:/vol/NFS). Go regexp patterns can be used in either. ## Location of mountstats -If you have mounted the /proc file system in a container, to tell this plugin +If you have mounted the `/proc` file system in a container, to tell this plugin where to find the new location, set the `MOUNT_PROC` environment variable. For -example, in a Docker compose file, if /proc is mounted to /host/proc, then use: +example, in a Docker compose file, if `/proc` is mounted to `/host/proc`, then +use: ```yaml MOUNT_PROC: /host/proc/self/mountstats ``` -### References - -1. [nfsiostat](http://git.linux-nfs.org/?p=steved/nfs-utils.git;a=summary) -2. [net/sunrpc/stats.c - Linux source code](https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/net/sunrpc/stats.c) -3. [What is in /proc/self/mountstats for NFS mounts: an introduction](https://utcc.utoronto.ca/~cks/space/blog/linux/NFSMountstatsIndex) -4. [The xprt: data for NFS mounts in /proc/self/mountstats](https://utcc.utoronto.ca/~cks/space/blog/linux/NFSMountstatsXprt) - ## Metrics -### Fields +Fields: - nfsstat - - bytes (integer, bytes) - The total number of bytes exchanged doing this operation. This is bytes sent _and_ received, including overhead _and_ payload. (bytes = OP_bytes_sent + OP_bytes_recv. See nfs_ops below) + - bytes (integer, bytes) - The total number of bytes exchanged doing this + operation. This is bytes sent _and_ received, including overhead _and_ + payload (`bytes = OP_bytes_sent + OP_bytes_recv`). See `nfs_ops` below. - ops (integer, count) - The number of operations of this type executed. - - retrans (integer, count) - The number of times an operation had to be retried (retrans = OP_trans - OP_ops. See nfs_ops below) - - exe (integer, milliseconds) - The number of milliseconds it took to process the operations. + - retrans (integer, count) - The number of times an operation had to be + (`retried retrans = OP_trans - OP_ops`). See `nfs_ops` below. + - exe (integer, milliseconds) - The number of milliseconds it took to process + the operations. - rtt (integer, milliseconds) - The total round-trip time for all operations. - rtt_per_op (float, milliseconds) - The average round-trip time per operation. In addition enabling `fullstat` will make many more metrics available. -### Tags +Tags: - All measurements have the following tags: - mountpoint - The local mountpoint, for instance: "/var/www" @@ -104,12 +119,12 @@ In addition enabling `fullstat` will make many more metrics available. - Measurements nfsstat and nfs_ops will also include: - operation - the NFS operation in question. `READ` or `WRITE` for nfsstat, but potentially one of ~20 or ~50, depending on NFS version. A complete list of operations supported is visible in `/proc/self/mountstats`. -## Additional metrics +### Additional metrics When `fullstat` is true, additional measurements are collected. Tags are the same as above. -### NFS Operations +NFS Operations: Most descriptions come from [Reference][ref] and `nfs_iostat.h`. Field order and names are the same as in `/proc/self/mountstats` and the Kernel source. diff --git a/plugins/inputs/nginx/README.md b/plugins/inputs/nginx/README.md index 8dd6d3a6c..dc94d896d 100644 --- a/plugins/inputs/nginx/README.md +++ b/plugins/inputs/nginx/README.md @@ -1,10 +1,15 @@ # Nginx Input Plugin -This plugin gathers basic status from the open source web server Nginx. Nginx -Plus is a commercial version. For more information about the differences between -Nginx (F/OSS) and Nginx Plus, see the Nginx [documentation][diff-doc]. +This plugin gathers metrics from the open source [Nginx web server][nginx]. +Nginx Plus is a commercial version. For more information about differences +between Nginx (F/OSS) and Nginx Plus, see the Nginx [documentation][diff_doc]. -[diff-doc]: https://www.nginx.com/blog/whats-difference-nginx-foss-nginx-plus/ +⭐ Telegraf v0.1.5 +🏷️ server, web +πŸ’» all + +[nginx]: https://www.nginx.com +[diff_doc]: https://www.nginx.com/blog/whats-difference-nginx-foss-nginx-plus/ ## Global configuration options diff --git a/plugins/inputs/nginx_plus/README.md b/plugins/inputs/nginx_plus/README.md index 8d9d97437..b4f05e5e6 100644 --- a/plugins/inputs/nginx_plus/README.md +++ b/plugins/inputs/nginx_plus/README.md @@ -1,15 +1,21 @@ # Nginx Plus Input Plugin -Nginx Plus is a commercial version of the open source web server Nginx. The use -this plugin you will need a license. For more information about the differences -between Nginx (F/OSS) and Nginx Plus, see the Nginx [documentation][diff-doc]. +This plugin gathers metrics from the commercial +[Nginx Plus web server][nginx_plus] via the [status module][status_module]. -Structures for Nginx Plus have been built based on history of [status module -documentation][status-mod]. +> [!NOTE] +> Using this plugin requires a license. -[diff-doc]: https://www.nginx.com/blog/whats-difference-nginx-foss-nginx-plus/ +For more information about differences between Nginx (F/OSS) and Nginx Plus, see +the Nginx [documentation][diff_doc]. -[status-mod]: http://nginx.org/en/docs/http/ngx_http_status_module.html +⭐ Telegraf v1.5.0 +🏷️ server, web +πŸ’» all + +[nginx_plus]: https://www.f5.com/products/nginx/nginx-plus +[status_module]: http://nginx.org/en/docs/http/ngx_http_status_module.html +[diff_doc]: https://www.nginx.com/blog/whats-difference-nginx-foss-nginx-plus/ ## Global configuration options diff --git a/plugins/inputs/nginx_plus_api/README.md b/plugins/inputs/nginx_plus_api/README.md index 081ef0a9c..6f081d20f 100644 --- a/plugins/inputs/nginx_plus_api/README.md +++ b/plugins/inputs/nginx_plus_api/README.md @@ -1,10 +1,21 @@ # Nginx Plus API Input Plugin -Nginx Plus is a commercial version of the open source web server Nginx. The use -this plugin you will need a license. For more information about the differences -between Nginx (F/OSS) and Nginx Plus, see the Nginx [documentation][diff-doc]. +This plugin gathers metrics from the commercial +[Nginx Plus web server][nginx_plus] via the [REST API][api]. -[diff-doc]: https://www.nginx.com/blog/whats-difference-nginx-foss-nginx-plus/ +> [!NOTE] +> Using this plugin requires a license. + +For more information about differences between Nginx (F/OSS) and Nginx Plus, see +the Nginx [documentation][diff_doc]. + +⭐ Telegraf v1.9.0 +🏷️ server, web +πŸ’» all + +[nginx_plus]: https://www.f5.com/products/nginx/nginx-plus +[api]: https://demo.nginx.com/swagger-ui/ +[diff_doc]: https://www.nginx.com/blog/whats-difference-nginx-foss-nginx-plus/ ## Global configuration options diff --git a/plugins/inputs/nginx_sts/README.md b/plugins/inputs/nginx_sts/README.md index f54d8fb9a..4a205e666 100644 --- a/plugins/inputs/nginx_sts/README.md +++ b/plugins/inputs/nginx_sts/README.md @@ -1,13 +1,19 @@ -# Nginx Stream STS Input Plugin +# Nginx Stream Server Traffic Input Plugin -This plugin gathers Nginx status using external virtual host traffic status -module - . This is an Nginx module -that provides access to stream host status information. It contains the current -status such as servers, upstreams, caches. This is similar to the live activity -monitoring of Nginx plus. For module configuration details please see its -[documentation](https://github.com/vozlt/nginx-module-sts#synopsis). +This plugin gathers metrics from the [Nginx web server][nginx] using the +[external stream server traffic status module][ssts_module]. This module provides +access to stream host status information containing the current status of +servers, upstreams and caches, similar to the live activity monitoring of +Nginx plus. For module configuration details please see the +[module documentation][module_doc]. -Telegraf minimum version: Telegraf 1.15.0 +⭐ Telegraf v1.15.0 +🏷️ server, web +πŸ’» all + +[nginx]: https://www.nginx.com +[ssts_module]: https://github.com/vozlt/nginx-module-sts +[module_doc]: https://github.com/vozlt/nginx-module-sts#synopsis ## Global configuration options diff --git a/plugins/inputs/nginx_upstream_check/README.md b/plugins/inputs/nginx_upstream_check/README.md index ba6e70c89..4bf6e1d1d 100644 --- a/plugins/inputs/nginx_upstream_check/README.md +++ b/plugins/inputs/nginx_upstream_check/README.md @@ -1,16 +1,16 @@ # Nginx Upstream Check Input Plugin -Read the status output of the [nginx_upstream_check][1]. This module can -periodically check the servers in the Nginx's upstream with configured request -and interval to determine if the server is still available. If checks are failed -the server is marked as "down" and will not receive any requests until the check -will pass and a server will be marked as "up" again. +This plugin gathers metrics from the [Nginx web server][nginx] using the +[upstream check module][upstream_check_module]. This module periodically sends +the configured requests to servers in the Nginx's upstream determining their +availability. -The status page displays the current status of all upstreams and servers as well -as number of the failed and successful checks. This information can be exported -in JSON format and parsed by this input. +⭐ Telegraf v1.10.0 +🏷️ server, web +πŸ’» all -[1]: https://github.com/yaoweibin/nginx_upstream_check_module +[nginx]: https://www.nginx.com +[upstream_check_module]: https://github.com/yaoweibin/nginx_upstream_check_module ## Global configuration options diff --git a/plugins/inputs/nginx_vts/README.md b/plugins/inputs/nginx_vts/README.md index 5f6e5b5cc..0168ce973 100644 --- a/plugins/inputs/nginx_vts/README.md +++ b/plugins/inputs/nginx_vts/README.md @@ -1,11 +1,19 @@ -# Nginx Virtual Host Traffic (VTS) Input Plugin +# Nginx Virtual Host Traffic Input Plugin -This plugin gathers Nginx status using external virtual host traffic status -module - . This is an Nginx module -that provides access to virtual host status information. It contains the current -status such as servers, upstreams, caches. This is similar to the live activity -monitoring of Nginx plus. For module configuration details please see its -[documentation](https://github.com/vozlt/nginx-module-vts#synopsis). +This plugin gathers metrics from the [Nginx web server][nginx] using the +[external virtual host traffic status module][vhts_module]. This module provides +access to virtual host status information containing the current status of +servers, upstreams and caches, similar to the live activity monitoring of +Nginx plus. For module configuration details please see the +[module documentation][module_doc]. + +⭐ Telegraf v1.9.0 +🏷️ server, web +πŸ’» all + +[nginx]: https://www.nginx.com +[vhts_module]: https://github.com/vozlt/nginx-module-vts +[module_doc]: https://github.com/vozlt/nginx-module-vts#synopsis ## Global configuration options diff --git a/plugins/inputs/nomad/README.md b/plugins/inputs/nomad/README.md index 94769bc83..bb32c5a66 100644 --- a/plugins/inputs/nomad/README.md +++ b/plugins/inputs/nomad/README.md @@ -1,10 +1,13 @@ # Hashicorp Nomad Input Plugin -The Nomad plugin must grab metrics from every Nomad agent of the -cluster. Telegraf may be present in every node and connect to the agent -locally. In this case should be something like `http://127.0.0.1:4646`. +This plugin collects metrics from every [Nomad agent][nomad] of the specified +cluster. Telegraf may be present in every node and connect to the agent locally. -> Tested on Nomad 1.1.6 +⭐ Telegraf v1.22.0 +🏷️ server +πŸ’» all + +[nomad]: https://www.nomadproject.io/ ## Global configuration options @@ -35,9 +38,12 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ## Metrics Both Nomad servers and agents collect various metrics. For every details, please -have a look at Nomad following documentation: +have a look at [Nomad metrics][metrics] and [Nomad telemetry][telemetry] +ocumentation. -- [https://www.nomadproject.io/docs/operations/metrics](https://www.nomadproject.io/docs/operations/metrics) -- [https://www.nomadproject.io/docs/operations/telemetry](https://www.nomadproject.io/docs/operations/telemetry) +[metrics]: https://www.nomadproject.io/docs/operations/metrics +[telemetry]: https://www.nomadproject.io/docs/operations/telemetry ## Example Output + +There is no predefined metric format, so output depends on plugin input. diff --git a/plugins/inputs/nsd/README.md b/plugins/inputs/nsd/README.md index 4c0b005a1..50bd7977e 100644 --- a/plugins/inputs/nsd/README.md +++ b/plugins/inputs/nsd/README.md @@ -1,8 +1,13 @@ -# NSD Input Plugin +# NLnet Labs Name Server Daemon Input Plugin -This plugin gathers stats from -[NSD](https://www.nlnetlabs.nl/projects/nsd/about) - an authoritative DNS name -server. +This plugin gathers statistics from a [NLnet Labs Name Server Daemon][nsd], an +authoritative DNS name server. + +⭐ Telegraf v1.0.0 +🏷️ server +πŸ’» all + +[nsd]: https://www.nlnetlabs.nl/projects/nsd/about ## Global configuration options diff --git a/plugins/inputs/nsdp/README.md b/plugins/inputs/nsdp/README.md index c0f07bc88..2e7bd312f 100644 --- a/plugins/inputs/nsdp/README.md +++ b/plugins/inputs/nsdp/README.md @@ -1,8 +1,7 @@ # Netgear Switch Discovery Protocol Input Plugin -This plugin gathers metrics from devices via -[Netgear Switch Discovery Protocol (NSDP)][nsdp] -for all available switches and ports. +This plugin gathers metrics from devices via the +[Netgear Switch Discovery Protocol][nsdp] for all available switches and ports. ⭐ Telegraf v1.34.0 🏷️ network diff --git a/plugins/inputs/nsq/README.md b/plugins/inputs/nsq/README.md index 0c62abac5..832fcfa1b 100644 --- a/plugins/inputs/nsq/README.md +++ b/plugins/inputs/nsq/README.md @@ -1,9 +1,14 @@ # NSQ Input Plugin -This plugin gathers metrics from [NSQ](https://nsq.io/). +This plugin gathers metrics from [NSQ][nsq] realtime distributed messaging +platform instances using the [NSQD API][api]. -See the [NSQD API docs](https://nsq.io/components/nsqd.html) for endpoints that -the plugin can read. +⭐ Telegraf v1.16.0 +🏷️ server +πŸ’» all + +[nsq]: https://nsq.io/ +[api]: https://nsq.io/components/nsqd.html ## Global configuration options @@ -32,4 +37,68 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ## Metrics +- `nsq_server`: + - tags: + - `server_host` + - `server_version` + - fields: + - `server_count` + - `topic_count` +- `nsq_topic`: + - tags: + - `server_host` + - `server_version` + - `topic` + - fields: + - `backend_depth` + - `channel_count` + - `depth` + - `message_count` +- `nsq_channel`: + - tags: + - `server_host` + - `server_version` + - `topic` + - `channel` + - fields: + - `backend_depth` + - `client_count` + - `depth` + - `deferred_count` + - `inflight_count` + - `message_count` + - `requeue_count` + - `timeout_count` +- `nsq_client`: + - tags: + - `channel` + - `client_address` + - `client_hostname` + - `client_id` + - `client_name` + - `client_user_agent` + - `client_deflate` + - `client_snappy` + - `client_tls` + - `client_version` + - `server_host` + - `server_version` + - `topic` + - fields: + - `finish_count` + - `inflight_count` + - `message_count` + - `ready_count` + - `requeue_count` + ## Example Output + +```text +nsq_server,server_host=127.0.0.1:35871,server_version=0.3.6 server_count=1i,topic_count=2i 1742836824386224245 +nsq_topic,server_host=127.0.0.1:35871,server_version=0.3.6,topic=t1 backend_depth=13i,channel_count=1i,depth=12i,message_count=14i 1742836824386235365 +nsq_channel,channel=c1,server_host=127.0.0.1:35871,server_version=0.3.6,topic=t1 backend_depth=1i,client_count=1i,deferred_count=3i,depth=0i,inflight_count=2i,message_count=4i,requeue_count=5i,timeout_count=6i 1742836824386241985 +nsq_client,channel=c1,client_address=172.17.0.11:35560,client_deflate=false,client_hostname=373a715cd990,client_id=373a715cd990,client_name=373a715cd990,client_snappy=false,client_tls=false,client_user_agent=nsq_to_nsq/0.3.6\ go-nsq/1.0.5,client_version=V2,server_host=127.0.0.1:35871,server_version=0.3.6,topic=t1 finish_count=9i,inflight_count=7i,message_count=8i,ready_count=200i,requeue_count=10i 1742836824386252905 +nsq_topic,server_host=127.0.0.1:35871,server_version=0.3.6,topic=t2 backend_depth=29i,channel_count=1i,depth=28i,message_count=30i 1742836824386263806 +nsq_channel,channel=c2,server_host=127.0.0.1:35871,server_version=0.3.6,topic=t2 backend_depth=16i,client_count=1i,deferred_count=18i,depth=15i,inflight_count=17i,message_count=19i,requeue_count=20i,timeout_count=21i 1742836824386270026 +nsq_client,channel=c2,client_address=172.17.0.8:48145,client_deflate=true,client_hostname=377569bd462b,client_id=377569bd462b,client_name=377569bd462b,client_snappy=true,client_tls=true,client_user_agent=go-nsq/1.0.5,client_version=V2,server_host=127.0.0.1:35871,server_version=0.3.6,topic=t2 finish_count=25i,inflight_count=23i,message_count=24i,ready_count=22i,requeue_count=26i 1742836824386277926 +``` diff --git a/plugins/inputs/nsq_consumer/README.md b/plugins/inputs/nsq_consumer/README.md index babf3e432..b04eb8bf4 100644 --- a/plugins/inputs/nsq_consumer/README.md +++ b/plugins/inputs/nsq_consumer/README.md @@ -1,7 +1,14 @@ # NSQ Consumer Input Plugin -The [NSQ][nsq] consumer plugin reads from NSQD and creates metrics using one -of the supported [input data formats][]. +This service plugin consumes messages from [NSQ][nsq] realtime distributed +messaging platform brokers in one of the supported [data formats][data_formats]. + +⭐ Telegraf v0.10.1 +🏷️ messaging +πŸ’» all + +[nsq]: https://nsq.io/ +[data_formats]: /docs/DATA_FORMATS_INPUT.md ## Service Input @@ -56,9 +63,11 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. data_format = "influx" ``` -[nsq]: https://nsq.io -[input data formats]: /docs/DATA_FORMATS_INPUT.md - ## Metrics +The plugin accepts arbitrary input and parses it according to the `data_format` +setting. There is no predefined metric format. + ## Example Output + +There is no predefined metric format, so output depends on plugin input. diff --git a/plugins/inputs/nstat/README.md b/plugins/inputs/nstat/README.md index 925ac5d85..754254cbe 100644 --- a/plugins/inputs/nstat/README.md +++ b/plugins/inputs/nstat/README.md @@ -1,7 +1,11 @@ -# Nstat Input Plugin +# Kernel Network Statistics Input Plugin -Plugin collects network metrics from `/proc/net/netstat`, `/proc/net/snmp` and -`/proc/net/snmp6` files +This plugin collects network metrics from `/proc/net/netstat`, `/proc/net/snmp` +and `/proc/net/snmp6` files + +⭐ Telegraf v0.13.1 +🏷️ network, system +πŸ’» all ## Global configuration options @@ -362,3 +366,12 @@ error would be raised. * name (the type of the metric: snmp, snmp6 or netstat) ## Example Output + +```text +> nstat,host=Hugin,name=netstat IpExtInBcastOctets=2142i,IpExtInBcastPkts=1i,IpExtInCEPkts=0i,IpExtInCsumErrors=0i,IpExtInECT0Pkts=0i,IpExtInECT1Pkts=0i,IpExtInMcastOctets=2636i,IpExtInMcastPkts=14i,IpExtInNoECTPkts=234065i,IpExtInNoRoutes=2i,IpExtInOctets=135040263i,IpExtInTruncatedPkts=0i,IpExtOutBcastOctets=2162i,IpExtOutBcastPkts=2i,IpExtOutMcastOctets=3196i,IpExtOutMcastPkts=28i,IpExtOutOctets=45962238i,IpExtReasmOverlaps=0i,MPTcpExtAddAddr=0i,MPTcpExtAddAddrDrop=0i,MPTcpExtAddAddrTx=0i,MPTcpExtAddAddrTxDrop=0i,MPTcpExtBlackhole=0i,MPTcpExtDSSCorruptionFallback=0i,MPTcpExtDSSCorruptionReset=0i,MPTcpExtDSSNoMatchTCP=0i,MPTcpExtDSSNotMatching=0i,MPTcpExtDataCsumErr=0i,MPTcpExtDuplicateData=0i,MPTcpExtEchoAdd=0i,MPTcpExtEchoAddTx=0i,MPTcpExtEchoAddTxDrop=0i,MPTcpExtInfiniteMapRx=0i,MPTcpExtInfiniteMapTx=0i,MPTcpExtMPCapableACKRX=0i,MPTcpExtMPCapableEndpAttempt=0i,MPTcpExtMPCapableFallbackACK=0i,MPTcpExtMPCapableFallbackSYNACK=0i,MPTcpExtMPCapableSYNACKRX=0i,MPTcpExtMPCapableSYNRX=0i,MPTcpExtMPCapableSYNTX=0i,MPTcpExtMPCapableSYNTXDisabled=0i,MPTcpExtMPCapableSYNTXDrop=0i,MPTcpExtMPCurrEstab=0i,MPTcpExtMPFailRx=0i,MPTcpExtMPFailTx=0i,MPTcpExtMPFallbackTokenInit=0i,MPTcpExtMPFastcloseRx=0i,MPTcpExtMPFastcloseTx=0i,MPTcpExtMPJoinAckHMacFailure=0i,MPTcpExtMPJoinAckRx=0i,MPTcpExtMPJoinNoTokenFound=0i,MPTcpExtMPJoinPortAckRx=0i,MPTcpExtMPJoinPortSynAckRx=0i,MPTcpExtMPJoinPortSynRx=0i,MPTcpExtMPJoinSynAckBackupRx=0i,MPTcpExtMPJoinSynAckHMacFailure=0i,MPTcpExtMPJoinSynAckRx=0i,MPTcpExtMPJoinSynBackupRx=0i,MPTcpExtMPJoinSynRx=0i,MPTcpExtMPJoinSynTx=0i,MPTcpExtMPJoinSynTxBindErr=0i,MPTcpExtMPJoinSynTxConnectErr=0i,MPTcpExtMPJoinSynTxCreatSkErr=0i,MPTcpExtMPPrioRx=0i,MPTcpExtMPPrioTx=0i,MPTcpExtMPRstRx=0i,MPTcpExtMPRstTx=0i,MPTcpExtMPTCPRetrans=0i,MPTcpExtMismatchPortAckRx=0i,MPTcpExtMismatchPortSynRx=0i,MPTcpExtNoDSSInWindow=0i,MPTcpExtOFOMerge=0i,MPTcpExtOFOQueue=0i,MPTcpExtOFOQueueTail=0i,MPTcpExtPortAdd=0i,MPTcpExtRcvPruned=0i,MPTcpExtRcvWndConflict=0i,MPTcpExtRcvWndConflictUpdate=0i,MPTcpExtRcvWndShared=0i,MPTcpExtRmAddr=0i,MPTcpExtRmAddrDrop=0i,MPTcpExtRmAddrTx=0i,MPTcpExtRmAddrTxDrop=0i,MPTcpExtRmSubflow=0i,MPTcpExtSndWndShared=0i,MPTcpExtSubflowRecover=0i,MPTcpExtSubflowStale=0i,TcpExtArpFilter=0i,TcpExtBusyPollRxPackets=0i,TcpExtDelayedACKLocked=1i,TcpExtDelayedACKLost=123i,TcpExtDelayedACKs=1313i,TcpExtEmbryonicRsts=0i,TcpExtIPReversePathFilter=0i,TcpExtListenDrops=0i,TcpExtListenOverflows=0i,TcpExtLockDroppedIcmps=0i,TcpExtOfoPruned=0i,TcpExtOutOfWindowIcmps=0i,TcpExtPAWSActive=0i,TcpExtPAWSEstab=0i,TcpExtPFMemallocDrop=0i,TcpExtPruneCalled=0i,TcpExtRcvPruned=0i,TcpExtSyncookiesFailed=0i,TcpExtSyncookiesRecv=0i,TcpExtSyncookiesSent=0i,TcpExtTCPACKSkippedChallenge=0i,TcpExtTCPACKSkippedFinWait2=0i,TcpExtTCPACKSkippedPAWS=0i,TcpExtTCPACKSkippedSeq=1i,TcpExtTCPACKSkippedSynRecv=0i,TcpExtTCPACKSkippedTimeWait=0i,TcpExtTCPAOBad=0i,TcpExtTCPAODroppedIcmps=0i,TcpExtTCPAOGood=0i,TcpExtTCPAOKeyNotFound=0i,TcpExtTCPAORequired=0i,TcpExtTCPAbortFailed=0i,TcpExtTCPAbortOnClose=132i,TcpExtTCPAbortOnData=457i,TcpExtTCPAbortOnLinger=0i,TcpExtTCPAbortOnMemory=0i,TcpExtTCPAbortOnTimeout=0i,TcpExtTCPAckCompressed=15i,TcpExtTCPAutoCorking=1471i,TcpExtTCPBacklogCoalesce=113i,TcpExtTCPBacklogDrop=0i,TcpExtTCPChallengeACK=0i,TcpExtTCPDSACKIgnoredDubious=0i,TcpExtTCPDSACKIgnoredNoUndo=65i,TcpExtTCPDSACKIgnoredOld=0i,TcpExtTCPDSACKOfoRecv=0i,TcpExtTCPDSACKOfoSent=0i,TcpExtTCPDSACKOldSent=123i,TcpExtTCPDSACKRecv=78i,TcpExtTCPDSACKRecvSegs=78i,TcpExtTCPDSACKUndo=0i,TcpExtTCPDeferAcceptDrop=0i,TcpExtTCPDelivered=95905i,TcpExtTCPDeliveredCE=0i,TcpExtTCPFastOpenActive=0i,TcpExtTCPFastOpenActiveFail=0i,TcpExtTCPFastOpenBlackhole=0i,TcpExtTCPFastOpenCookieReqd=0i,TcpExtTCPFastOpenListenOverflow=0i,TcpExtTCPFastOpenPassive=0i,TcpExtTCPFastOpenPassiveAltKey=0i,TcpExtTCPFastOpenPassiveFail=0i,TcpExtTCPFastRetrans=3i,TcpExtTCPFromZeroWindowAdv=1i,TcpExtTCPFullUndo=2i,TcpExtTCPHPAcks=40380i,TcpExtTCPHPHits=46243i,TcpExtTCPHystartDelayCwnd=81i,TcpExtTCPHystartDelayDetect=3i,TcpExtTCPHystartTrainCwnd=0i,TcpExtTCPHystartTrainDetect=0i,TcpExtTCPKeepAlive=2816i,TcpExtTCPLossFailures=0i,TcpExtTCPLossProbeRecovery=0i,TcpExtTCPLossProbes=85i,TcpExtTCPLossUndo=0i,TcpExtTCPLostRetransmit=0i,TcpExtTCPMD5Failure=0i,TcpExtTCPMD5NotFound=0i,TcpExtTCPMD5Unexpected=0i,TcpExtTCPMTUPFail=0i,TcpExtTCPMTUPSuccess=0i,TcpExtTCPMemoryPressures=0i,TcpExtTCPMemoryPressuresChrono=0i,TcpExtTCPMigrateReqFailure=0i,TcpExtTCPMigrateReqSuccess=0i,TcpExtTCPMinTTLDrop=0i,TcpExtTCPOFODrop=0i,TcpExtTCPOFOMerge=0i,TcpExtTCPOFOQueue=509i,TcpExtTCPOrigDataSent=89707i,TcpExtTCPPLBRehash=0i,TcpExtTCPPartialUndo=1i,TcpExtTCPPureAcks=35929i,TcpExtTCPRcvCoalesce=9070i,TcpExtTCPRcvCollapsed=0i,TcpExtTCPRcvQDrop=0i,TcpExtTCPRenoFailures=0i,TcpExtTCPRenoRecovery=0i,TcpExtTCPRenoRecoveryFail=0i,TcpExtTCPRenoReorder=0i,TcpExtTCPReqQFullDoCookies=0i,TcpExtTCPReqQFullDrop=0i,TcpExtTCPRetransFail=0i,TcpExtTCPSACKDiscard=0i,TcpExtTCPSACKReneging=0i,TcpExtTCPSACKReorder=79i,TcpExtTCPSYNChallenge=0i,TcpExtTCPSackFailures=0i,TcpExtTCPSackMerged=3i,TcpExtTCPSackRecovery=3i,TcpExtTCPSackRecoveryFail=0i,TcpExtTCPSackShiftFallback=116i,TcpExtTCPSackShifted=2i,TcpExtTCPSlowStartRetrans=0i,TcpExtTCPSpuriousRTOs=0i,TcpExtTCPSpuriousRtxHostQueues=0i,TcpExtTCPSynRetrans=1i,TcpExtTCPTSReorder=1i,TcpExtTCPTimeWaitOverflow=0i,TcpExtTCPTimeouts=1i,TcpExtTCPToZeroWindowAdv=1i,TcpExtTCPWantZeroWindowAdv=4i,TcpExtTCPWinProbe=0i,TcpExtTCPWqueueTooBig=0i,TcpExtTCPZeroWindowDrop=0i,TcpExtTW=7592i,TcpExtTWKilled=0i,TcpExtTWRecycled=0i,TcpExtTcpDuplicateDataRehash=0i,TcpExtTcpTimeoutRehash=1i 1742837823000000000 +2025-03-24T17:37:03Z D! [agent] Stopping service inputs +> nstat,host=Hugin,name=snmp IcmpInAddrMaskReps=0i,IcmpInAddrMasks=0i,IcmpInCsumErrors=0i,IcmpInDestUnreachs=1i,IcmpInEchoReps=0i,IcmpInEchos=0i,IcmpInErrors=0i,IcmpInMsgs=1i,IcmpInParmProbs=0i,IcmpInRedirects=0i,IcmpInSrcQuenchs=0i,IcmpInTimeExcds=0i,IcmpInTimestampReps=0i,IcmpInTimestamps=0i,IcmpMsgInType3=1i,IcmpMsgOutType3=1i,IcmpOutAddrMaskReps=0i,IcmpOutAddrMasks=0i,IcmpOutDestUnreachs=1i,IcmpOutEchoReps=0i,IcmpOutEchos=0i,IcmpOutErrors=0i,IcmpOutMsgs=1i,IcmpOutParmProbs=0i,IcmpOutRateLimitGlobal=0i,IcmpOutRateLimitHost=0i,IcmpOutRedirects=0i,IcmpOutSrcQuenchs=0i,IcmpOutTimeExcds=0i,IcmpOutTimestampReps=0i,IcmpOutTimestamps=0i,IpDefaultTTL=64i,IpForwDatagrams=12i,IpForwarding=1i,IpFragCreates=2i,IpFragFails=0i,IpFragOKs=1i,IpInAddrErrors=0i,IpInDelivers=227088i,IpInDiscards=0i,IpInHdrErrors=0i,IpInReceives=227102i,IpInUnknownProtos=0i,IpOutDiscards=0i,IpOutNoRoutes=44i,IpOutRequests=194901i,IpOutTransmits=194914i,IpReasmFails=0i,IpReasmOKs=0i,IpReasmReqds=0i,IpReasmTimeout=0i,TcpActiveOpens=12453i,TcpAttemptFails=4005i,TcpCurrEstab=9i,TcpEstabResets=2312i,TcpInCsumErrors=0i,TcpInErrs=0i,TcpInSegs=206125i,TcpMaxConn=-1i,TcpOutRsts=6928i,TcpOutSegs=189170i,TcpPassiveOpens=7628i,TcpRetransSegs=86i,TcpRtoAlgorithm=1i,TcpRtoMax=120000i,TcpRtoMin=200i,UdpIgnoredMulti=0i,UdpInCsumErrors=0i,UdpInDatagrams=27391i,UdpInErrors=0i,UdpLiteIgnoredMulti=0i,UdpLiteInCsumErrors=0i,UdpLiteInDatagrams=0i,UdpLiteInErrors=0i,UdpLiteMemErrors=0i,UdpLiteNoPorts=0i,UdpLiteOutDatagrams=0i,UdpLiteRcvbufErrors=0i,UdpLiteSndbufErrors=0i,UdpMemErrors=0i,UdpNoPorts=1i,UdpOutDatagrams=14308i,UdpRcvbufErrors=0i,UdpSndbufErrors=0i 1742837823000000000 +2025-03-24T17:37:03Z D! [agent] Input channel closed +2025-03-24T17:37:03Z D! [agent] Stopped Successfully +> nstat,host=Hugin,name=snmp6 Icmp6InCsumErrors=0i,Icmp6InDestUnreachs=0i,Icmp6InEchoReplies=0i,Icmp6InEchos=0i,Icmp6InErrors=0i,Icmp6InGroupMembQueries=0i,Icmp6InGroupMembReductions=0i,Icmp6InGroupMembResponses=0i,Icmp6InMLDv2Reports=0i,Icmp6InMsgs=0i,Icmp6InNeighborAdvertisements=0i,Icmp6InNeighborSolicits=0i,Icmp6InParmProblems=0i,Icmp6InPktTooBigs=0i,Icmp6InRedirects=0i,Icmp6InRouterAdvertisements=0i,Icmp6InRouterSolicits=0i,Icmp6InTimeExcds=0i,Icmp6OutDestUnreachs=0i,Icmp6OutEchoReplies=0i,Icmp6OutEchos=0i,Icmp6OutErrors=0i,Icmp6OutGroupMembQueries=0i,Icmp6OutGroupMembReductions=0i,Icmp6OutGroupMembResponses=0i,Icmp6OutMLDv2Reports=271i,Icmp6OutMsgs=430i,Icmp6OutNeighborAdvertisements=0i,Icmp6OutNeighborSolicits=62i,Icmp6OutParmProblems=0i,Icmp6OutPktTooBigs=0i,Icmp6OutRateLimitHost=0i,Icmp6OutRedirects=0i,Icmp6OutRouterAdvertisements=0i,Icmp6OutRouterSolicits=97i,Icmp6OutTimeExcds=0i,Icmp6OutType133=97i,Icmp6OutType135=62i,Icmp6OutType143=271i,Ip6FragCreates=0i,Ip6FragFails=0i,Ip6FragOKs=0i,Ip6InAddrErrors=0i,Ip6InBcastOctets=0i,Ip6InCEPkts=0i,Ip6InDelivers=6433i,Ip6InDiscards=0i,Ip6InECT0Pkts=0i,Ip6InECT1Pkts=0i,Ip6InHdrErrors=0i,Ip6InMcastOctets=2652i,Ip6InMcastPkts=11i,Ip6InNoECTPkts=6433i,Ip6InNoRoutes=0i,Ip6InOctets=763395i,Ip6InReceives=6433i,Ip6InTooBigErrors=0i,Ip6InTruncatedPkts=0i,Ip6InUnknownProtos=0i,Ip6OutBcastOctets=0i,Ip6OutDiscards=12i,Ip6OutForwDatagrams=0i,Ip6OutMcastOctets=35016i,Ip6OutMcastPkts=453i,Ip6OutNoRoutes=4652i,Ip6OutOctets=795759i,Ip6OutRequests=6875i,Ip6OutTransmits=6875i,Ip6ReasmFails=0i,Ip6ReasmOKs=0i,Ip6ReasmReqds=0i,Ip6ReasmTimeout=0i,Udp6IgnoredMulti=0i,Udp6InCsumErrors=0i,Udp6InDatagrams=45i,Udp6InErrors=0i,Udp6MemErrors=0i,Udp6NoPorts=0i,Udp6OutDatagrams=24i,Udp6RcvbufErrors=0i,Udp6SndbufErrors=0i,UdpLite6InCsumErrors=0i,UdpLite6InDatagrams=0i,UdpLite6InErrors=0i,UdpLite6MemErrors=0i,UdpLite6NoPorts=0i,UdpLite6OutDatagrams=0i,UdpLite6RcvbufErrors=0i,UdpLite6SndbufErrors=0i 1742837823000000000 +``` diff --git a/plugins/inputs/ntpq/README.md b/plugins/inputs/ntpq/README.md index 55ed448a5..117cc08c2 100644 --- a/plugins/inputs/ntpq/README.md +++ b/plugins/inputs/ntpq/README.md @@ -1,28 +1,15 @@ -# ntpq Input Plugin +# Network Time Protocol Query Input Plugin -Get standard NTP query metrics, requires ntpq executable. +This plugin gathers metrics about [Network Time Protocol][ntp] queries. -Below is the documentation of the various headers returned from the NTP query -command when running `ntpq -p`. +> [!IMPORTANT] +> This plugin requires the `ntpq` executable to be installed on the system. -- remote – The remote peer or server being synced to. β€œLOCAL” is this local host -(included in case there are no remote peers or servers available); -- refid – Where or what the remote peer or server is itself synchronised to; -- st (stratum) – The remote peer or server Stratum -- t (type) – Type (u: unicast or manycast client, b: broadcast or multicast client, -l: local reference clock, s: symmetric peer, A: manycast server, -B: broadcast server, M: multicast server, see β€œAutomatic Server Discoveryβ€œ); -- when – When last polled (seconds ago, β€œh” hours ago, or β€œd” days ago); -- poll – Polling frequency: rfc5905 suggests this ranges in NTPv4 from 4 (16s) -to 17 (36h) (log2 seconds), however observation suggests the actual displayed -value is seconds for a much smaller range of 64 (26) to 1024 (210) seconds; -- reach – An 8-bit left-shift shift register value recording polls (bit set = -successful, bit reset = fail) displayed in octal; -- delay – Round trip communication delay to the remote peer or server (milliseconds); -- offset – Mean offset (phase) in the times reported between this local host and -the remote peer or server (RMS, milliseconds); -- jitter – Mean deviation (jitter) in the time reported for that remote peer or -server (RMS of difference of multiple time samples, milliseconds); +⭐ Telegraf v0.11.0 +🏷️ network +πŸ’» all + +[ntp]: https://ntp.org/ ## Global configuration options @@ -68,9 +55,33 @@ You can pass arbitrary options accepted by the `ntpq` command using the for example. +Below is the documentation of the various headers returned from the NTP query +command when running `ntpq -p`. + +- `remote` – The remote peer or server being synced to. β€œLOCAL” is this local + host (included in case there are no remote peers or servers available); +- `refid` – Where or what the remote peer or server is itself synchronised to; +- `st` (stratum) – The remote peer or server Stratum +- `t` (type) – Type (u: unicast or manycast client, b: broadcast or multicast + client, l: local reference clock, s: symmetric peer, A: manycast server, + B: broadcast server, M: multicast server, see β€œAutomatic Server Discoveryβ€œ); +- `when` – When last polled (seconds ago, β€œh” hours ago, or β€œd” days ago); +- `poll` – Polling frequency: rfc5905 suggests this ranges in NTPv4 from 4 (16s) + to 17 (36h) (log2 seconds), however observation suggests the actual + displayed value is seconds for a much smaller range of 64 (26) to 1024 + (210) seconds; +- `reach` – An 8-bit left-shift shift register value recording polls + (bit set = successful, bit reset = fail) displayed in octal; +- `delay` – Round trip communication delay to the remote peer or server + (milliseconds); +- `offset` – Mean offset (phase) in the times reported between this local host + and the remote peer or server (RMS, milliseconds); +- `jitter` – Mean deviation (jitter) in the time reported for that remote peer + or server (RMS of difference of multiple time samples, milliseconds); + ## Metrics -- ntpq +- `ntpq` - delay (float, milliseconds) - jitter (float, milliseconds) - offset (float, milliseconds) diff --git a/plugins/inputs/nvidia_smi/README.md b/plugins/inputs/nvidia_smi/README.md index c493ff357..97ca27fd5 100644 --- a/plugins/inputs/nvidia_smi/README.md +++ b/plugins/inputs/nvidia_smi/README.md @@ -1,8 +1,18 @@ # Nvidia System Management Interface (SMI) Input Plugin -This plugin uses a query on the -[`nvidia-smi`](https://developer.nvidia.com/nvidia-system-management-interface) -binary to pull GPU stats including memory and GPU usage, temp and other. +This plugin collects metrics for [NVIDIA GPUs][nvidia] including memory and +GPU usage, temperature and other, using the +[NVIDIA System Management Interface][smi]. + +> [!IMPORTANT] +> This plugin requires the `nvidia-smi` binary to be installed on the system. + +⭐ Telegraf v1.7.0 +🏷️ system, hardware +πŸ’» all + +[nvidia]: https://www.nvidia.com/ +[smi]: https://developer.nvidia.com/nvidia-system-management-interface ## Global configuration options @@ -52,6 +62,24 @@ here `C:\Windows\System32\nvidia-smi.exe` You'll need to escape the `\` within the `telegraf.conf` like this: `C:\\Program Files\\NVIDIA Corporation\\NVSMI\\nvidia-smi.exe` +## Troubleshooting + +Check the full output by running `nvidia-smi` binary manually. + +Linux: + +```sh +sudo -u telegraf -- /usr/bin/nvidia-smi -q -x +``` + +Windows: + +```sh +"C:\Program Files\NVIDIA Corporation\NVSMI\nvidia-smi.exe" -q -x +``` + +Please include the output of this command if opening an GitHub issue. + ## Metrics - measurement: `nvidia_smi` @@ -97,33 +125,6 @@ Files\\NVIDIA Corporation\\NVSMI\\nvidia-smi.exe` - `driver_version` (string) - `cuda_version` (string) -## Sample Query - -The below query could be used to alert on the average temperature of the your -GPUs over the last minute - -```sql -SELECT mean("temperature_gpu") FROM "nvidia_smi" WHERE time > now() - 5m GROUP BY time(1m), "index", "name", "host" -``` - -## Troubleshooting - -Check the full output by running `nvidia-smi` binary manually. - -Linux: - -```sh -sudo -u telegraf -- /usr/bin/nvidia-smi -q -x -``` - -Windows: - -```sh -"C:\Program Files\NVIDIA Corporation\NVSMI\nvidia-smi.exe" -q -x -``` - -Please include the output of this command if opening an GitHub issue. - ## Example Output ```text