Skip to content

Commit

Permalink
Add minimum version for new plugins (influxdata#7810)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielnelson authored Jul 9, 2020
1 parent b6b1e7f commit 413398d
Show file tree
Hide file tree
Showing 11 changed files with 34 additions and 13 deletions.
2 changes: 2 additions & 0 deletions plugins/inputs/nginx_sts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ 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).

Telegraf minimum version: Telegraf 1.15.0

### Configuration

```toml
Expand Down
1 change: 1 addition & 0 deletions plugins/inputs/redfish/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

The `redfish` plugin gathers metrics and status information about CPU temperature, fanspeed, Powersupply, voltage, hostname and Location details(datacenter,placement,rack and room) of hardware servers for which redfish is enabled.

Telegraf minimum version: Telegraf 1.15.0

### Configuration

Expand Down
4 changes: 3 additions & 1 deletion plugins/outputs/execd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

The `execd` plugin runs an external program as a daemon.

Telegraf minimum version: Telegraf 1.15.0

### Configuration:

```toml
Expand All @@ -23,4 +25,4 @@ The `execd` plugin runs an external program as a daemon.

see [examples][]

[examples]: https://github.com/influxdata/telegraf/blob/master/plugins/outputs/execd/examples/
[examples]: https://github.com/influxdata/telegraf/blob/master/plugins/outputs/execd/examples/
2 changes: 2 additions & 0 deletions plugins/outputs/newrelic/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ This plugins writes to New Relic Insights using the [Metrics API][].

To use this plugin you must first obtain an [Insights API Key][].

Telegraf minimum version: Telegraf 1.15.0

### Configuration
```toml
[[outputs.newrelic]]
Expand Down
4 changes: 3 additions & 1 deletion plugins/processors/defaults/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ There are three cases where this processor will insert a configured default fiel
1. The field is nil on the incoming metric
1. The field is not nil, but its value is an empty string.
1. The field is not nil, but its value is a string of one or more empty spaces.


Telegraf minimum version: Telegraf 1.15.0

### Configuration
```toml
## Set default fields on your metric(s) when they are nil or empty
Expand Down
2 changes: 2 additions & 0 deletions plugins/processors/execd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ metrics in influx line protocol to standard output (STDOUT).

Program output on standard error is mirrored to the telegraf log.

Telegraf minimum version: Telegraf 1.15.0

### Caveats

- Metrics with tracking will be considered "delivered" as soon as they are passed
Expand Down
24 changes: 13 additions & 11 deletions plugins/processors/filepath/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ stored in a new tag or field.

If you plan to apply multiple transformations to the same `tag`/`field`, bear in mind the processing order stated above.

## Configuration
Telegraf minimum version: Telegraf 1.15.0

### Configuration

```toml
[[processors.filepath]]
Expand Down Expand Up @@ -56,9 +58,9 @@ If you plan to apply multiple transformations to the same `tag`/`field`, bear in
# tag = "path"
```

## Considerations
### Considerations

### Clean
#### Clean

Even though `clean` is provided a standalone function, it is also invoked when using the `rel` and `dirname` functions,
so there is no need to use it along with them.
Expand All @@ -81,13 +83,13 @@ Is equivalent to:
tag = "path"
```

### ToSlash
#### ToSlash

The effects of this function are only noticeable on Windows platforms, because of the underlying golang implementation.

## Examples
### Examples

### Basename
#### Basename

```toml
[[processors.filepath]]
Expand All @@ -100,7 +102,7 @@ The effects of this function are only noticeable on Windows platforms, because o
+ my_metric,path="ajob.log" duration_seconds=134 1587920425000000000
```

### Dirname
#### Dirname

```toml
[[processors.filepath]]
Expand All @@ -114,7 +116,7 @@ The effects of this function are only noticeable on Windows platforms, because o
+ my_metric path="/var/log/batch/ajob.log",folder="/var/log/batch",duration_seconds=134 1587920425000000000
```

### Stem
#### Stem

```toml
[[processors.filepath]]
Expand All @@ -127,7 +129,7 @@ The effects of this function are only noticeable on Windows platforms, because o
+ my_metric,path="ajob" duration_seconds=134 1587920425000000000
```

### Clean
#### Clean

```toml
[[processors.filepath]]
Expand All @@ -140,7 +142,7 @@ The effects of this function are only noticeable on Windows platforms, because o
+ my_metric,path="/var/log/batch/ajob.log" duration_seconds=134 1587920425000000000
```

### Rel
#### Rel

```toml
[[processors.filepath]]
Expand All @@ -154,7 +156,7 @@ The effects of this function are only noticeable on Windows platforms, because o
+ my_metric,path="batch/ajob.log" duration_seconds=134 1587920425000000000
```

### ToSlash
#### ToSlash

```toml
[[processors.filepath]]
Expand Down
2 changes: 2 additions & 0 deletions plugins/processors/ifname/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

The `ifname` plugin looks up network interface names using SNMP.

Telegraf minimum version: Telegraf 1.15.0

### Configuration:

```toml
Expand Down
2 changes: 2 additions & 0 deletions plugins/processors/port_name/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Use the `port_name` processor to convert a tag containing a well-known port numb

Tag can contain a number ("80") or number and protocol separated by slash ("443/tcp"). If protocol is not provided it defaults to tcp but can be changed with the default_protocol setting.

Telegraf minimum version: Telegraf 1.15.0

### Configuration

```toml
Expand Down
2 changes: 2 additions & 0 deletions plugins/processors/reverse_dns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
The `reverse_dns` processor does a reverse-dns lookup on tags (or fields) with
IPs in them.

Telegraf minimum version: Telegraf 1.15.0

### Configuration:

```toml
Expand Down
2 changes: 2 additions & 0 deletions plugins/processors/starlark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ files or sockets.
The Starlark [specification][] has details about the syntax and available
functions.

Telegraf minimum version: Telegraf 1.15.0

### Configuration

```toml
Expand Down

0 comments on commit 413398d

Please sign in to comment.