docs: Update all readme to pass linter (#12615)

This commit is contained in:
Joshua Powers 2023-02-09 03:04:41 -07:00 committed by GitHub
parent 5553b33e4a
commit 2aa57f00ad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
60 changed files with 176 additions and 50 deletions

View File

@ -112,3 +112,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
* cluster (string) * cluster (string)
* topic (string) * topic (string)
* partition (int) * partition (int)
## Example Output

View File

@ -83,3 +83,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# ] # ]
# files = ["*"] # files = ["*"]
``` ```
## Example Output

View File

@ -104,3 +104,7 @@ subscriptions/topics.
[pubsub]: https://cloud.google.com/pubsub [pubsub]: https://cloud.google.com/pubsub
[pubsub create sub]: https://cloud.google.com/pubsub/docs/admin#create_a_pull_subscription [pubsub create sub]: https://cloud.google.com/pubsub/docs/admin#create_a_pull_subscription
[input data formats]: /docs/DATA_FORMATS_INPUT.md [input data formats]: /docs/DATA_FORMATS_INPUT.md
## Metrics
## Example Output

View File

@ -82,3 +82,7 @@ This plugin assumes you have already created a PUSH subscription for a given
PubSub topic. PubSub topic.
[pubsub]: https://cloud.google.com/pubsub [pubsub]: https://cloud.google.com/pubsub
## Metrics
## Example Output

View File

@ -45,3 +45,5 @@ Consul collects various metrics. For every details, please have a look at Consul
following documentation: following documentation:
- [https://www.consul.io/api/agent#view-metrics](https://www.consul.io/api/agent#view-metrics) - [https://www.consul.io/api/agent#view-metrics](https://www.consul.io/api/agent#view-metrics)
## Example Output

View File

@ -47,3 +47,5 @@ If no servers are specified, no data will be collected
- sv_ms (float) - sv_ms (float)
- variance_ms (float) - variance_ms (float)
- tick_ms (float) - tick_ms (float)
## Example Output

View File

@ -45,3 +45,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
- used_cpu_user_children - used_cpu_user_children
- registered_jobs - registered_jobs
- registered_queues - registered_queues
## Example Output

View File

@ -229,7 +229,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
- started_at - started_at
- type - type
## Example ## Example Output
```shell ```shell
ecs_task,cluster=test,family=nginx,host=c4b301d4a123,revision=2,task_arn=arn:aws:ecs:aws-region-1:012345678901:task/a1234abc-a0a0-0a01-ab01-0abc012a0a0a desired_status="RUNNING",known_status="RUNNING",limit_cpu=0.5,limit_mem=512 1542641488000000000 ecs_task,cluster=test,family=nginx,host=c4b301d4a123,revision=2,task_arn=arn:aws:ecs:aws-region-1:012345678901:task/a1234abc-a0a0-0a01-ab01-0abc012a0a0a desired_status="RUNNING",known_status="RUNNING",limit_cpu=0.5,limit_mem=512 1542641488000000000

View File

@ -879,3 +879,5 @@ Emitted when the appropriate `shards_stats` options are set.
- warmer_current (float) - warmer_current (float)
- warmer_total (float) - warmer_total (float)
- warmer_total_time_in_millis (float) - warmer_total_time_in_millis (float)
## Example Output

View File

@ -193,3 +193,7 @@ of the examples below.
[joda]: https://www.elastic.co/guide/en/elasticsearch/reference/6.8/search-aggregations-bucket-daterange-aggregation.html#date-format-pattern [joda]: https://www.elastic.co/guide/en/elasticsearch/reference/6.8/search-aggregations-bucket-daterange-aggregation.html#date-format-pattern
[agg]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics.html [agg]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics.html
## Metrics
## Example Output

View File

@ -116,3 +116,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
[Full documentation of the available environment variables][envvar]. [Full documentation of the available environment variables][envvar].
[envvar]: https://github.com/Azure/azure-event-hubs-go#environment-variables [envvar]: https://github.com/Azure/azure-event-hubs-go#environment-variables
## Metrics
## Example Output

View File

@ -86,3 +86,7 @@ available for output:
```shell ```shell
$host.UI.RawUI.BufferSize = new-object System.Management.Automation.Host.Size(1024,50) $host.UI.RawUI.BufferSize = new-object System.Management.Automation.Host.Size(1024,50)
``` ```
## Metrics
## Example Output

View File

@ -136,3 +136,7 @@ end
[Input Data Formats]: ../../../docs/DATA_FORMATS_INPUT.md [Input Data Formats]: ../../../docs/DATA_FORMATS_INPUT.md
[inputs.exec]: ../exec/README.md [inputs.exec]: ../exec/README.md
## Metrics
## Example Output

View File

@ -54,3 +54,5 @@ format of the file.
[input data format]: /docs/DATA_FORMATS_INPUT.md [input data format]: /docs/DATA_FORMATS_INPUT.md
[tail]: /plugins/inputs/tail [tail]: /plugins/inputs/tail
## Example Output

View File

@ -25,7 +25,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
md5 = false md5 = false
``` ```
## Measurements & Fields ## Metrics
### Measurements & Fields
- filestat - filestat
- exists (int, 0 | 1) - exists (int, 0 | 1)
@ -33,12 +35,12 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
- modification_time (int, unix time nanoseconds) - modification_time (int, unix time nanoseconds)
- md5 (optional, string) - md5 (optional, string)
## Tags ### Tags
- All measurements have the following tags: - All measurements have the following tags:
- file (the path the to file, as specified in the config) - file (the path the to file, as specified in the config)
### Example ## Example Output
```shell ```shell
$ telegraf --config /etc/telegraf/telegraf.conf --input-filter filestat --test $ telegraf --config /etc/telegraf/telegraf.conf --input-filter filestat --test

View File

@ -59,7 +59,7 @@ values are included if they are less than a minute old.
- fields: - fields:
- temperature (float, unit) - temperature (float, unit)
## Example ## Example Output
This section shows example output in Line Protocol format. You can often use This section shows example output in Line Protocol format. You can often use
`telegraf --input-filter <plugin-name> --test` or use the `file` output to get `telegraf --input-filter <plugin-name> --test` or use the `file` output to get

View File

@ -51,7 +51,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
] ]
``` ```
## Measurements & Fields ## Metrics
### Measurements & Fields
Fields may vary depending on the plugin type Fields may vary depending on the plugin type
@ -69,9 +71,9 @@ Fields may vary depending on the plugin type
- buffer_stage_length (float, unit) - buffer_stage_length (float, unit)
- buffer_queue_byte_size (float, unit) - buffer_queue_byte_size (float, unit)
- buffer_stage_byte_size (float, unit) - buffer_stage_byte_size (float, unit)
- buffer_available_buffer_space_ratios (float, unit) - buffer_available_buffer_space_ratios (float, unit)
## Tags ### Tags
- All measurements have the following tags: - All measurements have the following tags:
- plugin_id (unique plugin id) - plugin_id (unique plugin id)

View File

@ -67,3 +67,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
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` `http://host:9000/api/api-browser`
## Metrics
## Example Output

View File

@ -41,7 +41,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
- fields: - fields:
- temperature - temperature
## Example output ## Example Output
```shell ```shell
hddtemp,source=server1,unit=C,status=,device=sdb,model=WDC\ WD740GD-00FLA1 temperature=43i 1481655647000000000 hddtemp,source=server1,unit=C,status=,device=sdb,model=WDC\ WD740GD-00FLA1 temperature=43i 1481655647000000000

View File

@ -65,7 +65,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# apiVersion = "v1" # apiVersion = "v1"
``` ```
## Measurements & Fields ## Metrics
### Measurements & Fields
- httpjson - httpjson
- response_time (float): Response time in seconds - response_time (float): Response time in seconds
@ -73,7 +75,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
Additional fields are dependant on the response of the remote service being Additional fields are dependant on the response of the remote service being
polled. polled.
## Tags ### Tags
- All measurements have the following tags: - All measurements have the following tags:
- server: HTTP origin as defined in configuration as `servers`. - server: HTTP origin as defined in configuration as `servers`.
@ -83,7 +85,7 @@ tags. Top level keys are defined as keys in the root level of the object in a
single object response, or in the root level of each object within an array of single object response, or in the root level of each object within an array of
objects. objects.
## Examples Output ## Example Output
This plugin understands responses containing a single JSON object, or a JSON This plugin understands responses containing a single JSON object, or a JSON
Array of Objects. Array of Objects.

View File

@ -31,7 +31,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# types = ["root", "per_node"] # types = ["root", "per_node"]
``` ```
## Measurements ## Metrics
### Measurements
**The following measurements are supported by Hugepages plugin:** **The following measurements are supported by Hugepages plugin:**

View File

@ -93,3 +93,5 @@ curl -i -XPOST 'http://localhost:8186/write' --data-binary 'cpu_load_short,host=
[influxdb_http_api]: https://docs.influxdata.com/influxdb/v1.8/guides/write_data/ [influxdb_http_api]: https://docs.influxdata.com/influxdb/v1.8/guides/write_data/
[http_listener_v2]: /plugins/inputs/http_listener_v2/README.md [http_listener_v2]: /plugins/inputs/http_listener_v2/README.md
## Example Output

View File

@ -70,3 +70,5 @@ curl -i -XPOST 'http://localhost:8186/api/v2/write' --data-binary 'cpu_load_shor
``` ```
[influxdb_http_api]: https://docs.influxdata.com/influxdb/latest/api/ [influxdb_http_api]: https://docs.influxdata.com/influxdb/latest/api/
## Example Output

View File

@ -30,7 +30,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
[[inputs.intel_pmu]] [[inputs.intel_pmu]]
## List of filesystem locations of JSON files that contain PMU event definitions. ## List of filesystem locations of JSON files that contain PMU event definitions.
event_definitions = ["/var/cache/pmu/GenuineIntel-6-55-4-core.json", "/var/cache/pmu/GenuineIntel-6-55-4-uncore.json"] event_definitions = ["/var/cache/pmu/GenuineIntel-6-55-4-core.json", "/var/cache/pmu/GenuineIntel-6-55-4-uncore.json"]
## List of core events measurement entities. There can be more than one core_events sections. ## List of core events measurement entities. There can be more than one core_events sections.
[[inputs.intel_pmu.core_events]] [[inputs.intel_pmu.core_events]]
## List of events to be counted. Event names shall match names from event_definitions files. ## List of events to be counted. Event names shall match names from event_definitions files.
@ -201,7 +201,7 @@ On each Telegraf interval, Intel PMU plugin transmits following data:
| unit | name of event-capable PMU that the event was counted for, as listed in /sys/bus/event_source/devices/ e.g. uncore_cbox_1, uncore_imc_1 etc. Present for non-aggregated uncore events only | | unit | name of event-capable PMU that the event was counted for, as listed in /sys/bus/event_source/devices/ e.g. uncore_cbox_1, uncore_imc_1 etc. Present for non-aggregated uncore events only |
| events_tag| (optional) tag as defined in "intel_pmu.uncore_events" configuration element | | events_tag| (optional) tag as defined in "intel_pmu.uncore_events" configuration element |
## Example outputs ## Example Output
Event group: Event group:
@ -228,7 +228,7 @@ pmu_metric,event=UNC_CBO_XSNP_RESPONSE.MISS_XCORE,host=xyz,socket=0,unit=uncore_
Uncore event aggregated: Uncore event aggregated:
```text ```text
pmu_metric,event=UNC_CBO_XSNP_RESPONSE.MISS_XCORE,host=xyz,socket=0,unit_type=cbox enabled=13199712335i,running=13199712335i,raw=467485i,scaled=467485i 1621254412000000000 pmu_metric,event=UNC_CBO_XSNP_RESPONSE.MISS_XCORE,host=xyz,socket=0,unit_type=cbox enabled=13199712335i,running=13199712335i,raw=467485i,scaled=467485i 1621254412000000000
``` ```
Time multiplexing: Time multiplexing:

View File

@ -7,7 +7,7 @@ hardware framework to monitor and control the utilization of shared resources
## About Intel RDT ## About Intel RDT
Intels Resource Director Technology (RDT) framework consists of: Intels Resource Director Technology (RDT) framework consists of:
- Cache Monitoring Technology (CMT) - Cache Monitoring Technology (CMT)
- Memory Bandwidth Monitoring (MBM) - Memory Bandwidth Monitoring (MBM)
@ -105,12 +105,12 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
```toml @sample.conf ```toml @sample.conf
# Read Intel RDT metrics # Read Intel RDT metrics
[[inputs.intel_rdt]] [[inputs.intel_rdt]]
## Optionally set sampling interval to Nx100ms. ## Optionally set sampling interval to Nx100ms.
## This value is propagated to pqos tool. Interval format is defined by pqos itself. ## This value is propagated to pqos tool. Interval format is defined by pqos itself.
## If not provided or provided 0, will be set to 10 = 10x100ms = 1s. ## If not provided or provided 0, will be set to 10 = 10x100ms = 1s.
# sampling_interval = "10" # sampling_interval = "10"
## Optionally specify the path to pqos executable. ## Optionally specify the path to pqos executable.
## If not provided, auto discovery will be performed. ## If not provided, auto discovery will be performed.
# pqos_path = "/usr/local/bin/pqos" # pqos_path = "/usr/local/bin/pqos"
@ -118,7 +118,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
## If not provided, default value is false. ## If not provided, default value is false.
# shortened_metrics = false # shortened_metrics = false
## Specify the list of groups of CPU core(s) to be provided as pqos input. ## Specify the list of groups of CPU core(s) to be provided as pqos input.
## Mandatory if processes aren't set and forbidden if processes are specified. ## Mandatory if processes aren't set and forbidden if processes are specified.
## e.g. ["0-3", "4,5,6"] or ["1-3,4"] ## e.g. ["0-3", "4,5,6"] or ["1-3,4"]
# cores = ["0-3"] # cores = ["0-3"]
@ -133,7 +133,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# use_sudo = false # use_sudo = false
``` ```
## Exposed metrics ## Metrics
| Name | Full name | Description | | Name | Full name | Description |
|---------------|-----------------------------------------------|-------------| |---------------|-----------------------------------------------|-------------|

View File

@ -87,7 +87,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# cache_path = "" # cache_path = ""
``` ```
## Measurements ## Metrics
Version 1 schema: Version 1 schema:

View File

@ -70,6 +70,8 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
``` ```
## Metrics
## Example Output ## Example Output
```sh ```sh

View File

@ -97,13 +97,15 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
chains = [ "INPUT" ] chains = [ "INPUT" ]
``` ```
## Measurements & Fields ## Metrics
### Measurements & Fields
* iptables * iptables
* pkts (integer, count) * pkts (integer, count)
* bytes (integer, bytes) * bytes (integer, bytes)
## Tags ### Tags
* All measurements have the following tags: * All measurements have the following tags:
* table * table

View File

@ -29,7 +29,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# [inputs.jolokia.proxy] # [inputs.jolokia.proxy]
# host = "127.0.0.1" # host = "127.0.0.1"
# port = "8080" # port = "8080"
## Optional http timeouts ## Optional http timeouts
## ##
## response_header_timeout, if non-zero, specifies the amount of time to wait ## response_header_timeout, if non-zero, specifies the amount of time to wait
@ -76,9 +76,11 @@ The Jolokia plugin collects JVM metrics exposed as MBean's attributes through
jolokia REST endpoint. All metrics are collected for each server configured. jolokia REST endpoint. All metrics are collected for each server configured.
See [official Jolokia website](https://jolokia.org/) for more information. See [official Jolokia website](https://jolokia.org/) for more information.
## Measurements ## Metrics
Jolokia plugin produces one measure for each metric configured, Jolokia plugin produces one measure for each metric configured,
adding Server's `jolokia_name`, `jolokia_host` and `jolokia_port` as tags. adding Server's `jolokia_name`, `jolokia_host` and `jolokia_port` as tags.
[jolokia2]: /plugins/inputs/jolokia2 [jolokia2]: /plugins/inputs/jolokia2
## Example Output

View File

@ -55,3 +55,7 @@ Running integration tests requires running Zookeeper & Kafka. See Makefile
for kafka container command. for kafka container command.
[Kafka Consumer input plugin]: ../kafka_consumer/README.md [Kafka Consumer input plugin]: ../kafka_consumer/README.md
## Metrics
## Example Output

View File

@ -33,7 +33,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# insecure_skip_verify = false # insecure_skip_verify = false
``` ```
## Measurements and fields ## Metrics
### Measurements and fields
- [kapacitor](#kapacitor) - [kapacitor](#kapacitor)
- [num_enabled_tasks](#num_enabled_tasks) _(integer)_ - [num_enabled_tasks](#num_enabled_tasks) _(integer)_

View File

@ -57,7 +57,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# no configuration # no configuration
``` ```
## Measurements & Fields ## Metrics
- kernel - kernel
- boot_time (integer, seconds since epoch, `btime`) - boot_time (integer, seconds since epoch, `btime`)
@ -68,10 +68,6 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
- processes_forked (integer, `processes`) - processes_forked (integer, `processes`)
- entropy_avail (integer, `entropy_available`) - entropy_avail (integer, `entropy_available`)
## Tags
None
## Example Output ## Example Output
```shell ```shell

View File

@ -128,7 +128,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# no configuration # no configuration
``` ```
## Measurements & Fields ## Metrics
- kernel_vmstat - kernel_vmstat
- nr_free_pages (integer, `nr_free_pages`) - nr_free_pages (integer, `nr_free_pages`)
@ -223,14 +223,10 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
- thp_collapse_alloc_failed (integer, `thp_collapse_alloc_failed`) - thp_collapse_alloc_failed (integer, `thp_collapse_alloc_failed`)
- thp_split (integer, `thp_split`) - thp_split (integer, `thp_split`)
## Tags
None
## Example Output ## Example Output
```shell ```shell
$ telegraf --config ~/ws/telegraf.conf --input-filter kernel_vmstat --test $ telegraf --config ~/ws/telegraf.conf --input-filter kernel_vmstat --test
* Plugin: kernel_vmstat, Collection 1 * Plugin: kernel_vmstat, Collection 1
> kernel_vmstat allocstall=81496i,compact_blocks_moved=238196i,compact_fail=135220i,compact_pagemigrate_failed=0i,compact_pages_moved=6370588i,compact_stall=142092i,compact_success=6872i,htlb_buddy_alloc_fail=0i,htlb_buddy_alloc_success=0i,kswapd_high_wmark_hit_quickly=25439i,kswapd_inodesteal=29770874i,kswapd_low_wmark_hit_quickly=8756i,kswapd_skip_congestion_wait=0i,kswapd_steal=291534428i,nr_active_anon=2515657i,nr_active_file=2244914i,nr_anon_pages=1358675i,nr_anon_transparent_hugepages=2034i,nr_bounce=0i,nr_dirty=5690i,nr_file_pages=5153546i,nr_free_pages=78730i,nr_inactive_anon=426259i,nr_inactive_file=2366791i,nr_isolated_anon=0i,nr_isolated_file=0i,nr_kernel_stack=579i,nr_mapped=558821i,nr_mlock=0i,nr_page_table_pages=11115i,nr_shmem=541689i,nr_slab_reclaimable=459806i,nr_slab_unreclaimable=47859i,nr_unevictable=0i,nr_unstable=0i,nr_vmscan_write=6206i,nr_writeback=0i,nr_writeback_temp=0i,numa_foreign=0i,numa_hit=5113399878i,numa_interleave=35793i,numa_local=5113399878i,numa_miss=0i,numa_other=0i,pageoutrun=505006i,pgactivate=375664931i,pgalloc_dma=0i,pgalloc_dma32=122480220i,pgalloc_movable=0i,pgalloc_normal=5233176719i,pgdeactivate=122735906i,pgfault=8699921410i,pgfree=5359765021i,pginodesteal=9188431i,pgmajfault=122210i,pgpgin=219717626i,pgpgout=3495885510i,pgrefill_dma=0i,pgrefill_dma32=1180010i,pgrefill_movable=0i,pgrefill_normal=119866676i,pgrotated=60620i,pgscan_direct_dma=0i,pgscan_direct_dma32=12256i,pgscan_direct_movable=0i,pgscan_direct_normal=31501600i,pgscan_kswapd_dma=0i,pgscan_kswapd_dma32=4480608i,pgscan_kswapd_movable=0i,pgscan_kswapd_normal=287857984i,pgsteal_dma=0i,pgsteal_dma32=4466436i,pgsteal_movable=0i,pgsteal_normal=318463755i,pswpin=2092i,pswpout=6206i,slabs_scanned=93775616i,thp_collapse_alloc=24857i,thp_collapse_alloc_failed=102214i,thp_fault_alloc=346219i,thp_fault_fallback=895453i,thp_split=9817i,unevictable_pgs_cleared=0i,unevictable_pgs_culled=1531i,unevictable_pgs_mlocked=6988i,unevictable_pgs_mlockfreed=0i,unevictable_pgs_munlocked=6988i,unevictable_pgs_rescued=5426i,unevictable_pgs_scanned=0i,unevictable_pgs_stranded=0i,zone_reclaim_failed=0i 1459455200071462843 > kernel_vmstat allocstall=81496i,compact_blocks_moved=238196i,compact_fail=135220i,compact_pagemigrate_failed=0i,compact_pages_moved=6370588i,compact_stall=142092i,compact_success=6872i,htlb_buddy_alloc_fail=0i,htlb_buddy_alloc_success=0i,kswapd_high_wmark_hit_quickly=25439i,kswapd_inodesteal=29770874i,kswapd_low_wmark_hit_quickly=8756i,kswapd_skip_congestion_wait=0i,kswapd_steal=291534428i,nr_active_anon=2515657i,nr_active_file=2244914i,nr_anon_pages=1358675i,nr_anon_transparent_hugepages=2034i,nr_bounce=0i,nr_dirty=5690i,nr_file_pages=5153546i,nr_free_pages=78730i,nr_inactive_anon=426259i,nr_inactive_file=2366791i,nr_isolated_anon=0i,nr_isolated_file=0i,nr_kernel_stack=579i,nr_mapped=558821i,nr_mlock=0i,nr_page_table_pages=11115i,nr_shmem=541689i,nr_slab_reclaimable=459806i,nr_slab_unreclaimable=47859i,nr_unevictable=0i,nr_unstable=0i,nr_vmscan_write=6206i,nr_writeback=0i,nr_writeback_temp=0i,numa_foreign=0i,numa_hit=5113399878i,numa_interleave=35793i,numa_local=5113399878i,numa_miss=0i,numa_other=0i,pageoutrun=505006i,pgactivate=375664931i,pgalloc_dma=0i,pgalloc_dma32=122480220i,pgalloc_movable=0i,pgalloc_normal=5233176719i,pgdeactivate=122735906i,pgfault=8699921410i,pgfree=5359765021i,pginodesteal=9188431i,pgmajfault=122210i,pgpgin=219717626i,pgpgout=3495885510i,pgrefill_dma=0i,pgrefill_dma32=1180010i,pgrefill_movable=0i,pgrefill_normal=119866676i,pgrotated=60620i,pgscan_direct_dma=0i,pgscan_direct_dma32=12256i,pgscan_direct_movable=0i,pgscan_direct_normal=31501600i,pgscan_kswapd_dma=0i,pgscan_kswapd_dma32=4480608i,pgscan_kswapd_movable=0i,pgscan_kswapd_normal=287857984i,pgsteal_dma=0i,pgsteal_dma32=4466436i,pgsteal_movable=0i,pgsteal_normal=318463755i,pswpin=2092i,pswpout=6206i,slabs_scanned=93775616i,thp_collapse_alloc=24857i,thp_collapse_alloc_failed=102214i,thp_fault_alloc=346219i,thp_fault_fallback=895453i,thp_split=9817i,unevictable_pgs_cleared=0i,unevictable_pgs_culled=1531i,unevictable_pgs_mlocked=6988i,unevictable_pgs_mlockfreed=0i,unevictable_pgs_munlocked=6988i,unevictable_pgs_rescued=5426i,unevictable_pgs_scanned=0i,unevictable_pgs_stranded=0i,zone_reclaim_failed=0i 1459455200071462843
``` ```

View File

@ -108,3 +108,7 @@ Sort key: shard_id
[kinesis]: https://aws.amazon.com/kinesis/ [kinesis]: https://aws.amazon.com/kinesis/
[input data formats]: /docs/DATA_FORMATS_INPUT.md [input data formats]: /docs/DATA_FORMATS_INPUT.md
## Metrics
## Example Output

View File

@ -91,7 +91,7 @@ Get the max buffer_size for over the last hour for all switches.
SELECT max("buffer_size") AS "max_buffer_size" FROM "global_buffer_usage_record" WHERE time > now() - 1h GROUP BY time(10s), "hostname" SELECT max("buffer_size") AS "max_buffer_size" FROM "global_buffer_usage_record" WHERE time > now() - 1h GROUP BY time(10s), "hostname"
``` ```
## Example output ## Example Output
```shell ```shell
lanz_global_buffer_usage_record,entry_type=2,host=telegraf.int.example.com,port=50001,source=switch01.int.example.com timestamp=158334105824919i,buffer_size=505i,duration=0i 1583341058300643815 lanz_global_buffer_usage_record,entry_type=2,host=telegraf.int.example.com,port=50001,source=switch01.int.example.com timestamp=158334105824919i,buffer_size=505i,duration=0i 1583341058300643815

View File

@ -23,7 +23,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
servers = ["127.0.0.1:4010"] servers = ["127.0.0.1:4010"]
``` ```
## Measurements & Fields ## Metrics
### Statistics specific to the internals of LeoManager ### Statistics specific to the internals of LeoManager
@ -162,9 +162,9 @@ All measurements have the following tags:
- node - node
### Example output ## Example Output
#### LeoManager ### LeoManager
```bash ```bash
$ ./telegraf --config ./plugins/inputs/leofs/leo_manager.conf --input-filter leofs --test $ ./telegraf --config ./plugins/inputs/leofs/leo_manager.conf --input-filter leofs --test
@ -186,7 +186,7 @@ $ ./telegraf --config ./plugins/inputs/leofs/leo_manager.conf --input-filter leo
1524105758000000000 1524105758000000000
``` ```
#### LeoStorage ### LeoStorage
```bash ```bash
$ ./telegraf --config ./plugins/inputs/leofs/leo_storage.conf --input-filter leofs --test $ ./telegraf --config ./plugins/inputs/leofs/leo_storage.conf --input-filter leofs --test
@ -233,7 +233,7 @@ $ ./telegraf --config ./plugins/inputs/leofs/leo_storage.conf --input-filter leo
1524529826000000000 1524529826000000000
``` ```
#### LeoGateway ### LeoGateway
```shell ```shell
$ ./telegraf --config ./plugins/inputs/leofs/leo_gateway.conf --input-filter leofs --test $ ./telegraf --config ./plugins/inputs/leofs/leo_gateway.conf --input-filter leofs --test

View File

@ -26,3 +26,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
[[inputs.linux_sysctl_fs]] [[inputs.linux_sysctl_fs]]
# no configuration # no configuration
``` ```
## Metrics
## Example Output

View File

@ -123,3 +123,7 @@ configuration.
[tail]: /plugins/inputs/tail/README.md [tail]: /plugins/inputs/tail/README.md
[grok parser]: /plugins/parsers/grok/README.md [grok parser]: /plugins/parsers/grok/README.md
## Metrics
## Example Output

View File

@ -66,3 +66,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
- list_stats_unsub_rate (double, percentage) - list_stats_unsub_rate (double, percentage)
- list_stats_open_rate (double, percentage) - list_stats_open_rate (double, percentage)
- list_stats_click_rate (double, percentage) - list_stats_click_rate (double, percentage)
## Example Output

View File

@ -67,6 +67,10 @@ The available algorithms for generating mock data include:
* Step - always add the step value, negative values accepted * Step - always add the step value, negative values accepted
* Stock - generate fake, stock-like price values based on a volatility variable * Stock - generate fake, stock-like price values based on a volatility variable
## Metrics
Metrics are entirely based on the user's own configuration and settings.
## Example Output ## Example Output
The following example shows all available algorithms configured with an The following example shows all available algorithms configured with an

View File

@ -45,6 +45,8 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
conversion = "float(3)" conversion = "float(3)"
``` ```
## Metrics
Each file table can contain the following options: Each file table can contain the following options:
* `file`: * `file`:

View File

@ -384,3 +384,5 @@ The unit of fields varies by the tags.
* engine * engine
* row_format * row_format
* create_options * create_options
## Example Output

View File

@ -34,7 +34,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
response_timeout = "5s" response_timeout = "5s"
``` ```
## Measurements & Fields ## Metrics
- Measurement - Measurement
- accepts - accepts

View File

@ -39,3 +39,5 @@ have a look at Nomad following documentation:
- [https://www.nomadproject.io/docs/operations/metrics](https://www.nomadproject.io/docs/operations/metrics) - [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) - [https://www.nomadproject.io/docs/operations/telemetry](https://www.nomadproject.io/docs/operations/telemetry)
## Example Output

View File

@ -186,3 +186,5 @@ dots in the nsd-control stat name are replaced by underscores (see
- server - server
- fields: - fields:
- queries - queries
## Example Output

View File

@ -29,3 +29,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
## Use TLS but skip chain & host verification ## Use TLS but skip chain & host verification
# insecure_skip_verify = false # insecure_skip_verify = false
``` ```
## Metrics
## Example Output

View File

@ -48,3 +48,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
[nsq]: https://nsq.io [nsq]: https://nsq.io
[input data formats]: /docs/DATA_FORMATS_INPUT.md [input data formats]: /docs/DATA_FORMATS_INPUT.md
## Metrics
## Example Output

View File

@ -360,3 +360,5 @@ error would be raised.
* All measurements have the following tags * All measurements have the following tags
* host (host of the system) * host (host of the system)
* name (the type of the metric: snmp, snmp6 or netstat) * name (the type of the metric: snmp, snmp6 or netstat)
## Example Output

View File

@ -34,7 +34,7 @@ On many systems this can be accomplished by adding the `telegraf` user to the
usermod telegraf -a -G pdns usermod telegraf -a -G pdns
``` ```
## Measurements & Fields ## Metrics
- powerdns - powerdns
- corrupt-packets - corrupt-packets

View File

@ -95,7 +95,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
location = "/var/lib/puppet/state/last_run_summary.yaml" location = "/var/lib/puppet/state/last_run_summary.yaml"
``` ```
## Measurements ## Metrics
### PuppetAgent int64 measurements ### PuppetAgent int64 measurements
@ -164,3 +164,5 @@ Meta:
Measurement names: Measurement names:
- puppetagent_version_puppet - puppetagent_version_puppet
## Example Output

View File

@ -66,3 +66,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
- total_reads (integer, reads) - total_reads (integer, reads)
- written_docs_per_sec (integer, writes) - written_docs_per_sec (integer, writes)
- total_writes (integer, writes) - total_writes (integer, writes)
## Example Output

View File

@ -50,3 +50,7 @@ configuration above.
Riemann `Service` is mapped as `measurement`. `metric` and `TTL` are converted Riemann `Service` is mapped as `measurement`. `metric` and `TTL` are converted
into field values. As Riemann tags as simply an array, they are converted into into field values. As Riemann tags as simply an array, they are converted into
the `influx_line` format key-value, where both key and value are the tags. the `influx_line` format key-value, where both key and value are the tags.
## Metrics
## Example Output

View File

@ -36,7 +36,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# password = "pa$$word" # password = "pa$$word"
``` ```
## Example output of gathered metrics ## Metrics
## Example Output
```shell ```shell
➜ ~ telegraf -config telegraf.conf -input-filter solr -test ➜ ~ telegraf -config telegraf.conf -input-filter solr -test

View File

@ -276,3 +276,5 @@ mem.cached.localhost:256|g
Consult the [Template Patterns](/docs/TEMPLATE_PATTERN.md) documentation for Consult the [Template Patterns](/docs/TEMPLATE_PATTERN.md) documentation for
additional details. additional details.
## Example Output

View File

@ -20,3 +20,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
# socket_listener plugin # socket_listener plugin
# see https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener # see https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener
``` ```
## Metrics
## Example Output

View File

@ -22,3 +22,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
## Monitor pool name ## Monitor pool name
pools = ["redis_pool", "mc_pool"] pools = ["redis_pool", "mc_pool"]
``` ```
## Metrics
## Example Output

View File

@ -19,3 +19,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
[[inputs.udp_listener]] [[inputs.udp_listener]]
# see https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener # see https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener
``` ```
## Metrics
## Example Output

View File

@ -46,3 +46,5 @@ following Vault documentation:
- [https://www.vaultproject.io/docs/internals/telemetry](https://www.vaultproject.io/docs/internals/telemetry) - [https://www.vaultproject.io/docs/internals/telemetry](https://www.vaultproject.io/docs/internals/telemetry)
- [https://learn.hashicorp.com/tutorials/vault/monitor-telemetry-audit-splunk?in=vault/monitoring](https://learn.hashicorp.com/tutorials/vault/monitor-telemetry-audit-splunk?in=vault/monitoring) - [https://learn.hashicorp.com/tutorials/vault/monitor-telemetry-audit-splunk?in=vault/monitoring](https://learn.hashicorp.com/tutorials/vault/monitor-telemetry-audit-splunk?in=vault/monitoring)
## Example Output

View File

@ -74,7 +74,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
## HTTP basic auth ## HTTP basic auth
#username = "" #username = ""
#password = "" #password = ""
[inputs.webhooks.artifactory] [inputs.webhooks.artifactory]
path = "/artifactory" path = "/artifactory"
``` ```
@ -96,3 +96,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
1. Import your plugin in the `webhooks.go` file and add it to the `Webhooks` struct 1. Import your plugin in the `webhooks.go` file and add it to the `Webhooks` struct
Both [Github](github/) and [Rollbar](rollbar/) are good example to follow. Both [Github](github/) and [Rollbar](rollbar/) are good example to follow.
## Metrics
## Example Output

View File

@ -195,3 +195,5 @@ influxDB engine][1].
] ]
} }
``` ```
## Example Output