docs: fix remaining markdownlinter issues (#12658)
This commit is contained in:
parent
d5a101aff6
commit
200044a495
|
|
@ -125,4 +125,3 @@ documentation about the Starlark processor.
|
|||
Open a Pull Request to add any other useful Starlark examples.
|
||||
|
||||
[Starlark specification]: https://github.com/google/starlark-go/blob/d1966c6b9fcd/doc/spec.md
|
||||
[dict]: https://github.com/google/starlark-go/blob/d1966c6b9fcd/doc/spec.md#dictionaries
|
||||
|
|
|
|||
|
|
@ -57,8 +57,10 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
|
|||
|
||||
## Metrics
|
||||
|
||||
A detailed explanation of each fields can be found in [kernel documentation](
|
||||
https://www.kernel.org/doc/Documentation/networking/nf_conntrack-sysctl.txt).
|
||||
A detailed explanation of each fields can be found in
|
||||
[kernel documentation][kerneldoc]
|
||||
|
||||
[kerneldoc]: https://www.kernel.org/doc/Documentation/networking/nf_conntrack-sysctl.txt
|
||||
|
||||
- conntrack
|
||||
- `ip_conntrack_count` `(int, count)`: The number of entries in the conntrack table
|
||||
|
|
|
|||
|
|
@ -119,7 +119,7 @@ sflow,agent_address=0.0.0.0,dst_ip=10.0.0.2,dst_mac=ff:ff:ff:ff:ff:ff,dst_port=4
|
|||
## Reference Documentation
|
||||
|
||||
This sflow implementation was built from the reference document
|
||||
[sflow.org/sflow_version_5.txt](sflow_version_5)
|
||||
[sflow.org/sflow_version_5.txt][sflow_version_5]
|
||||
|
||||
[metric filtering]: https://github.com/influxdata/telegraf/blob/master/docs/CONFIGURATION.md#metric-filtering
|
||||
[retention policy]: https://docs.influxdata.com/influxdb/latest/guides/downsampling_and_retention/
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ This implementation tries to maintain compatibility with the apcupsd metrics:
|
|||
- ups_name
|
||||
- model
|
||||
- fields:
|
||||
- status_flags ([status-bits][])
|
||||
- status_flags ([status-bits][rfc9271-sec5.1])
|
||||
- input_voltage
|
||||
- load_percent
|
||||
- battery_charge_percent
|
||||
|
|
@ -66,6 +66,8 @@ With the exception of:
|
|||
- fields:
|
||||
- time_on_battery_ns
|
||||
|
||||
[rfc9271-sec5.1]: https://www.rfc-editor.org/rfc/rfc9271.html#section-5.1
|
||||
|
||||
## Example Output
|
||||
|
||||
```shell
|
||||
|
|
|
|||
|
|
@ -113,14 +113,14 @@ The namespace used for AWS CloudWatch metrics.
|
|||
If you have a large amount of metrics, you should consider to send statistic
|
||||
values instead of raw metrics which could not only improve performance but also
|
||||
save AWS API cost. If enable this flag, this plugin would parse the required
|
||||
[CloudWatch statistic fields][1] (count, min, max, and sum) and send them to
|
||||
CloudWatch. You could use `basicstats` aggregator to calculate those fields. If
|
||||
not all statistic fields are available, all fields would still be sent as raw
|
||||
metrics.
|
||||
[CloudWatch statistic fields][statistic fields] (count, min, max, and sum) and
|
||||
send them to CloudWatch. You could use `basicstats` aggregator to calculate
|
||||
those fields. If not all statistic fields are available, all fields would still
|
||||
be sent as raw metrics.
|
||||
|
||||
[1]: https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatch/#StatisticSet
|
||||
[statistic fields]: https://docs.aws.amazon.com/sdk-for-go/api/service/cloudwatch/#StatisticSet
|
||||
|
||||
### high_resolution_metrics
|
||||
|
||||
Enable high resolution metrics (1 second precision) instead of standard ones (60
|
||||
seconds precision)
|
||||
Enable high resolution metrics (1 second precision) instead of standard ones
|
||||
(60 seconds precision).
|
||||
|
|
|
|||
|
|
@ -6,7 +6,6 @@ For details on the translation between Telegraf Metrics and Graphite output,
|
|||
see the [Graphite Data Format][2].
|
||||
|
||||
[1]: http://graphite.readthedocs.org/en/latest/index.html
|
||||
|
||||
[2]: ../../../docs/DATA_FORMATS_OUTPUT.md
|
||||
|
||||
## Global configuration options <!-- @/docs/includes/plugin_config.md -->
|
||||
|
|
|
|||
|
|
@ -22,7 +22,7 @@ Before using this plugin, please configure the IP address, port number,
|
|||
user name, password and other information of the database server,
|
||||
as well as some data type conversion, time unit and other configurations.
|
||||
|
||||
Please see the [configuration section](#Configuration) for an example
|
||||
Please see the [configuration section](#configuration) for an example
|
||||
configuration.
|
||||
|
||||
## Metric Translation
|
||||
|
|
@ -54,9 +54,8 @@ Other options are `second`, `millisecond`, `microsecond`.
|
|||
|
||||
### Metadata (tags)
|
||||
|
||||
IoTDB uses a tree model for metadata while Telegraf uses a tag model.
|
||||
(See [InfluxDB-Protocol Adapter](
|
||||
https://iotdb.apache.org/UserGuide/Master/API/InfluxDB-Protocol.html)
|
||||
IoTDB uses a tree model for metadata while Telegraf uses a tag model
|
||||
(see [InfluxDB-Protocol Adapter][InfluxDB-Protocol Adapter]).
|
||||
There are two available options of converting tags, which are specified by
|
||||
setting `convert_tags_to`:
|
||||
|
||||
|
|
@ -74,6 +73,8 @@ Name="root.sg.device", Tags={tag1="private", tag2="working"}, Fields={s1=100, s2
|
|||
- `fields`, result: `root.sg.device, s1=100, s2="hello", tag1="private", tag2="working"`
|
||||
- `device_id`, result: `root.sg.device.private.working, s1=100, s2="hello"`
|
||||
|
||||
[InfluxDB-Protocol Adapter]: https://iotdb.apache.org/UserGuide/Master/API/InfluxDB-Protocol.html
|
||||
|
||||
## Global configuration options <!-- @/docs/includes/plugin_config.md -->
|
||||
|
||||
In addition to the plugin-specific configuration settings, plugins support
|
||||
|
|
|
|||
|
|
@ -2,8 +2,10 @@
|
|||
|
||||
The Graphite data format is translated from Telegraf Metrics using either the
|
||||
template pattern or tag support method. You can select between the two
|
||||
methods using the [`graphite_tag_support`](#graphite-tag-support) option. When set, the tag support
|
||||
method is used, otherwise the [Template Pattern](templates) is used.
|
||||
methods using the [`graphite_tag_support`](#graphite_tag_support) option. When set, the tag support
|
||||
method is used, otherwise the [Template Pattern][templates] is used.
|
||||
|
||||
[templates]: /docs/TEMPLATE_PATTERN.md
|
||||
|
||||
## Configuration
|
||||
|
||||
|
|
@ -74,5 +76,3 @@ The `graphite_tag_sanitize_mode` option defines how we should sanitize the tag n
|
|||
When in `strict` mode Telegraf uses the same rules as metrics when not using tags.
|
||||
When in `compatible` mode Telegraf allows more characters through, and is based on the Graphite specification:
|
||||
>Tag names must have a length >= 1 and may contain any ascii characters except `;!^=`. Tag values must also have a length >= 1, they may contain any ascii characters except `;` and the first character must not be `~`. UTF-8 characters may work for names and values, but they are not well tested and it is not recommended to use non-ascii characters in metric names or tags. Metric names get indexed under the special tag name, if a metric name starts with one or multiple ~ they simply get removed from the derived tag value because the ~ character is not allowed to be in the first position of the tag value. If a metric name consists of no other characters than ~, then it is considered invalid and may get dropped.
|
||||
|
||||
[templates]: /docs/TEMPLATE_PATTERN.md
|
||||
|
|
|
|||
Loading…
Reference in New Issue