Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion plugins/inputs/bind/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ depending on your BIND version and configured statistics channel.
Add the following to your named.conf if running Telegraf on the same host
as the BIND daemon:

```json
```text
statistics-channels {
inet 127.0.0.1 port 8053;
};
Expand Down
6 changes: 3 additions & 3 deletions plugins/inputs/ctrlx_datalayer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ Configuration:

Source:

```json
```text
"framework/metrics/system/memavailable-mb" : 365.93359375
"framework/metrics/system/memused-mb" : 567.67578125
```
Expand All @@ -336,7 +336,7 @@ Configuration:

Source:

```json
```text
"alldata/dynamic/array-of-bool8" : [true, false, true]
"alldata/dynamic/array-of-uint8" : [0, 255]
```
Expand All @@ -363,7 +363,7 @@ Configuration:

Source:

```json
```text
"motion/axs/Axis_1/state/values/actual" : {"actualPos":65.249329860957,"actualVel":5,"actualAcc":0,"actualTorque":0,"distLeft":0,"actualPosUnit":"mm","actualVelUnit":"mm/min","actualAccUnit":"m/s^2","actualTorqueUnit":"Nm","distLeftUnit":"mm"}
"motion/axs/Axis_2/state/values/actual" : {"actualPos":120,"actualVel":0,"actualAcc":0,"actualTorque":0,"distLeft":0,"actualPosUnit":"deg","actualVelUnit":"rpm","actualAccUnit":"rad/s^2","actualTorqueUnit":"Nm","distLeftUnit":"deg"}
```
Expand Down
4 changes: 2 additions & 2 deletions plugins/inputs/docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ for containers that have no explicit hostname set, as defined by docker.
Kubernetes may add many labels to your containers, if they are not needed you
may prefer to exclude them:

```json
```toml
docker_label_exclude = ["annotation.kubernetes*"]
```

Expand All @@ -167,7 +167,7 @@ may prefer to exclude them:
Docker-compose will add labels to your containers. You can limit restrict labels
to selected ones, e.g.

```json
```toml
docker_label_include = [
"com.docker.compose.config-hash",
"com.docker.compose.container-number",
Expand Down
13 changes: 7 additions & 6 deletions plugins/inputs/jti_openconfig_telemetry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,12 +60,13 @@ plugin ordering. See [CONFIGURATION.md][CONFIGURATION.md] for more details.

## We allow specifying sensor group level reporting rate. To do this, specify the
## reporting rate in Duration at the beginning of sensor paths / collection
## name. For entries without reporting rate, we use configured sample frequency
sensors = [
"1000ms customReporting /interfaces /lldp",
"2000ms collection /components",
"/interfaces",
]
## name. For entries without reporting rate, we use configured sample frequency.
## Use this form INSTEAD of the simple `sensors` list above:
# sensors = [
# "1000ms customReporting /interfaces /lldp",
# "2000ms collection /components",
# "/interfaces",
# ]

## Timestamp Source
## Set to 'collection' for time of collection, and 'data' for using the time
Expand Down
6 changes: 3 additions & 3 deletions plugins/inputs/opcua_listener/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -538,9 +538,9 @@ This example group configuration shows how to use group settings:
identifier = "5678"

node_ids = [
{identifier="Sensor1"}, // default values will be used for namespace and identifier_type
{namespace="2", identifier="TemperatureSensor"}, // default values will be used for identifier_type
{namespace="5", identifier_type="i", identifier="2002"} // no default values will be used
{identifier="Sensor1"}, # default values will be used for namespace and identifier_type
{namespace="2", identifier="TemperatureSensor"}, # default values will be used for identifier_type
{namespace="5", identifier_type="i", identifier="2002"} # no default values will be used
]
```

Expand Down
15 changes: 9 additions & 6 deletions plugins/inputs/postgresql_extensible/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,9 @@ using the postgresql extensions [pg_stat_statements][pg_stat_statements],
withdbname=false
tagvalue="db,username,state"
[[inputs.postgresql_extensible.query]]
sqlquery="select setting as max_connections from pg_settings where \
name='max_connections'"
sqlquery="""\
select setting as max_connections from pg_settings where \
name='max_connections'"""
version=801
withdbname=false
tagvalue=""
Expand All @@ -142,15 +143,17 @@ using the postgresql extensions [pg_stat_statements][pg_stat_statements],
withdbname=false
tagvalue=""
[[inputs.postgresql_extensible.query]]
sqlquery="select setting as shared_buffers from pg_settings where \
name='shared_buffers'"
sqlquery="""\
select setting as shared_buffers from pg_settings where \
name='shared_buffers'"""
version=801
withdbname=false
tagvalue=""
[[inputs.postgresql_extensible.query]]
sqlquery="SELECT db, count( distinct blocking_pid ) AS num_blocking_sessions,\
sqlquery="""\
SELECT db, count( distinct blocking_pid ) AS num_blocking_sessions,\
count( distinct blocked_pid) AS num_blocked_sessions FROM \
public.blocking_procs group by db"
public.blocking_procs group by db"""
version=901
withdbname=false
tagvalue="db"
Expand Down
2 changes: 1 addition & 1 deletion plugins/inputs/win_eventlog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ There are three types of filtering: **Event Log** name, **XPath Query** and

```toml
eventlog_name = "Application"
xpath_query = '''
xpath_query = ""
```

For **XPath Query** filtering set the `xpath_query` value, and `eventlog_name`
Expand Down
2 changes: 1 addition & 1 deletion plugins/outputs/azure_data_explorer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ stored as dynamic data type, multiple ways to query this data-
recommended performant way for querying over large volumes of data compared
to querying directly over JSON attributes:

```json
```kusto
// Function to transform data
.create-or-alter function Transform_TargetTableName() {
SourceTableName
Expand Down
2 changes: 1 addition & 1 deletion plugins/outputs/clarify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The following input would be stored in Clarify with the values shown below:
temperature,host=demo.clarifylocal,sensor=TC0P value=49 1682670910000000000
```

```json
```text
"signal" {
"id": "temperature.value.TC0P"
"name": "temperature.value"
Expand Down
2 changes: 1 addition & 1 deletion plugins/outputs/dynatrace/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ The endpoint for the Dynatrace Metrics API v2 is
url = "https://{your-environment-id}.live.dynatrace.com/api/v2/metrics/ingest"

## API token is required if a URL is specified and should be restricted to the 'Ingest metrics' scope
api_token = "your API token here" // hard-coded for illustration only, should be read from environment
api_token = "your API token here" # hard-coded for illustration only, should be read from environment
```

You can learn more about how to use the [Dynatrace API][api].
Expand Down
4 changes: 2 additions & 2 deletions plugins/outputs/elasticsearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ compatibility mode users need to set the `override_main_response_version` to

On existing clusters run:

```json
```text
PUT /_cluster/settings
{
"persistent" : {
Expand All @@ -216,7 +216,7 @@ PUT /_cluster/settings

And on new clusters set the option to true under advanced options:

```json
```text
POST https://es.us-east-1.amazonaws.com/2021-01-01/opensearch/upgradeDomain
{
"DomainName": "domain-name",
Expand Down
4 changes: 2 additions & 2 deletions plugins/outputs/zabbix/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ measurement,host=hostname valueA=0,valueB=1

It will generate this Zabbix metrics:

```json
```jsonl
{"host": "hostname", "key": "telegraf.measurement.valueA", "value": "0"}
{"host": "hostname", "key": "telegraf.measurement.valueB", "value": "1"}
```
Expand All @@ -188,7 +188,7 @@ measurement,host=hostname,tagA=keyA,tagB=keyB valueA=0,valueB=1

Zabbix generated metrics:

```json
```jsonl
{"host": "hostname", "key": "telegraf.measurement.valueA[keyA,keyB]", "value": "0"}
{"host": "hostname", "key": "telegraf.measurement.valueB[keyA,keyB]", "value": "1"}
```
Expand Down
2 changes: 1 addition & 1 deletion plugins/processors/converter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ Set the metric timestamp from a tag:
[[processors.converter]]
[processors.converter.tags]
timestamp = ["time"]
timestamp_format = "unix
timestamp_format = "unix"
```

```diff
Expand Down
4 changes: 2 additions & 2 deletions plugins/processors/lookup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ added to a metric if the key matches.

In the `json` format, the input `files` must have the following format

```json
```text
{
"keyA": {
"tag-name1": "tag-value1",
Expand Down Expand Up @@ -133,7 +133,7 @@ With a lookup table of
"xyzzy-red": {
"location": "us-west",
"rack": "C01-42"
},
}
}
```

Expand Down
Loading