diff --git a/plugins/inputs/burrow/README.md b/plugins/inputs/burrow/README.md index c722c3f5c..4942fcc63 100644 --- a/plugins/inputs/burrow/README.md +++ b/plugins/inputs/burrow/README.md @@ -112,3 +112,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. * cluster (string) * topic (string) * partition (int) + +## Example Output diff --git a/plugins/inputs/cgroup/README.md b/plugins/inputs/cgroup/README.md index 3335ea288..7e7f6f41d 100644 --- a/plugins/inputs/cgroup/README.md +++ b/plugins/inputs/cgroup/README.md @@ -83,3 +83,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # ] # files = ["*"] ``` + +## Example Output diff --git a/plugins/inputs/cloud_pubsub/README.md b/plugins/inputs/cloud_pubsub/README.md index a9da449f2..58d80c133 100644 --- a/plugins/inputs/cloud_pubsub/README.md +++ b/plugins/inputs/cloud_pubsub/README.md @@ -104,3 +104,7 @@ subscriptions/topics. [pubsub]: https://cloud.google.com/pubsub [pubsub create sub]: https://cloud.google.com/pubsub/docs/admin#create_a_pull_subscription [input data formats]: /docs/DATA_FORMATS_INPUT.md + +## Metrics + +## Example Output diff --git a/plugins/inputs/cloud_pubsub_push/README.md b/plugins/inputs/cloud_pubsub_push/README.md index 7bd7869a4..0da886d32 100644 --- a/plugins/inputs/cloud_pubsub_push/README.md +++ b/plugins/inputs/cloud_pubsub_push/README.md @@ -82,3 +82,7 @@ This plugin assumes you have already created a PUSH subscription for a given PubSub topic. [pubsub]: https://cloud.google.com/pubsub + +## Metrics + +## Example Output diff --git a/plugins/inputs/consul_agent/README.md b/plugins/inputs/consul_agent/README.md index 466ee1f94..4aee10231 100644 --- a/plugins/inputs/consul_agent/README.md +++ b/plugins/inputs/consul_agent/README.md @@ -45,3 +45,5 @@ Consul collects various metrics. For every details, please have a look at Consul following documentation: - [https://www.consul.io/api/agent#view-metrics](https://www.consul.io/api/agent#view-metrics) + +## Example Output diff --git a/plugins/inputs/csgo/README.md b/plugins/inputs/csgo/README.md index 5e2637c9c..666d21d61 100644 --- a/plugins/inputs/csgo/README.md +++ b/plugins/inputs/csgo/README.md @@ -47,3 +47,5 @@ If no servers are specified, no data will be collected - sv_ms (float) - variance_ms (float) - tick_ms (float) + +## Example Output diff --git a/plugins/inputs/disque/README.md b/plugins/inputs/disque/README.md index 135d53a35..91087354a 100644 --- a/plugins/inputs/disque/README.md +++ b/plugins/inputs/disque/README.md @@ -45,3 +45,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. - used_cpu_user_children - registered_jobs - registered_queues + +## Example Output diff --git a/plugins/inputs/ecs/README.md b/plugins/inputs/ecs/README.md index 802eb68ae..7b036b5df 100644 --- a/plugins/inputs/ecs/README.md +++ b/plugins/inputs/ecs/README.md @@ -229,7 +229,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. - started_at - type -## Example +## Example Output ```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 diff --git a/plugins/inputs/elasticsearch/README.md b/plugins/inputs/elasticsearch/README.md index 69bb3dac5..ef6a475c1 100644 --- a/plugins/inputs/elasticsearch/README.md +++ b/plugins/inputs/elasticsearch/README.md @@ -879,3 +879,5 @@ Emitted when the appropriate `shards_stats` options are set. - warmer_current (float) - warmer_total (float) - warmer_total_time_in_millis (float) + +## Example Output diff --git a/plugins/inputs/elasticsearch_query/README.md b/plugins/inputs/elasticsearch_query/README.md index b3e882708..57a34fc3c 100755 --- a/plugins/inputs/elasticsearch_query/README.md +++ b/plugins/inputs/elasticsearch_query/README.md @@ -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 [agg]: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations-metrics.html + +## Metrics + +## Example Output diff --git a/plugins/inputs/eventhub_consumer/README.md b/plugins/inputs/eventhub_consumer/README.md index 2ba4c6cf3..c6ffe72c5 100644 --- a/plugins/inputs/eventhub_consumer/README.md +++ b/plugins/inputs/eventhub_consumer/README.md @@ -116,3 +116,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. [Full documentation of the available environment variables][envvar]. [envvar]: https://github.com/Azure/azure-event-hubs-go#environment-variables + +## Metrics + +## Example Output diff --git a/plugins/inputs/exec/README.md b/plugins/inputs/exec/README.md index ffcbd337c..ce48ac9df 100644 --- a/plugins/inputs/exec/README.md +++ b/plugins/inputs/exec/README.md @@ -86,3 +86,7 @@ available for output: ```shell $host.UI.RawUI.BufferSize = new-object System.Management.Automation.Host.Size(1024,50) ``` + +## Metrics + +## Example Output diff --git a/plugins/inputs/execd/README.md b/plugins/inputs/execd/README.md index f1d68dacc..c5574065e 100644 --- a/plugins/inputs/execd/README.md +++ b/plugins/inputs/execd/README.md @@ -136,3 +136,7 @@ end [Input Data Formats]: ../../../docs/DATA_FORMATS_INPUT.md [inputs.exec]: ../exec/README.md + +## Metrics + +## Example Output diff --git a/plugins/inputs/file/README.md b/plugins/inputs/file/README.md index b7046d0e4..f732125ae 100644 --- a/plugins/inputs/file/README.md +++ b/plugins/inputs/file/README.md @@ -54,3 +54,5 @@ format of the file. [input data format]: /docs/DATA_FORMATS_INPUT.md [tail]: /plugins/inputs/tail + +## Example Output diff --git a/plugins/inputs/filestat/README.md b/plugins/inputs/filestat/README.md index 964a3bd0a..d4f323b51 100644 --- a/plugins/inputs/filestat/README.md +++ b/plugins/inputs/filestat/README.md @@ -25,7 +25,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. md5 = false ``` -## Measurements & Fields +## Metrics + +### Measurements & Fields - filestat - exists (int, 0 | 1) @@ -33,12 +35,12 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. - modification_time (int, unix time nanoseconds) - md5 (optional, string) -## Tags +### Tags - All measurements have the following tags: - file (the path the to file, as specified in the config) -### Example +## Example Output ```shell $ telegraf --config /etc/telegraf/telegraf.conf --input-filter filestat --test diff --git a/plugins/inputs/fireboard/README.md b/plugins/inputs/fireboard/README.md index 324e7e63c..4b246b243 100644 --- a/plugins/inputs/fireboard/README.md +++ b/plugins/inputs/fireboard/README.md @@ -59,7 +59,7 @@ values are included if they are less than a minute old. - fields: - temperature (float, unit) -## Example +## Example Output This section shows example output in Line Protocol format. You can often use `telegraf --input-filter --test` or use the `file` output to get diff --git a/plugins/inputs/fluentd/README.md b/plugins/inputs/fluentd/README.md index 0ce8330dc..c6b559ad0 100644 --- a/plugins/inputs/fluentd/README.md +++ b/plugins/inputs/fluentd/README.md @@ -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 @@ -69,9 +71,9 @@ Fields may vary depending on the plugin type - buffer_stage_length (float, unit) - buffer_queue_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: - plugin_id (unique plugin id) diff --git a/plugins/inputs/graylog/README.md b/plugins/inputs/graylog/README.md index 64267ec21..c83c9cc8e 100644 --- a/plugins/inputs/graylog/README.md +++ b/plugins/inputs/graylog/README.md @@ -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: `http://host:9000/api/api-browser` + +## Metrics + +## Example Output diff --git a/plugins/inputs/hddtemp/README.md b/plugins/inputs/hddtemp/README.md index ba0b59324..8527737a7 100644 --- a/plugins/inputs/hddtemp/README.md +++ b/plugins/inputs/hddtemp/README.md @@ -41,7 +41,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. - fields: - temperature -## Example output +## Example Output ```shell hddtemp,source=server1,unit=C,status=,device=sdb,model=WDC\ WD740GD-00FLA1 temperature=43i 1481655647000000000 diff --git a/plugins/inputs/httpjson/README.md b/plugins/inputs/httpjson/README.md index 2278905f6..16f5d903b 100644 --- a/plugins/inputs/httpjson/README.md +++ b/plugins/inputs/httpjson/README.md @@ -65,7 +65,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # apiVersion = "v1" ``` -## Measurements & Fields +## Metrics + +### Measurements & Fields - httpjson - 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 polled. -## Tags +### Tags - All measurements have the following tags: - 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 objects. -## Examples Output +## Example Output This plugin understands responses containing a single JSON object, or a JSON Array of Objects. diff --git a/plugins/inputs/hugepages/README.md b/plugins/inputs/hugepages/README.md index da4930ce8..9b0865a4c 100644 --- a/plugins/inputs/hugepages/README.md +++ b/plugins/inputs/hugepages/README.md @@ -31,7 +31,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # types = ["root", "per_node"] ``` -## Measurements +## Metrics + +### Measurements **The following measurements are supported by Hugepages plugin:** diff --git a/plugins/inputs/influxdb_listener/README.md b/plugins/inputs/influxdb_listener/README.md index 4953a2c11..524db3f6b 100644 --- a/plugins/inputs/influxdb_listener/README.md +++ b/plugins/inputs/influxdb_listener/README.md @@ -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/ [http_listener_v2]: /plugins/inputs/http_listener_v2/README.md + +## Example Output diff --git a/plugins/inputs/influxdb_v2_listener/README.md b/plugins/inputs/influxdb_v2_listener/README.md index e5ae867a7..1f6170412 100644 --- a/plugins/inputs/influxdb_v2_listener/README.md +++ b/plugins/inputs/influxdb_v2_listener/README.md @@ -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/ + +## Example Output diff --git a/plugins/inputs/intel_pmu/README.md b/plugins/inputs/intel_pmu/README.md index fd0f31c09..1e585f602 100644 --- a/plugins/inputs/intel_pmu/README.md +++ b/plugins/inputs/intel_pmu/README.md @@ -30,7 +30,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. [[inputs.intel_pmu]] ## 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"] - + ## List of core events measurement entities. There can be more than one core_events sections. [[inputs.intel_pmu.core_events]] ## 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 | | events_tag| (optional) tag as defined in "intel_pmu.uncore_events" configuration element | -## Example outputs +## Example Output Event group: @@ -228,7 +228,7 @@ pmu_metric,event=UNC_CBO_XSNP_RESPONSE.MISS_XCORE,host=xyz,socket=0,unit=uncore_ Uncore event aggregated: ```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: diff --git a/plugins/inputs/intel_rdt/README.md b/plugins/inputs/intel_rdt/README.md index 267577e20..6314e4708 100644 --- a/plugins/inputs/intel_rdt/README.md +++ b/plugins/inputs/intel_rdt/README.md @@ -7,7 +7,7 @@ hardware framework to monitor and control the utilization of shared resources ## About Intel RDT -Intel’s Resource Director Technology (RDT) framework consists of: +Intel’s Resource Director Technology (RDT) framework consists of: - Cache Monitoring Technology (CMT) - Memory Bandwidth Monitoring (MBM) @@ -105,12 +105,12 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ```toml @sample.conf # Read Intel RDT metrics [[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. ## If not provided or provided 0, will be set to 10 = 10x100ms = 1s. # 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. # 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. # 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. ## e.g. ["0-3", "4,5,6"] or ["1-3,4"] # cores = ["0-3"] @@ -133,7 +133,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # use_sudo = false ``` -## Exposed metrics +## Metrics | Name | Full name | Description | |---------------|-----------------------------------------------|-------------| diff --git a/plugins/inputs/ipmi_sensor/README.md b/plugins/inputs/ipmi_sensor/README.md index 20dd8b34b..3794b6c04 100644 --- a/plugins/inputs/ipmi_sensor/README.md +++ b/plugins/inputs/ipmi_sensor/README.md @@ -87,7 +87,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # cache_path = "" ``` -## Measurements +## Metrics Version 1 schema: diff --git a/plugins/inputs/ipset/README.md b/plugins/inputs/ipset/README.md index 70fac4f82..daf5b4589 100644 --- a/plugins/inputs/ipset/README.md +++ b/plugins/inputs/ipset/README.md @@ -70,6 +70,8 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ``` +## Metrics + ## Example Output ```sh diff --git a/plugins/inputs/iptables/README.md b/plugins/inputs/iptables/README.md index 8529c9731..4b510fe9f 100644 --- a/plugins/inputs/iptables/README.md +++ b/plugins/inputs/iptables/README.md @@ -97,13 +97,15 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. chains = [ "INPUT" ] ``` -## Measurements & Fields +## Metrics + +### Measurements & Fields * iptables * pkts (integer, count) * bytes (integer, bytes) -## Tags +### Tags * All measurements have the following tags: * table diff --git a/plugins/inputs/jolokia/README.md b/plugins/inputs/jolokia/README.md index 175256234..6654d84c1 100644 --- a/plugins/inputs/jolokia/README.md +++ b/plugins/inputs/jolokia/README.md @@ -29,7 +29,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # [inputs.jolokia.proxy] # host = "127.0.0.1" # port = "8080" - + ## Optional http timeouts ## ## 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. See [official Jolokia website](https://jolokia.org/) for more information. -## Measurements +## Metrics Jolokia plugin produces one measure for each metric configured, adding Server's `jolokia_name`, `jolokia_host` and `jolokia_port` as tags. [jolokia2]: /plugins/inputs/jolokia2 + +## Example Output diff --git a/plugins/inputs/kafka_consumer_legacy/README.md b/plugins/inputs/kafka_consumer_legacy/README.md index 900b40237..3eba826ff 100644 --- a/plugins/inputs/kafka_consumer_legacy/README.md +++ b/plugins/inputs/kafka_consumer_legacy/README.md @@ -55,3 +55,7 @@ Running integration tests requires running Zookeeper & Kafka. See Makefile for kafka container command. [Kafka Consumer input plugin]: ../kafka_consumer/README.md + +## Metrics + +## Example Output diff --git a/plugins/inputs/kapacitor/README.md b/plugins/inputs/kapacitor/README.md index 01f66883b..44721bc8e 100644 --- a/plugins/inputs/kapacitor/README.md +++ b/plugins/inputs/kapacitor/README.md @@ -33,7 +33,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # insecure_skip_verify = false ``` -## Measurements and fields +## Metrics + +### Measurements and fields - [kapacitor](#kapacitor) - [num_enabled_tasks](#num_enabled_tasks) _(integer)_ diff --git a/plugins/inputs/kernel/README.md b/plugins/inputs/kernel/README.md index 1b0601817..894589e10 100644 --- a/plugins/inputs/kernel/README.md +++ b/plugins/inputs/kernel/README.md @@ -57,7 +57,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # no configuration ``` -## Measurements & Fields +## Metrics - kernel - boot_time (integer, seconds since epoch, `btime`) @@ -68,10 +68,6 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. - processes_forked (integer, `processes`) - entropy_avail (integer, `entropy_available`) -## Tags - -None - ## Example Output ```shell diff --git a/plugins/inputs/kernel_vmstat/README.md b/plugins/inputs/kernel_vmstat/README.md index e75758a74..8485fd06b 100644 --- a/plugins/inputs/kernel_vmstat/README.md +++ b/plugins/inputs/kernel_vmstat/README.md @@ -128,7 +128,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # no configuration ``` -## Measurements & Fields +## Metrics - kernel_vmstat - 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_split (integer, `thp_split`) -## Tags - -None - ## Example Output ```shell $ telegraf --config ~/ws/telegraf.conf --input-filter kernel_vmstat --test * 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 ``` diff --git a/plugins/inputs/kinesis_consumer/README.md b/plugins/inputs/kinesis_consumer/README.md index a5b10a4b9..c66db5e6a 100644 --- a/plugins/inputs/kinesis_consumer/README.md +++ b/plugins/inputs/kinesis_consumer/README.md @@ -108,3 +108,7 @@ Sort key: shard_id [kinesis]: https://aws.amazon.com/kinesis/ [input data formats]: /docs/DATA_FORMATS_INPUT.md + +## Metrics + +## Example Output diff --git a/plugins/inputs/lanz/README.md b/plugins/inputs/lanz/README.md index a93cc6914..a1957c289 100644 --- a/plugins/inputs/lanz/README.md +++ b/plugins/inputs/lanz/README.md @@ -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" ``` -## Example output +## Example Output ```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 diff --git a/plugins/inputs/leofs/README.md b/plugins/inputs/leofs/README.md index 51f3b03ed..7f12e5754 100644 --- a/plugins/inputs/leofs/README.md +++ b/plugins/inputs/leofs/README.md @@ -23,7 +23,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. servers = ["127.0.0.1:4010"] ``` -## Measurements & Fields +## Metrics ### Statistics specific to the internals of LeoManager @@ -162,9 +162,9 @@ All measurements have the following tags: - node -### Example output +## Example Output -#### LeoManager +### LeoManager ```bash $ ./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 ``` -#### LeoStorage +### LeoStorage ```bash $ ./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 ``` -#### LeoGateway +### LeoGateway ```shell $ ./telegraf --config ./plugins/inputs/leofs/leo_gateway.conf --input-filter leofs --test diff --git a/plugins/inputs/linux_sysctl_fs/README.md b/plugins/inputs/linux_sysctl_fs/README.md index ea7418be7..3af0bb58d 100644 --- a/plugins/inputs/linux_sysctl_fs/README.md +++ b/plugins/inputs/linux_sysctl_fs/README.md @@ -26,3 +26,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. [[inputs.linux_sysctl_fs]] # no configuration ``` + +## Metrics + +## Example Output diff --git a/plugins/inputs/logparser/README.md b/plugins/inputs/logparser/README.md index 9f77dea4d..a9a372d7e 100644 --- a/plugins/inputs/logparser/README.md +++ b/plugins/inputs/logparser/README.md @@ -123,3 +123,7 @@ configuration. [tail]: /plugins/inputs/tail/README.md [grok parser]: /plugins/parsers/grok/README.md + +## Metrics + +## Example Output diff --git a/plugins/inputs/mailchimp/README.md b/plugins/inputs/mailchimp/README.md index 1a4d12a95..0320cf874 100644 --- a/plugins/inputs/mailchimp/README.md +++ b/plugins/inputs/mailchimp/README.md @@ -66,3 +66,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. - list_stats_unsub_rate (double, percentage) - list_stats_open_rate (double, percentage) - list_stats_click_rate (double, percentage) + +## Example Output diff --git a/plugins/inputs/mock/README.md b/plugins/inputs/mock/README.md index 19d79b644..306f89dc5 100644 --- a/plugins/inputs/mock/README.md +++ b/plugins/inputs/mock/README.md @@ -67,6 +67,10 @@ The available algorithms for generating mock data include: * Step - always add the step value, negative values accepted * 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 The following example shows all available algorithms configured with an diff --git a/plugins/inputs/multifile/README.md b/plugins/inputs/multifile/README.md index 9b56a0941..4b8ae752e 100644 --- a/plugins/inputs/multifile/README.md +++ b/plugins/inputs/multifile/README.md @@ -45,6 +45,8 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. conversion = "float(3)" ``` +## Metrics + Each file table can contain the following options: * `file`: diff --git a/plugins/inputs/mysql/README.md b/plugins/inputs/mysql/README.md index b50a35271..b42387ca9 100644 --- a/plugins/inputs/mysql/README.md +++ b/plugins/inputs/mysql/README.md @@ -384,3 +384,5 @@ The unit of fields varies by the tags. * engine * row_format * create_options + +## Example Output diff --git a/plugins/inputs/nginx/README.md b/plugins/inputs/nginx/README.md index 53518be05..c2eee7679 100644 --- a/plugins/inputs/nginx/README.md +++ b/plugins/inputs/nginx/README.md @@ -34,7 +34,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. response_timeout = "5s" ``` -## Measurements & Fields +## Metrics - Measurement - accepts diff --git a/plugins/inputs/nomad/README.md b/plugins/inputs/nomad/README.md index ad604a78c..94769bc83 100644 --- a/plugins/inputs/nomad/README.md +++ b/plugins/inputs/nomad/README.md @@ -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/telemetry](https://www.nomadproject.io/docs/operations/telemetry) + +## Example Output diff --git a/plugins/inputs/nsd/README.md b/plugins/inputs/nsd/README.md index f325dcd34..4c0b005a1 100644 --- a/plugins/inputs/nsd/README.md +++ b/plugins/inputs/nsd/README.md @@ -186,3 +186,5 @@ dots in the nsd-control stat name are replaced by underscores (see - server - fields: - queries + +## Example Output diff --git a/plugins/inputs/nsq/README.md b/plugins/inputs/nsq/README.md index 29abd886f..0c62abac5 100644 --- a/plugins/inputs/nsq/README.md +++ b/plugins/inputs/nsq/README.md @@ -29,3 +29,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ## Use TLS but skip chain & host verification # insecure_skip_verify = false ``` + +## Metrics + +## Example Output diff --git a/plugins/inputs/nsq_consumer/README.md b/plugins/inputs/nsq_consumer/README.md index 709708c53..2d380d850 100644 --- a/plugins/inputs/nsq_consumer/README.md +++ b/plugins/inputs/nsq_consumer/README.md @@ -48,3 +48,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. [nsq]: https://nsq.io [input data formats]: /docs/DATA_FORMATS_INPUT.md + +## Metrics + +## Example Output diff --git a/plugins/inputs/nstat/README.md b/plugins/inputs/nstat/README.md index 276de968e..925ac5d85 100644 --- a/plugins/inputs/nstat/README.md +++ b/plugins/inputs/nstat/README.md @@ -360,3 +360,5 @@ error would be raised. * All measurements have the following tags * host (host of the system) * name (the type of the metric: snmp, snmp6 or netstat) + +## Example Output diff --git a/plugins/inputs/powerdns/README.md b/plugins/inputs/powerdns/README.md index c0e69d84a..f7dd1bf92 100644 --- a/plugins/inputs/powerdns/README.md +++ b/plugins/inputs/powerdns/README.md @@ -34,7 +34,7 @@ On many systems this can be accomplished by adding the `telegraf` user to the usermod telegraf -a -G pdns ``` -## Measurements & Fields +## Metrics - powerdns - corrupt-packets diff --git a/plugins/inputs/puppetagent/README.md b/plugins/inputs/puppetagent/README.md index ec69e8b6b..899d90633 100644 --- a/plugins/inputs/puppetagent/README.md +++ b/plugins/inputs/puppetagent/README.md @@ -95,7 +95,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. location = "/var/lib/puppet/state/last_run_summary.yaml" ``` -## Measurements +## Metrics ### PuppetAgent int64 measurements @@ -164,3 +164,5 @@ Meta: Measurement names: - puppetagent_version_puppet + +## Example Output diff --git a/plugins/inputs/rethinkdb/README.md b/plugins/inputs/rethinkdb/README.md index 52309f6d8..85f9e0eb8 100644 --- a/plugins/inputs/rethinkdb/README.md +++ b/plugins/inputs/rethinkdb/README.md @@ -66,3 +66,5 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. - total_reads (integer, reads) - written_docs_per_sec (integer, writes) - total_writes (integer, writes) + +## Example Output diff --git a/plugins/inputs/riemann_listener/README.md b/plugins/inputs/riemann_listener/README.md index d1036defe..f3b4a8a88 100644 --- a/plugins/inputs/riemann_listener/README.md +++ b/plugins/inputs/riemann_listener/README.md @@ -50,3 +50,7 @@ configuration above. 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 the `influx_line` format key-value, where both key and value are the tags. + +## Metrics + +## Example Output diff --git a/plugins/inputs/solr/README.md b/plugins/inputs/solr/README.md index e3b7b3664..bf5da5a29 100644 --- a/plugins/inputs/solr/README.md +++ b/plugins/inputs/solr/README.md @@ -36,7 +36,9 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # password = "pa$$word" ``` -## Example output of gathered metrics +## Metrics + +## Example Output ```shell ➜ ~ telegraf -config telegraf.conf -input-filter solr -test diff --git a/plugins/inputs/statsd/README.md b/plugins/inputs/statsd/README.md index 915824a77..552517e95 100644 --- a/plugins/inputs/statsd/README.md +++ b/plugins/inputs/statsd/README.md @@ -276,3 +276,5 @@ mem.cached.localhost:256|g Consult the [Template Patterns](/docs/TEMPLATE_PATTERN.md) documentation for additional details. + +## Example Output diff --git a/plugins/inputs/tcp_listener/README.md b/plugins/inputs/tcp_listener/README.md index 74ea9b631..1da566252 100644 --- a/plugins/inputs/tcp_listener/README.md +++ b/plugins/inputs/tcp_listener/README.md @@ -20,3 +20,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # socket_listener plugin # see https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener ``` + +## Metrics + +## Example Output diff --git a/plugins/inputs/twemproxy/README.md b/plugins/inputs/twemproxy/README.md index 8a78e5c88..3bc00fd4f 100644 --- a/plugins/inputs/twemproxy/README.md +++ b/plugins/inputs/twemproxy/README.md @@ -22,3 +22,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ## Monitor pool name pools = ["redis_pool", "mc_pool"] ``` + +## Metrics + +## Example Output diff --git a/plugins/inputs/udp_listener/README.md b/plugins/inputs/udp_listener/README.md index 462707e02..cb8f1bb0b 100644 --- a/plugins/inputs/udp_listener/README.md +++ b/plugins/inputs/udp_listener/README.md @@ -19,3 +19,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. [[inputs.udp_listener]] # see https://github.com/influxdata/telegraf/tree/master/plugins/inputs/socket_listener ``` + +## Metrics + +## Example Output diff --git a/plugins/inputs/vault/README.md b/plugins/inputs/vault/README.md index e631c270d..a94e467f0 100644 --- a/plugins/inputs/vault/README.md +++ b/plugins/inputs/vault/README.md @@ -46,3 +46,5 @@ following Vault documentation: - [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) + +## Example Output diff --git a/plugins/inputs/webhooks/README.md b/plugins/inputs/webhooks/README.md index 6e3f82a98..98f2df477 100644 --- a/plugins/inputs/webhooks/README.md +++ b/plugins/inputs/webhooks/README.md @@ -74,7 +74,7 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ## HTTP basic auth #username = "" #password = "" - + [inputs.webhooks.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 Both [Github](github/) and [Rollbar](rollbar/) are good example to follow. + +## Metrics + +## Example Output diff --git a/plugins/inputs/zipkin/README.md b/plugins/inputs/zipkin/README.md index 4463f4d5d..7abe7ceea 100644 --- a/plugins/inputs/zipkin/README.md +++ b/plugins/inputs/zipkin/README.md @@ -195,3 +195,5 @@ influxDB engine][1]. ] } ``` + +## Example Output