--- title: Telegraf Documentation description: Telegraf plugin for collecting metrics from RabbitMQ url: https://docs.influxdata.com/telegraf/v1/input-plugins/rabbitmq/ estimated_tokens: 3768 product: Telegraf version: v1 --- - Telegraf v0.1.5+ # RabbitMQ Input Plugin This plugin gathers statistics from [RabbitMQ](https://www.rabbitmq.com) servers via the [Management Plugin](https://www.rabbitmq.com/management.html). **Introduced in:** Telegraf v0.1.5 **Tags:** server **OS support:** all ## 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](/telegraf/v1/configuration/#plugins) for more details. ## Secret-store support This plugin supports secrets from secret-stores for the `username` and `password` option. See the [secret-store documentation](/telegraf/v1/configuration/#secret-store-secrets) for more details on how to use them. ## Configuration ```toml # Reads metrics from RabbitMQ servers via the Management Plugin [[inputs.rabbitmq]] ## Management Plugin url. (default: http://localhost:15672) # url = "http://localhost:15672" ## Credentials # username = "guest" # password = "guest" ## 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 ## Optional request timeouts ## ## ResponseHeaderTimeout, if non-zero, specifies the amount of time to wait ## for a server's response headers after fully writing the request. # header_timeout = "3s" ## ## client_timeout specifies a time limit for requests made by this client. ## Includes connection time, any redirects, and reading the response body. # client_timeout = "4s" ## A list of nodes to gather as the rabbitmq_node measurement. If not ## specified, metrics for all nodes are gathered. # nodes = ["rabbit@node1", "rabbit@node2"] ## A list of exchanges to gather as the rabbitmq_exchange measurement. If not ## specified, metrics for all exchanges are gathered. # exchanges = ["telegraf"] ## Metrics to include and exclude. Globs accepted. ## Note that an empty array for both will include all metrics ## Currently the following metrics are supported: "exchange", "federation", "node", "overview", "queue" # metric_include = [] # metric_exclude = [] ## Queues to include and exclude. Globs accepted. ## Note that an empty array for both will include all queues # queue_name_include = [] # queue_name_exclude = [] ## Federation upstreams to include and exclude specified as an array of glob ## pattern strings. Federation links can also be limited by the queue and ## exchange filters. # federation_upstream_include = [] # federation_upstream_exclude = [] ## Include queue type as a tag. When enabled, adds a "type" tag to queue metrics ## with the queue type returned by RabbitMQ (e.g., "classic", "quorum", "stream"). ## Defaults to "classic" if empty. # include_queue_type_tag = false ``` ## Metrics - rabbitmq\_overview - tags: - url - name - fields: - channels (int, channels) - connections (int, connections) - consumers (int, consumers) - exchanges (int, exchanges) - messages (int, messages) - messages\_acked (int, messages) - messages\_delivered (int, messages) - messages\_delivered\_get (int, messages) - messages\_published (int, messages) - messages\_ready (int, messages) - messages\_unacked (int, messages) - queues (int, queues) - clustering\_listeners (int, cluster nodes) - amqp\_listeners (int, amqp nodes up) - return\_unroutable (int, number of unroutable messages) - return\_unroutable\_rate (float, number of unroutable messages per second) - rabbitmq\_node - tags: - url - node - url - fields: - disk\_free (int, bytes) - disk\_free\_limit (int, bytes) - disk\_free\_alarm (int, disk alarm) - fd\_total (int, file descriptors) - fd\_used (int, file descriptors) - mem\_limit (int, bytes) - mem\_used (int, bytes) - mem\_alarm (int, memory a) - proc\_total (int, erlang processes) - proc\_used (int, erlang processes) - run\_queue (int, erlang processes) - sockets\_total (int, sockets) - sockets\_used (int, sockets) - running (int, node up) - uptime (int, milliseconds) - mnesia\_disk\_tx\_count (int, number of disk transaction) - mnesia\_ram\_tx\_count (int, number of ram transaction) - mnesia\_disk\_tx\_count\_rate (float, number of disk transaction per second) - mnesia\_ram\_tx\_count\_rate (float, number of ram transaction per second) - gc\_num (int, number of garbage collection) - gc\_bytes\_reclaimed (int, bytes) - gc\_num\_rate (float, number of garbage collection per second) - gc\_bytes\_reclaimed\_rate (float, bytes per second) - io\_read\_avg\_time (float, number of read operations) - io\_read\_avg\_time\_rate (int, number of read operations per second) - io\_read\_bytes (int, bytes) - io\_read\_bytes\_rate (float, bytes per second) - io\_write\_avg\_time (int, milliseconds) - io\_write\_avg\_time\_rate (float, milliseconds per second) - io\_write\_bytes (int, bytes) - io\_write\_bytes\_rate (float, bytes per second) - mem\_connection\_readers (int, bytes) - mem\_connection\_writers (int, bytes) - mem\_connection\_channels (int, bytes) - mem\_connection\_other (int, bytes) - mem\_queue\_procs (int, bytes) - mem\_queue\_slave\_procs (int, bytes) - mem\_plugins (int, bytes) - mem\_other\_proc (int, bytes) - mem\_metrics (int, bytes) - mem\_mgmt\_db (int, bytes) - mem\_mnesia (int, bytes) - mem\_other\_ets (int, bytes) - mem\_binary (int, bytes) - mem\_msg\_index (int, bytes) - mem\_code (int, bytes) - mem\_atom (int, bytes) - mem\_other\_system (int, bytes) - mem\_allocated\_unused (int, bytes) - mem\_reserved\_unallocated (int, bytes) - mem\_total (int, bytes) - rabbitmq\_queue - tags: - url - queue - vhost - node - durable - auto\_delete - type (queue type as returned by RabbitMQ, if empty it defaults to “classic”; only included when include\_queue\_type\_tag = true) - fields: - consumer\_utilisation (float, percent) - consumers (int, int) - idle\_since (string, time - e.g., “2006-01-02 15:04:05”) - head\_message\_timestamp (int, unix timestamp - only emitted if available) - memory (int, bytes) - message\_bytes (int, bytes) - message\_bytes\_persist (int, bytes) - message\_bytes\_ram (int, bytes) - message\_bytes\_ready (int, bytes) - message\_bytes\_unacked (int, bytes) - messages (int, count) - messages\_ack (int, count) - messages\_ack\_rate (float, messages per second) - messages\_deliver (int, count) - messages\_deliver\_rate (float, messages per second) - messages\_deliver\_get (int, count) - messages\_deliver\_get\_rate (float, messages per second) - messages\_publish (int, count) - messages\_publish\_rate (float, messages per second) - messages\_ready (int, count) - messages\_redeliver (int, count) - messages\_redeliver\_rate (float, messages per second) - messages\_unack (int, count) - slave\_nodes (int, count) - synchronised\_slave\_nodes (int, count) - rabbitmq\_exchange - tags: - url - exchange - type - vhost - internal - durable - auto\_delete - fields: - messages\_publish\_in (int, count) - messages\_publish\_in\_rate (int, messages per second) - messages\_publish\_out (int, count) - messages\_publish\_out\_rate (int, messages per second) - rabbitmq\_federation - tags: - url - vhost - type - upstream - exchange - upstream\_exchange - queue - upstream\_queue - fields: - acks\_uncommitted (int, count) - consumers (int, count) - messages\_unacknowledged (int, count) - messages\_uncommitted (int, count) - messages\_unconfirmed (int, count) - messages\_confirm (int, count) - messages\_publish (int, count) - messages\_return\_unroutable (int, count) ## Example Output ```text rabbitmq_queue,url=http://amqp.example.org:15672,queue=telegraf,vhost=influxdb,node=rabbit@amqp.example.org,durable=true,auto_delete=false,type=classic,host=amqp.example.org head_message_timestamp=1493684017,messages_deliver_get=0i,messages_publish=329i,messages_publish_rate=0.2,messages_redeliver_rate=0,message_bytes_ready=0i,message_bytes_unacked=0i,messages_deliver=329i,messages_unack=0i,consumers=1i,idle_since="",messages=0i,messages_deliver_rate=0.2,messages_deliver_get_rate=0.2,messages_redeliver=0i,memory=43032i,message_bytes_ram=0i,messages_ack=329i,messages_ready=0i,messages_ack_rate=0.2,consumer_utilisation=1,message_bytes=0i,message_bytes_persist=0i 1493684035000000000 rabbitmq_overview,url=http://amqp.example.org:15672,host=amqp.example.org channels=2i,consumers=1i,exchanges=17i,messages_acked=329i,messages=0i,messages_ready=0i,messages_unacked=0i,connections=2i,queues=1i,messages_delivered=329i,messages_published=329i,clustering_listeners=2i,amqp_listeners=1i 1493684035000000000 rabbitmq_node,url=http://amqp.example.org:15672,node=rabbit@amqp.example.org,host=amqp.example.org fd_total=1024i,fd_used=32i,mem_limit=8363329126i,sockets_total=829i,disk_free=8175935488i,disk_free_limit=50000000i,mem_used=58771080i,proc_total=1048576i,proc_used=267i,run_queue=0i,sockets_used=2i,running=1i 149368403500000000 rabbitmq_exchange,url=http://amqp.example.org:15672,exchange=telegraf,type=fanout,vhost=influxdb,internal=false,durable=true,auto_delete=false,host=amqp.example.org messages_publish_in=2i,messages_publish_out=1i 149368403500000000 ``` #### Related - [Configure plugins](/telegraf/v1/configure_plugins/) - [RabbitMQ Plugin Source](https://github.com/influxdata/telegraf/tree/v1.38.4/plugins/inputs/rabbitmq/README.md)