diff --git a/docs/includes/service_input.md b/docs/includes/service_input.md new file mode 100644 index 000000000..866a69884 --- /dev/null +++ b/docs/includes/service_input.md @@ -0,0 +1,8 @@ +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin diff --git a/plugins/inputs/amqp_consumer/README.md b/plugins/inputs/amqp_consumer/README.md index 5d38f00b7..c8e0f1256 100644 --- a/plugins/inputs/amqp_consumer/README.md +++ b/plugins/inputs/amqp_consumer/README.md @@ -14,6 +14,17 @@ For an introduction to AMQP see: - [amqp - concepts](https://www.rabbitmq.com/tutorials/amqp-concepts.html) - [rabbitmq: getting started](https://www.rabbitmq.com/getstarted.html) +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/cisco_telemetry_mdt/README.md b/plugins/inputs/cisco_telemetry_mdt/README.md index dcfda5c70..7352c72ca 100644 --- a/plugins/inputs/cisco_telemetry_mdt/README.md +++ b/plugins/inputs/cisco_telemetry_mdt/README.md @@ -12,6 +12,17 @@ later, IOS XE 16.10 and later, as well as NX-OS 7.x and later platforms. The TCP dialout transport is supported on IOS XR (32-bit and 64-bit) 6.1.x and later. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/cloud_pubsub/README.md b/plugins/inputs/cloud_pubsub/README.md index bfde10185..7dc4ef590 100644 --- a/plugins/inputs/cloud_pubsub/README.md +++ b/plugins/inputs/cloud_pubsub/README.md @@ -3,6 +3,17 @@ The GCP PubSub plugin ingests metrics from [Google Cloud PubSub][pubsub] and creates metrics using one of the supported [input data formats][]. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/cloud_pubsub_push/README.md b/plugins/inputs/cloud_pubsub_push/README.md index 213af135e..5f6b44dab 100644 --- a/plugins/inputs/cloud_pubsub_push/README.md +++ b/plugins/inputs/cloud_pubsub_push/README.md @@ -14,6 +14,17 @@ Enable mutually authenticated TLS and authorize client connections by signing certificate authority by including a list of allowed CA certificate file names in `tls_allowed_cacerts`. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/cloudwatch_metric_streams/README.md b/plugins/inputs/cloudwatch_metric_streams/README.md index 918fd05b3..779f1fd29 100644 --- a/plugins/inputs/cloudwatch_metric_streams/README.md +++ b/plugins/inputs/cloudwatch_metric_streams/README.md @@ -7,6 +7,17 @@ for metrics sent via HTTP and performs the required processing for For cost, see the Metric Streams example in [CloudWatch pricing](#troubleshooting-documentation). +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/eventhub_consumer/README.md b/plugins/inputs/eventhub_consumer/README.md index 01691339a..7fb73b7eb 100644 --- a/plugins/inputs/eventhub_consumer/README.md +++ b/plugins/inputs/eventhub_consumer/README.md @@ -13,6 +13,17 @@ The main focus for development of this plugin is Azure IoT hub: 3. The connection string needed for the plugin is located under *Shared access policies*, both the *iothubowner* and *service* policies should work +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/execd/README.md b/plugins/inputs/execd/README.md index c5574065e..38a882676 100644 --- a/plugins/inputs/execd/README.md +++ b/plugins/inputs/execd/README.md @@ -13,6 +13,17 @@ new line to the process's STDIN. STDERR from the process will be relayed to Telegraf as errors in the logs. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/gnmi/README.md b/plugins/inputs/gnmi/README.md index 45f30f86f..3ee0fef1f 100644 --- a/plugins/inputs/gnmi/README.md +++ b/plugins/inputs/gnmi/README.md @@ -11,6 +11,17 @@ It has been optimized to support gNMI telemetry as produced by Cisco IOS XR [1]: https://github.com/openconfig/reference/blob/master/rpc/gnmi/gnmi-specification.md +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/http_listener_v2/README.md b/plugins/inputs/http_listener_v2/README.md index a0abfa678..70d4605f4 100644 --- a/plugins/inputs/http_listener_v2/README.md +++ b/plugins/inputs/http_listener_v2/README.md @@ -11,6 +11,17 @@ metrics in [InfluxDB Line Protocol][line_protocol] it's recommended to use the InfluxDB it is recommended to use [`influxdb_listener`][influxdb_listener] or [`influxdb_v2_listener`][influxdb_v2_listener]. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/influxdb_listener/README.md b/plugins/inputs/influxdb_listener/README.md index 524db3f6b..f33c67719 100644 --- a/plugins/inputs/influxdb_listener/README.md +++ b/plugins/inputs/influxdb_listener/README.md @@ -18,6 +18,17 @@ receive a 200 OK response with message body `{"results":[]}` but they are not relayed. The output configuration of the Telegraf instance which ultimately submits data to InfluxDB determines the destination database. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/influxdb_v2_listener/README.md b/plugins/inputs/influxdb_v2_listener/README.md index 1f6170412..9d36dace6 100644 --- a/plugins/inputs/influxdb_v2_listener/README.md +++ b/plugins/inputs/influxdb_v2_listener/README.md @@ -11,6 +11,17 @@ to the output plugins configuration. Telegraf minimum version: Telegraf 1.16.0 +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/intel_rdt/README.md b/plugins/inputs/intel_rdt/README.md index b04ff7523..3fb843286 100644 --- a/plugins/inputs/intel_rdt/README.md +++ b/plugins/inputs/intel_rdt/README.md @@ -91,6 +91,17 @@ process availability. - Enabling OS interface: , - More about Intel RDT: +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/jti_openconfig_telemetry/README.md b/plugins/inputs/jti_openconfig_telemetry/README.md index 3ee764734..cf0d69aeb 100644 --- a/plugins/inputs/jti_openconfig_telemetry/README.md +++ b/plugins/inputs/jti_openconfig_telemetry/README.md @@ -7,6 +7,17 @@ from listed sensors using Junos Telemetry Interface. Refer to [1]: https://www.juniper.net/documentation/en_US/junos/topics/concept/junos-telemetry-interface-oveview.html +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/kafka_consumer/README.md b/plugins/inputs/kafka_consumer/README.md index b8b845841..a7d519873 100644 --- a/plugins/inputs/kafka_consumer/README.md +++ b/plugins/inputs/kafka_consumer/README.md @@ -6,6 +6,17 @@ and creates metrics using one of the supported [input data formats][]. For old kafka version (< 0.8), please use the [kafka_consumer_legacy][] input plugin and use the old zookeeper connection method. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/kafka_consumer_legacy/README.md b/plugins/inputs/kafka_consumer_legacy/README.md index 3eba826ff..e26ba7a9d 100644 --- a/plugins/inputs/kafka_consumer_legacy/README.md +++ b/plugins/inputs/kafka_consumer_legacy/README.md @@ -9,6 +9,17 @@ instances of telegraf can read from the same topic in parallel. [1]: http://godoc.org/github.com/wvanbergen/kafka/consumergroup +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/kinesis_consumer/README.md b/plugins/inputs/kinesis_consumer/README.md index 624d034ec..985645ba6 100644 --- a/plugins/inputs/kinesis_consumer/README.md +++ b/plugins/inputs/kinesis_consumer/README.md @@ -3,6 +3,17 @@ The [Kinesis][kinesis] consumer plugin reads from a Kinesis data stream and creates metrics using one of the supported [input data formats][]. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/knx_listener/README.md b/plugins/inputs/knx_listener/README.md index 9d10f2d72..c34cd1009 100644 --- a/plugins/inputs/knx_listener/README.md +++ b/plugins/inputs/knx_listener/README.md @@ -5,6 +5,17 @@ This plugin connects to the KNX bus via a KNX-IP interface. Information about supported KNX message datapoint types can be found at the underlying "knx-go" project site (). +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/lanz/README.md b/plugins/inputs/lanz/README.md index a1957c289..4657d4398 100644 --- a/plugins/inputs/lanz/README.md +++ b/plugins/inputs/lanz/README.md @@ -13,6 +13,17 @@ This plugin uses Arista's sdk. - +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/logparser/README.md b/plugins/inputs/logparser/README.md index a9a372d7e..6e9a40644 100644 --- a/plugins/inputs/logparser/README.md +++ b/plugins/inputs/logparser/README.md @@ -46,6 +46,17 @@ Migration Example: + data_format = "grok" ``` +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/mqtt_consumer/README.md b/plugins/inputs/mqtt_consumer/README.md index 58b217da9..5f3284970 100644 --- a/plugins/inputs/mqtt_consumer/README.md +++ b/plugins/inputs/mqtt_consumer/README.md @@ -3,6 +3,17 @@ The [MQTT][mqtt] consumer plugin reads from the specified MQTT topics and creates metrics using one of the supported [input data formats][]. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/nats_consumer/README.md b/plugins/inputs/nats_consumer/README.md index 7b54fb3f5..d0a79293f 100644 --- a/plugins/inputs/nats_consumer/README.md +++ b/plugins/inputs/nats_consumer/README.md @@ -6,6 +6,17 @@ creates metrics using one of the supported [input data formats][]. A [Queue Group][queue group] is used when subscribing to subjects so multiple instances of telegraf can read from a NATS cluster in parallel. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/netflow/README.md b/plugins/inputs/netflow/README.md index 08930ff6d..040c0edfe 100644 --- a/plugins/inputs/netflow/README.md +++ b/plugins/inputs/netflow/README.md @@ -15,6 +15,17 @@ Definitions for IPFIX are according to [IANA assignement document][IPFIX doc]. [ASA extensions]: https://www.cisco.com/c/en/us/td/docs/security/asa/special/netflow/asa_netflow.html [IPFIX doc]: https://www.iana.org/assignments/ipfix/ipfix.xhtml#ipfix-nat-type +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/nsq_consumer/README.md b/plugins/inputs/nsq_consumer/README.md index 0b8ad5006..0312f30d9 100644 --- a/plugins/inputs/nsq_consumer/README.md +++ b/plugins/inputs/nsq_consumer/README.md @@ -3,6 +3,17 @@ The [NSQ][nsq] consumer plugin reads from NSQD and creates metrics using one of the supported [input data formats][]. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/opcua_listener/README.md b/plugins/inputs/opcua_listener/README.md index 19008aae8..64730433c 100644 --- a/plugins/inputs/opcua_listener/README.md +++ b/plugins/inputs/opcua_listener/README.md @@ -5,6 +5,17 @@ The `opcua_listener` plugin subscribes to data from OPC UA Server devices. Telegraf minimum version: Telegraf 1.25 Plugin minimum tested version: 1.25 +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/opentelemetry/README.md b/plugins/inputs/opentelemetry/README.md index 3ca8ddf7d..7efa7f416 100644 --- a/plugins/inputs/opentelemetry/README.md +++ b/plugins/inputs/opentelemetry/README.md @@ -3,6 +3,17 @@ This plugin receives traces, metrics and logs from [OpenTelemetry](https://opentelemetry.io) clients and agents via gRPC. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/riemann_listener/README.md b/plugins/inputs/riemann_listener/README.md index f3b4a8a88..62a2c5d04 100644 --- a/plugins/inputs/riemann_listener/README.md +++ b/plugins/inputs/riemann_listener/README.md @@ -3,6 +3,17 @@ The Riemann Listener is a simple input plugin that listens for messages from client that use riemann clients using riemann-protobuff format. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/sflow/README.md b/plugins/inputs/sflow/README.md index d05e37207..75f887af7 100644 --- a/plugins/inputs/sflow/README.md +++ b/plugins/inputs/sflow/README.md @@ -18,6 +18,17 @@ avoid cardinality issues: - Monitor your databases [series cardinality][]. - Consult the [InfluxDB documentation][influx-docs] for the most up-to-date techniques. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/socket_listener/README.md b/plugins/inputs/socket_listener/README.md index b4818f623..efbbadc73 100644 --- a/plugins/inputs/socket_listener/README.md +++ b/plugins/inputs/socket_listener/README.md @@ -6,6 +6,17 @@ streaming (tcp, unix) or datagram (udp, unixgram) protocols. The plugin expects messages in the [Telegraf Input Data Formats](../../../docs/DATA_FORMATS_INPUT.md). +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/statsd/README.md b/plugins/inputs/statsd/README.md index 3a4cdc5c1..2284be291 100644 --- a/plugins/inputs/statsd/README.md +++ b/plugins/inputs/statsd/README.md @@ -2,6 +2,17 @@ The StatsD input plugin gathers metrics from a Statsd server. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/suricata/README.md b/plugins/inputs/suricata/README.md index fcbc78f02..884137933 100644 --- a/plugins/inputs/suricata/README.md +++ b/plugins/inputs/suricata/README.md @@ -6,6 +6,17 @@ and much more. It provides a socket for the Suricata log output to write JSON stats output to, and processes the incoming data to fit Telegraf's format. It can also report for triggered Suricata IDS/IPS alerts. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/syslog/README.md b/plugins/inputs/syslog/README.md index fb6d26fb3..1210ccb68 100644 --- a/plugins/inputs/syslog/README.md +++ b/plugins/inputs/syslog/README.md @@ -10,6 +10,17 @@ Syslog messages should be formatted according to [RFC 5424](https://tools.ietf.org/html/rfc5424) (syslog protocol) or [RFC 3164](https://tools.ietf.org/html/rfc3164) (BSD syslog protocol). +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/tail/README.md b/plugins/inputs/tail/README.md index 70d55e888..1dc4bef68 100644 --- a/plugins/inputs/tail/README.md +++ b/plugins/inputs/tail/README.md @@ -19,6 +19,17 @@ see for more details. The plugin expects messages in one of the [Telegraf Input Data Formats](../../../docs/DATA_FORMATS_INPUT.md). +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/tcp_listener/README.md b/plugins/inputs/tcp_listener/README.md index 1da566252..31127014f 100644 --- a/plugins/inputs/tcp_listener/README.md +++ b/plugins/inputs/tcp_listener/README.md @@ -3,6 +3,17 @@ **DEPRECATED: As of version 1.3 the TCP listener plugin has been deprecated in favor of the [socket_listener plugin](../socket_listener/README.md)** +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/udp_listener/README.md b/plugins/inputs/udp_listener/README.md index cb8f1bb0b..19de2d8cc 100644 --- a/plugins/inputs/udp_listener/README.md +++ b/plugins/inputs/udp_listener/README.md @@ -3,6 +3,17 @@ **DEPRECATED: As of version 1.3 the UDP listener plugin has been deprecated in favor of the [socket_listener plugin](../socket_listener/README.md)** +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/webhooks/README.md b/plugins/inputs/webhooks/README.md index 98f2df477..55fda5dab 100644 --- a/plugins/inputs/webhooks/README.md +++ b/plugins/inputs/webhooks/README.md @@ -15,6 +15,17 @@ cp config.conf.new /etc/telegraf/telegraf.conf sudo service telegraf start ``` +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support diff --git a/plugins/inputs/win_eventlog/README.md b/plugins/inputs/win_eventlog/README.md index 33cb3e200..19fbb0b29 100644 --- a/plugins/inputs/win_eventlog/README.md +++ b/plugins/inputs/win_eventlog/README.md @@ -26,8 +26,8 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. # Input plugin to collect Windows Event Log messages # This plugin ONLY supports Windows [[inputs.win_eventlog]] - ## Telegraf should have Administrator permissions to subscribe for some Windows Events channels - ## (System log, for example) + ## Telegraf should have Administrator permissions to subscribe for some + ## Windows Events channels (e.g. System log) ## LCID (Locale ID) for event rendering ## 1033 to force English language @@ -65,46 +65,58 @@ See the [CONFIGURATION.md][CONFIGURATION.md] for more details. ''' - ## When true, event logs are read from the beginning; otherwise only future events - ## will be logged. + ## When true, event logs are read from the beginning; otherwise only future + ## events will be logged. # from_beginning = false - ## System field names: - ## "Source", "EventID", "Version", "Level", "Task", "Opcode", "Keywords", "TimeCreated", - ## "EventRecordID", "ActivityID", "RelatedActivityID", "ProcessID", "ThreadID", "ProcessName", - ## "Channel", "Computer", "UserID", "UserName", "Message", "LevelText", "TaskText", "OpcodeText" - - ## In addition to System, Data fields can be unrolled from additional XML nodes in event. - ## Human-readable representation of those nodes is formatted into event Message field, - ## but XML is more machine-parsable - # Process UserData XML to fields, if this node exists in Event XML - process_userdata = true + # process_userdata = true # Process EventData XML to fields, if this node exists in Event XML - process_eventdata = true + # process_eventdata = true ## Separator character to use for unrolled XML Data field names - separator = "_" + # separator = "_" - ## Get only first line of Message field. For most events first line is usually more than enough - only_first_line_of_message = true + ## Get only first line of Message field. For most events first line is + ## usually more than enough + # only_first_line_of_message = true ## Parse timestamp from TimeCreated.SystemTime event field. - ## Will default to current time of telegraf processing on parsing error or if set to false - timestamp_from_event = true + ## Will default to current time of telegraf processing on parsing error or if + ## set to false + # timestamp_from_event = true - ## Fields to include as tags. Globbing supported ("Level*" for both "Level" and "LevelText") - event_tags = ["Source", "EventID", "Level", "LevelText", "Task", "TaskText", "Opcode", "OpcodeText", "Keywords", "Channel", "Computer"] + ## System field names: + ## "Source", "EventID", "Version", "Level", "Task", "Opcode", "Keywords", + ## "TimeCreated", "EventRecordID", "ActivityID", "RelatedActivityID", + ## "ProcessID", "ThreadID", "ProcessName", "Channel", "Computer", "UserID", + ## "UserName", "Message", "LevelText", "TaskText", "OpcodeText" + ## + ## In addition to System, Data fields can be unrolled from additional XML + ## nodes in event. Human-readable representation of those nodes is formatted + ## into event Message field, but XML is more machine-parsable - ## Default list of fields to send. All fields are sent by default. Globbing supported - event_fields = ["*"] + ## Event fields to include as tags + ## The values below are included by default. + ## Globbing supported (e.g. "Level*" matches both "Level" and "LevelText") + # event_tags = ["Source", "EventID", "Level", "LevelText", "Task", "TaskText", "Opcode", "OpcodeText", "Keywords", "Channel", "Computer"] - ## Fields to exclude. Also applied to data fields. Globbing supported - exclude_fields = ["TimeCreated", "Binary", "Data_Address*"] + ## Event fields to include + ## All fields are sent by default. + ## Globbing supported (e.g. "Level*" matches both "Level" and "LevelText") + # event_fields = ["*"] - ## Skip those tags or fields if their value is empty or equals to zero. Globbing supported - exclude_empty = ["*ActivityID", "UserID"] + ## Event fields to exclude + ## Note that if you exclude all fields then no metrics are produced. A valid + ## metric includes at least one field. + ## Globbing supported (e.g. "Level*" matches both "Level" and "LevelText") + # exclude_fields = [] + + ## Event fields to exclude if their value is empty or equals to zero + ## The values below are included by default. + ## Globbing supported (e.g. "Level*" matches both "Level" and "LevelText") + # exclude_empty = ["Task", "Opcode", "*ActivityID", "UserID"] ``` ### Filtering diff --git a/plugins/inputs/win_eventlog/sample.conf b/plugins/inputs/win_eventlog/sample.conf index 099062ab7..dbc7cc632 100644 --- a/plugins/inputs/win_eventlog/sample.conf +++ b/plugins/inputs/win_eventlog/sample.conf @@ -1,8 +1,8 @@ # Input plugin to collect Windows Event Log messages # This plugin ONLY supports Windows [[inputs.win_eventlog]] - ## Telegraf should have Administrator permissions to subscribe for some Windows Events channels - ## (System log, for example) + ## Telegraf should have Administrator permissions to subscribe for some + ## Windows Events channels (e.g. System log) ## LCID (Locale ID) for event rendering ## 1033 to force English language @@ -40,43 +40,55 @@ ''' - ## When true, event logs are read from the beginning; otherwise only future events - ## will be logged. + ## When true, event logs are read from the beginning; otherwise only future + ## events will be logged. # from_beginning = false - ## System field names: - ## "Source", "EventID", "Version", "Level", "Task", "Opcode", "Keywords", "TimeCreated", - ## "EventRecordID", "ActivityID", "RelatedActivityID", "ProcessID", "ThreadID", "ProcessName", - ## "Channel", "Computer", "UserID", "UserName", "Message", "LevelText", "TaskText", "OpcodeText" - - ## In addition to System, Data fields can be unrolled from additional XML nodes in event. - ## Human-readable representation of those nodes is formatted into event Message field, - ## but XML is more machine-parsable - # Process UserData XML to fields, if this node exists in Event XML - process_userdata = true + # process_userdata = true # Process EventData XML to fields, if this node exists in Event XML - process_eventdata = true + # process_eventdata = true ## Separator character to use for unrolled XML Data field names - separator = "_" + # separator = "_" - ## Get only first line of Message field. For most events first line is usually more than enough - only_first_line_of_message = true + ## Get only first line of Message field. For most events first line is + ## usually more than enough + # only_first_line_of_message = true ## Parse timestamp from TimeCreated.SystemTime event field. - ## Will default to current time of telegraf processing on parsing error or if set to false - timestamp_from_event = true + ## Will default to current time of telegraf processing on parsing error or if + ## set to false + # timestamp_from_event = true - ## Fields to include as tags. Globbing supported ("Level*" for both "Level" and "LevelText") - event_tags = ["Source", "EventID", "Level", "LevelText", "Task", "TaskText", "Opcode", "OpcodeText", "Keywords", "Channel", "Computer"] + ## System field names: + ## "Source", "EventID", "Version", "Level", "Task", "Opcode", "Keywords", + ## "TimeCreated", "EventRecordID", "ActivityID", "RelatedActivityID", + ## "ProcessID", "ThreadID", "ProcessName", "Channel", "Computer", "UserID", + ## "UserName", "Message", "LevelText", "TaskText", "OpcodeText" + ## + ## In addition to System, Data fields can be unrolled from additional XML + ## nodes in event. Human-readable representation of those nodes is formatted + ## into event Message field, but XML is more machine-parsable - ## Default list of fields to send. All fields are sent by default. Globbing supported - event_fields = ["*"] + ## Event fields to include as tags + ## The values below are included by default. + ## Globbing supported (e.g. "Level*" matches both "Level" and "LevelText") + # event_tags = ["Source", "EventID", "Level", "LevelText", "Task", "TaskText", "Opcode", "OpcodeText", "Keywords", "Channel", "Computer"] - ## Fields to exclude. Also applied to data fields. Globbing supported - exclude_fields = ["TimeCreated", "Binary", "Data_Address*"] + ## Event fields to include + ## All fields are sent by default. + ## Globbing supported (e.g. "Level*" matches both "Level" and "LevelText") + # event_fields = ["*"] - ## Skip those tags or fields if their value is empty or equals to zero. Globbing supported - exclude_empty = ["*ActivityID", "UserID"] + ## Event fields to exclude + ## Note that if you exclude all fields then no metrics are produced. A valid + ## metric includes at least one field. + ## Globbing supported (e.g. "Level*" matches both "Level" and "LevelText") + # exclude_fields = [] + + ## Event fields to exclude if their value is empty or equals to zero + ## The values below are included by default. + ## Globbing supported (e.g. "Level*" matches both "Level" and "LevelText") + # exclude_empty = ["Task", "Opcode", "*ActivityID", "UserID"] diff --git a/plugins/inputs/zipkin/README.md b/plugins/inputs/zipkin/README.md index 7abe7ceea..114ed19e4 100644 --- a/plugins/inputs/zipkin/README.md +++ b/plugins/inputs/zipkin/README.md @@ -7,6 +7,17 @@ __Please Note:__ This plugin is experimental; Its data schema may be subject to change based on its main usage cases and the evolution of the OpenTracing standard. +## Service Input + +This plugin is a service input. Normal plugins gather metrics determined by the +interval setting. Service plugins start a service to listens and waits for +metrics or events to occur. Service plugins have two key differences from +normal plugins: + +1. The global or plugin specific `interval` setting may not apply +2. The CLI options of `--test`, `--test-wait`, and `--once` may not produce + output for this plugin + ## Global configuration options In addition to the plugin-specific configuration settings, plugins support