Skip to content

Commit

Permalink
docs(inputs): Add plugin metadata and update description for g* to i* (
Browse files Browse the repository at this point in the history
  • Loading branch information
srebhan authored Feb 6, 2025
1 parent c387929 commit e839ad1
Show file tree
Hide file tree
Showing 31 changed files with 875 additions and 825 deletions.
21 changes: 14 additions & 7 deletions plugins/inputs/github/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
# GitHub Input Plugin

Gather repository information from [GitHub][] hosted repositories.
This plugin gathers information from projects and repositories hosted on
[GitHub][github].

**Note:** Telegraf also contains the [webhook][] input which can be used as an
alternative method for collecting repository information.
> [!NOTE]
> Telegraf also contains the [webhook input plugin][webhook] which can be used
> as an alternative method for collecting repository information.
⭐ Telegraf v1.11.0
🏷️ applications
💻 all

[github]: https://www.github.com
[webhook]: /plugins/inputs/webhooks/github

## Global configuration options <!-- @/docs/includes/plugin_config.md -->

Expand Down Expand Up @@ -60,11 +69,11 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
- stars (int)
- watchers (int)

When the [internal][] input is enabled:
When the [internal][internal] input is enabled:

- internal_github
- tags:
- access_token - An obfuscated reference to the configured access token or "Unauthenticated"
- access_token - obfuscated reference to access token or "Unauthenticated"
- fields:
- limit - How many requests you are limited to (per hour)
- remaining - How many requests you have remaining (per hour)
Expand All @@ -88,6 +97,4 @@ github_repository,language=Go,license=MIT\ License,name=telegraf,owner=influxdat
internal_github,access_token=Unauthenticated closed_pull_requests=3522i,rate_limit_remaining=59i,rate_limit_limit=60i,rate_limit_blocks=0i,open_pull_requests=260i 1552653551000000000
```

[GitHub]: https://www.github.com
[internal]: /plugins/inputs/internal
[webhook]: /plugins/inputs/webhooks/github
20 changes: 10 additions & 10 deletions plugins/inputs/gnmi/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# gNMI (gRPC Network Management Interface) Input Plugin

This plugin consumes telemetry data based on the [gNMI][1] Subscribe method. TLS
is supported for authentication and encryption. This input plugin is
vendor-agnostic and is supported on any platform that supports the gNMI spec.
This plugin consumes telemetry data based on [gNMI][gnmi] subscriptions. TLS is
supported for authentication and encryption. This plugin is vendor-agnostic and
is supported on any platform that supports the gNMI specification.

For Cisco devices:
For Cisco devices the plugin has been optimized to support gNMI telemetry as
produced by Cisco IOS XR (64-bit) version 6.5.1, Cisco NX-OS 9.3 and
Cisco IOS XE 16.12 and later.

It has been optimized to support gNMI telemetry as produced by Cisco IOS XR
(64-bit) version 6.5.1, Cisco NX-OS 9.3 and Cisco IOS XE 16.12 and later.
⭐ Telegraf v1.15.0
🏷️ network
💻 all

[1]: https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md

Please check the [troubleshooting section](#troubleshooting) in case of
problems, e.g. when getting an *empty metric-name warning*!
[gnmi]: https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md

## Service Input <!-- @/docs/includes/service_input.md -->

Expand Down
18 changes: 13 additions & 5 deletions plugins/inputs/google_cloud_storage/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,14 @@
# Google Cloud Storage Input Plugin

The Google Cloud Storage plugin will collect metrics
on the given Google Cloud Storage Buckets.
This plugin will collect metrics from the given [Google Cloud Storage][gcs]
buckets in any of the supported [data formats][data_formats].

⭐ Telegraf v1.25.0
🏷️ cloud, datastore
💻 all

[gcs]: https://cloud.google.com/storage
[data_formats]: /docs/DATA_FORMATS_INPUT.md

## Global configuration options <!-- @/docs/includes/plugin_config.md -->

Expand Down Expand Up @@ -43,9 +50,8 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.

## Metrics

- Measurements will reside on Google Cloud Storage with the format specified

- example when [[inputs.google_cloud_storage.data_format]] is json
Measurements will reside on Google Cloud Storage with the format specified, for
example like

```json
{
Expand All @@ -66,6 +72,8 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
}
```

when the [data format][data_formats] is set to `json`.

## Example Output

```text
Expand Down
24 changes: 15 additions & 9 deletions plugins/inputs/graylog/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,23 @@
# GrayLog Input Plugin

The Graylog plugin can collect data from remote Graylog service URLs.
This plugin collects data from [Graylog servers][graylog], currently supporting
two type of end points `multiple`
(e.g. `http://<host>:9000/api/system/metrics/multiple`) and `namespace`
(e.g. `http://<host>:9000/api/system/metrics/namespace/{namespace}`).

Plugin currently support two type of end points:-
Multiple endpoint can be queried and mixing `multiple` and serveral `namespace`
end points is possible. Check `http://<host>:9000/api/api-browser` for the full
list of available endpoints.

- multiple (e.g. `http://[graylog-server-ip]:9000/api/system/metrics/multiple`)
- namespace (e.g. `http://[graylog-server-ip]:9000/api/system/metrics/namespace/{namespace}`)
> [!NOTE]
> When specifying a `namespace` endpoint without an actual namespace, the
> metrics array will be ignored.
End Point can be a mix of one multiple end point and several namespaces end
points
⭐ Telegraf v1.0.0
🏷️ logging
💻 all

Note: if namespace end point specified metrics array will be ignored for that
call.
[graylog]: https://graylog.org/

## Global configuration options <!-- @/docs/includes/plugin_config.md -->

Expand Down Expand Up @@ -65,7 +71,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# insecure_skip_verify = false
```

Please refer to GrayLog metrics api browser for full metric end points:
Please refer to GrayLog metrics API browser for full metric end points:
`http://host:9000/api/api-browser`

## Metrics
Expand Down
12 changes: 7 additions & 5 deletions plugins/inputs/haproxy/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# HAProxy Input Plugin

The [HAProxy](http://www.haproxy.org/) input plugin gathers [statistics][1]
using the [stats socket][2] or [HTTP statistics page][3] of a HAProxy server.
This plugin gathers statistics of [HAProxy][haproxy] servers using sockets or
the HTTP protocol.

[1]: https://cbonte.github.io/haproxy-dconv/1.9/intro.html#3.3.16
[2]: https://cbonte.github.io/haproxy-dconv/1.9/management.html#9.3
[3]: https://cbonte.github.io/haproxy-dconv/1.9/management.html#9
⭐ Telegraf v0.1.5
🏷️ network, server
💻 all

[haproxy]: http://www.haproxy.org/

## Global configuration options <!-- @/docs/includes/plugin_config.md -->

Expand Down
27 changes: 16 additions & 11 deletions plugins/inputs/hddtemp/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
# HDDtemp Input Plugin

This plugin reads data from hddtemp daemon.
This plugin reads data from a [hddtemp][hddtemp] daemon.

Hddtemp should be installed and its daemon running.
> [!IMPORTANT]
> This plugin requires `hddtemp` to be installed and running as a daemon.
## OS Support & Alternatives
As the upstream project is not activly maintained anymore and various
distributions (e.g. Debian Bookwork and later) don't ship packages for `hddtemp`
anymore, the binary might not be available (e.g. in Ubuntu 22.04 or later).

This plugin depends on the availability of the `hddtemp` binary. The upstream
project is not active and Debian made the decision to remove it in Debian
Bookworm. This means the rest of the Debian ecosystem no longer has this binary
in later releases, like Ubuntu 22.04.
> [!TIP]
> As an alternative consider using the [smartctl][smartctl] relying on
> SMART information or [sensors][sensors] plugins to retrieve temperature data
> of your hard-drive.
As an alternative consider using the [`smartctl` plugin]. This parses the full
JSON output from `smartctl`, which includes temperature data, in addition to
much more data about devices in a system.
⭐ Telegraf v1.0.0
🏷️ hardware, system
💻 all

[`smartctl` plugin]: ../smartctl/README.md
[hddtemp]: https://savannah.nongnu.org/projects/hddtemp/
[smartctl]: /plugins/inputs/smartctl/README.md
[sensors]: /plugins/inputs/sensors/README.md

## Global configuration options <!-- @/docs/includes/plugin_config.md -->

Expand Down
13 changes: 8 additions & 5 deletions plugins/inputs/http/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# HTTP Input Plugin

The HTTP input plugin collects metrics from one or more HTTP(S) endpoints. The
endpoint should have metrics formatted in one of the supported [input data
formats](../../../docs/DATA_FORMATS_INPUT.md). Each data format has its own
unique set of configuration options which can be added to the input
configuration.
This plugin collects metrics from one or more HTTP endpoints providing data in
one of the supported [data formats][data_formats].

⭐ Telegraf v1.6.0
🏷️ applications, server
💻 all

[data_formats]: /docs/DATA_FORMATS_INPUT.md

## Global configuration options <!-- @/docs/includes/plugin_config.md -->

Expand Down
20 changes: 10 additions & 10 deletions plugins/inputs/http_listener_v2/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# HTTP Listener v2 Input Plugin

The HTTP Listener v2 is a service input plugin that listens for metrics sent
via HTTP. Metrics may be sent in any supported [data-format][data_format].
This plugin listens for metrics sent via HTTP in any of the supported
[data formats][data_formats].

> [!NOTE]
> If you would like Telegraf to act as a proxy/relay for InfluxDB v1 or
> InfluxDB v2 it is recommended to use the
> [`influxdb__listener`][influxdb_listener] or
> [`influxdb_v2_listener`][influxdb_v2_listener] plugin instead.
> [influxdb__listener][influxdb_listener] or
> [influxdb_v2_listener][influxdb_v2_listener] plugin instead.
⭐ Telegraf v1.30.0
🏷️ servers, web
⭐ Telegraf v1.9.0
🏷️ server
💻 all

[data_formats]: /docs/DATA_FORMATS_INPUT.md
[influxdb_listener]: /plugins/inputs/influxdb_listener/README.md
[influxdb_v2_listener]: /plugins/inputs/influxdb_v2_listener/README.md

## Service Input <!-- @/docs/includes/service_input.md -->

This plugin is a service input. Normal plugins gather metrics determined by the
Expand Down Expand Up @@ -137,7 +141,3 @@ Send query params:
```shell
curl -i -XGET 'http://localhost:8080/telegraf?host=server01&value=0.42'
```

[data_format]: /docs/DATA_FORMATS_INPUT.md
[influxdb_listener]: /plugins/inputs/influxdb_listener/README.md
[influxdb_v2_listener]: /plugins/inputs/influxdb_v2_listener/README.md
7 changes: 6 additions & 1 deletion plugins/inputs/http_response/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# HTTP Response Input Plugin

This input plugin checks HTTP/HTTPS connections.
This plugin generates metrics from HTTP responses including the status code and
response statistics.

⭐ Telegraf v0.12.1
🏷️ server
💻 all

## Global configuration options <!-- @/docs/includes/plugin_config.md -->

Expand Down
11 changes: 7 additions & 4 deletions plugins/inputs/hugepages/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Hugepages Input Plugin

Transparent Huge Pages (THP) is a Linux memory management system that reduces
This plugin gathers metrics from the Linux'
[Transparent Huge Pages (THP) memory management system][hugetlb] that reduces
the overhead of Translation Lookaside Buffer (TLB) lookups on machines with
large amounts of memory by using larger memory pages.
large amounts of memory.

Consult [the website][website] for more details.
⭐ Telegraf v1.22.0
🏷️ system
💻 linux

[website]: https://www.kernel.org/doc/html/latest/admin-guide/mm/hugetlbpage.html
[hugetlb]: https://www.kernel.org/doc/html/latest/admin-guide/mm/hugetlbpage.html

## Global configuration options <!-- @/docs/includes/plugin_config.md -->

Expand Down
11 changes: 6 additions & 5 deletions plugins/inputs/icinga2/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
# Icinga2 Input Plugin

This plugin gather services & hosts status using Icinga2 Remote API.
This plugin gather services and hosts status information using the
[Icinga2 remote API][remote_api].

The icinga2 plugin uses the icinga2 remote API to gather status on running
services and hosts. You can read Icinga2's documentation for their remote API
[here][1].
⭐ Telegraf v1.8.0
🏷️ network, server, system
💻 all

[1]: https://docs.icinga.com/icinga2/latest/doc/module/icinga2/chapter/icinga2-api
[remote_api]: https://docs.icinga.com/icinga2/latest/doc/module/icinga2/chapter/icinga2-api

## Global configuration options <!-- @/docs/includes/plugin_config.md -->

Expand Down
4 changes: 3 additions & 1 deletion plugins/inputs/infiniband/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ system. These are the counters that can be found in
and RDMA counters can be found in
`/sys/class/infiniband/<dev>/ports/<port>/hw_counters/`

**Supported Platforms**: Linux
⭐ Telegraf v1.14.0
🏷️ network
💻 linux

## Global configuration options <!-- @/docs/includes/plugin_config.md -->

Expand Down
Loading

0 comments on commit e839ad1

Please sign in to comment.