telegraf/plugins/outputs/amqp
Mike Gent 2cc2913d81 Add static routing_key option to amqp output (#3994) 2018-06-03 15:52:00 -07:00
..
README.md Add static routing_key option to amqp output (#3994) 2018-06-03 15:52:00 -07:00
amqp.go Add static routing_key option to amqp output (#3994) 2018-06-03 15:52:00 -07:00
amqp_test.go Add Serializer plugins, and 'file' output plugin 2016-02-12 14:13:49 -07:00

README.md

AMQP Output Plugin

This plugin writes to a AMQP 0-9-1 Exchange, a promenent implementation of this protocol being RabbitMQ.

Metrics are written to a topic exchange using a routing key defined by:

  1. The routing_key config defines a static value
  2. The routing_tag config defines a metric tag with a dynamic value, overriding the static routing_key if found
  3. If neither option is defined, or the tag is not found in a metric, then the empty routing key will be used

Metrics are grouped in batches by the final routing key.

This plugin doesn't bind exchange to a queue, so it should be done by consumer. The exchange is always defined as type: topic. To use it for distributing metrics equally among workers (type: direct), set the routing_key to a static value on the exchange, declare and bind a single queue with the same routing_key, and consume from the same queue in each worker. To use it to send metrics to many consumers at once (type: fanout), set the routing_key to "#" on the exchange, then declare, bind, and consume from individual queues in each worker.

For an introduction to AMQP see:

Configuration:

# Configuration for the AMQP server to send metrics to
[[outputs.amqp]]
  ## AMQP url
  url = "amqp://localhost:5672/influxdb"
  ## AMQP exchange
  exchange = "telegraf"
  ## Auth method. PLAIN and EXTERNAL are supported
  ## Using EXTERNAL requires enabling the rabbitmq_auth_mechanism_ssl plugin as
  ## described here: https://www.rabbitmq.com/plugins.html
  # auth_method = "PLAIN"
  ## Topic routing key
  # routing_key = ""
  ## Telegraf tag to use as a routing key
  ##  ie, if this tag exists, its value will be used as the routing key
  ##  and override routing_key config even if defined
  routing_tag = "host"
  ## Delivery Mode controls if a published message is persistent
  ## Valid options are "transient" and "persistent". default: "transient"
  # delivery_mode = "transient"

  ## InfluxDB retention policy
  # retention_policy = "default"
  ## InfluxDB database
  # database = "telegraf"

  ## Write timeout, formatted as a string.  If not provided, will default
  ## to 5s. 0s means no timeout (not recommended).
  # timeout = "5s"

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

  ## Data format to output.
  ## 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_OUTPUT.md
  data_format = "influx"