README
¶
NSQ Consumer Input Plugin
This service plugin consumes messages from NSQ realtime distributed messaging platform brokers in one of the supported data formats.
⭐ Telegraf v0.10.1 🏷️ messaging 💻 all
Service Input
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:
- The global or plugin specific
intervalsetting may not apply - The CLI options of
--test,--test-wait, and--oncemay not produce output for this plugin
Global configuration options
Plugins support additional global and plugin configuration settings for tasks such as modifying metrics, tags, and fields, creating aliases, and configuring plugin ordering. See CONFIGURATION.md for more details.
Configuration
# 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/netxops/unicontroller/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.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type NSQConsumer ¶
type NSQConsumer struct {
Nsqd []string `toml:"nsqd"`
Nsqlookupd []string `toml:"nsqlookupd"`
Topic string `toml:"topic"`
Channel string `toml:"channel"`
MaxInFlight int `toml:"max_in_flight"`
MaxUndeliveredMessages int `toml:"max_undelivered_messages"`
Log telegraf.Logger `toml:"-"`
// contains filtered or unexported fields
}
func (*NSQConsumer) Gather ¶
func (*NSQConsumer) Gather(telegraf.Accumulator) error
func (*NSQConsumer) Init ¶
func (n *NSQConsumer) Init() error
func (*NSQConsumer) SampleConfig ¶
func (*NSQConsumer) SampleConfig() string
func (*NSQConsumer) SetParser ¶
func (n *NSQConsumer) SetParser(parser telegraf.Parser)
SetParser takes the data_format from the config and finds the right parser for that format
func (*NSQConsumer) Start ¶
func (n *NSQConsumer) Start(ac telegraf.Accumulator) error
func (*NSQConsumer) Stop ¶
func (n *NSQConsumer) Stop()
Source Files