74 lines
2.6 KiB
Markdown
74 lines
2.6 KiB
Markdown
|
# NSQ Consumer Input Plugin
|
||
|
|
|
||
|
|
This service plugin consumes messages from [NSQ][nsq] realtime distributed
|
||
|
|
messaging platform brokers in one of the supported [data formats][data_formats].
|
||
|
|
|
||
|
|
⭐ Telegraf v0.10.1
|
||
|
|
🏷️ messaging
|
||
|
|
💻 all
|
||
|
|
|
||
|
|
[nsq]: https://nsq.io/
|
||
|
|
[data_formats]: /docs/DATA_FORMATS_INPUT.md
|
||
|
|
|
||
|
|
## Service Input <!-- @/docs/includes/service_input.md -->
|
||
|
|
|
||
|
|
This plugin is a service input. Normal plugins gather metrics determined by the
|
||
|
|
interval setting. Service plugins start a service to listen and wait 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 <!-- @/docs/includes/plugin_config.md -->
|
||
|
|
|
||
|
|
In addition to the plugin-specific configuration settings, plugins support
|
||
|
|
additional global and plugin configuration settings. These settings are used to
|
||
|
|
modify metrics, tags, and field or create aliases and configure ordering, etc.
|
||
|
|
See the [CONFIGURATION.md][CONFIGURATION.md] for more details.
|
||
|
|
|
||
|
|
[CONFIGURATION.md]: ../../../docs/CONFIGURATION.md#plugins
|
||
|
|
|
||
|
|
## Configuration
|
||
|
|
|
||
|
|
```toml @sample.conf
|
||
|
|
# Read metrics from NSQD topic(s)
|
||
|
|
[[inputs.nsq_consumer]]
|
||
|
|
## An array representing the NSQD TCP HTTP Endpoints
|
||
|
|
nsqd = ["localhost:4150"]
|
||
|
|
|
||
|
|
## An array representing the NSQLookupd HTTP Endpoints
|
||
|
|
nsqlookupd = ["localhost:4161"]
|
||
|
|
topic = "telegraf"
|
||
|
|
channel = "consumer"
|
||
|
|
max_in_flight = 100
|
||
|
|
|
||
|
|
## Max undelivered messages
|
||
|
|
## This plugin uses tracking metrics, which ensure messages are read to
|
||
|
|
## outputs before acknowledging them to the original broker to ensure data
|
||
|
|
## is not lost. This option sets the maximum messages to read from the
|
||
|
|
## broker that have not been written by an output.
|
||
|
|
##
|
||
|
|
## This value needs to be picked with awareness of the agent's
|
||
|
|
## metric_batch_size value as well. Setting max undelivered messages too high
|
||
|
|
## can result in a constant stream of data batches to the output. While
|
||
|
|
## setting it too low may never flush the broker's messages.
|
||
|
|
# max_undelivered_messages = 1000
|
||
|
|
|
||
|
|
## Data format to consume.
|
||
|
|
## Each data format has its own unique set of configuration options, read
|
||
|
|
## more about them here:
|
||
|
|
## https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_INPUT.md
|
||
|
|
data_format = "influx"
|
||
|
|
```
|
||
|
|
|
||
|
|
## Metrics
|
||
|
|
|
||
|
|
The plugin accepts arbitrary input and parses it according to the `data_format`
|
||
|
|
setting. There is no predefined metric format.
|
||
|
|
|
||
|
|
## Example Output
|
||
|
|
|
||
|
|
There is no predefined metric format, so output depends on plugin input.
|