dom
/
telegraf
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update rabbitmq input readme

This commit is contained in:
Daniel Nelson 2019-10-23 17:26:31 -07:00
parent 8b3a8d1113
commit 3770923ce3
No known key found for this signature in database
GPG Key ID: CAAD59C9444F6155
2 changed files with 159 additions and 162 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

305
plugins/inputs/rabbitmq/README.md
View File

@ -7,7 +7,7 @@ For additional details reference the [RabbitMQ Management HTTP Stats][management
[management]: https://www.rabbitmq.com/management.html [management]: https://www.rabbitmq.com/management.html
[management-reference]: https://raw.githack.com/rabbitmq/rabbitmq-management/rabbitmq_v3_6_9/priv/www/api/index.html [management-reference]: https://raw.githack.com/rabbitmq/rabbitmq-management/rabbitmq_v3_6_9/priv/www/api/index.html
### Configuration: ### Configuration
```toml ```toml
[[inputs.rabbitmq]] [[inputs.rabbitmq]]
@ -48,180 +48,177 @@ For additional details reference the [RabbitMQ Management HTTP Stats][management
## specified, metrics for all exchanges are gathered. ## specified, metrics for all exchanges are gathered.
# exchanges = ["telegraf"] # exchanges = ["telegraf"]
## A list of federation upstreams to gather as the rabbitmq_federation measurement.
## If not specified, metrics for all federation upstreams are gathered.
## Federation link metrics will only be gathered for queues and exchanges
## whose non-federation metrics will be collected (e.g a queue excluded
## by the 'queue_name_exclude' option will also be excluded from federation).
# federation_upstreams = ["dataCentre2"]
## Queues to include and exclude. Globs accepted. ## Queues to include and exclude. Globs accepted.
## Note that an empty array for both will include all queues ## Note that an empty array for both will include all queues
# queue_name_include = [] # queue_name_include = []
# queue_name_exclude = [] # queue_name_exclude = []
## Federation upstreams to include and exlude 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 = []
``` ```
### Measurements & Fields: ### Metrics
- rabbitmq_overview - rabbitmq_overview
- channels (int, channels) - tags:
- connections (int, connections) - url
- consumers (int, consumers) - name
- exchanges (int, exchanges) - fields:
- messages (int, messages) - channels (int, channels)
- messages_acked (int, messages) - connections (int, connections)
- messages_delivered (int, messages) - consumers (int, consumers)
- messages_delivered_get (int, messages) - exchanges (int, exchanges)
- messages_published (int, messages) - messages (int, messages)
- messages_ready (int, messages) - messages_acked (int, messages)
- messages_unacked (int, messages) - messages_delivered (int, messages)
- queues (int, queues) - messages_delivered_get (int, messages)
- clustering_listeners (int, cluster nodes) - messages_published (int, messages)
- amqp_listeners (int, amqp nodes up) - messages_ready (int, messages)
- return_unroutable (int, number of unroutable messages) - messages_unacked (int, messages)
- return_unroutable_rate (float, number of unroutable messages per second) - 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 + rabbitmq_node
- disk_free (int, bytes) - tags:
- disk_free_limit (int, bytes) - url
- disk_free_alarm (int, disk alarm) - node
- fd_total (int, file descriptors) - url
- fd_used (int, file descriptors) - fields:
- mem_limit (int, bytes) - disk_free (int, bytes)
- mem_used (int, bytes) - disk_free_limit (int, bytes)
- mem_alarm (int, memory a) - disk_free_alarm (int, disk alarm)
- proc_total (int, erlang processes) - fd_total (int, file descriptors)
- proc_used (int, erlang processes) - fd_used (int, file descriptors)
- run_queue (int, erlang processes) - mem_limit (int, bytes)
- sockets_total (int, sockets) - mem_used (int, bytes)
- sockets_used (int, sockets) - mem_alarm (int, memory a)
- running (int, node up) - proc_total (int, erlang processes)
- uptime (int, milliseconds) - proc_used (int, erlang processes)
- health_check_status (int, 1 or 0) - run_queue (int, erlang processes)
- mnesia_disk_tx_count (int, number of disk transaction) - sockets_total (int, sockets)
- mnesia_ram_tx_count (int, number of ram transaction) - sockets_used (int, sockets)
- mnesia_disk_tx_count_rate (float, number of disk transaction per second) - running (int, node up)
- mnesia_ram_tx_count_rate (float, number of ram transaction per second) - uptime (int, milliseconds)
- gc_num (int, number of garbage collection) - health_check_status (int, 1 or 0)
- gc_bytes_reclaimed (int, bytes) - mnesia_disk_tx_count (int, number of disk transaction)
- gc_num_rate (float, number of garbage collection per second) - mnesia_ram_tx_count (int, number of ram transaction)
- gc_bytes_reclaimed_rate (float, bytes per second) - mnesia_disk_tx_count_rate (float, number of disk transaction per second)
- io_read_avg_time (float, number of read operations) - mnesia_ram_tx_count_rate (float, number of ram transaction per second)
- io_read_avg_time_rate (int, number of read operations per second) - gc_num (int, number of garbage collection)
- io_read_bytes (int, bytes) - gc_bytes_reclaimed (int, bytes)
- io_read_bytes_rate (float, bytes per second) - gc_num_rate (float, number of garbage collection per second)
- io_write_avg_time (int, milliseconds) - gc_bytes_reclaimed_rate (float, bytes per second)
- io_write_avg_time_rate (float, milliseconds per second) - io_read_avg_time (float, number of read operations)
- io_write_bytes (int, bytes) - io_read_avg_time_rate (int, number of read operations per second)
- io_write_bytes_rate (float, bytes per second) - io_read_bytes (int, bytes)
- mem_connection_readers (int, bytes) - io_read_bytes_rate (float, bytes per second)
- mem_connection_writers (int, bytes) - io_write_avg_time (int, milliseconds)
- mem_connection_channels (int, bytes) - io_write_avg_time_rate (float, milliseconds per second)
- mem_connection_other (int, bytes) - io_write_bytes (int, bytes)
- mem_queue_procs (int, bytes) - io_write_bytes_rate (float, bytes per second)
- mem_queue_slave_procs (int, bytes) - mem_connection_readers (int, bytes)
- mem_plugins (int, bytes) - mem_connection_writers (int, bytes)
- mem_other_proc (int, bytes) - mem_connection_channels (int, bytes)
- mem_metrics (int, bytes) - mem_connection_other (int, bytes)
- mem_mgmt_db (int, bytes) - mem_queue_procs (int, bytes)
- mem_mnesia (int, bytes) - mem_queue_slave_procs (int, bytes)
- mem_other_ets (int, bytes) - mem_plugins (int, bytes)
- mem_binary (int, bytes) - mem_other_proc (int, bytes)
- mem_msg_index (int, bytes) - mem_metrics (int, bytes)
- mem_code (int, bytes) - mem_mgmt_db (int, bytes)
- mem_atom (int, bytes) - mem_mnesia (int, bytes)
- mem_other_system (int, bytes) - mem_other_ets (int, bytes)
- mem_allocated_unused (int, bytes) - mem_binary (int, bytes)
- mem_reserved_unallocated (int, bytes) - mem_msg_index (int, bytes)
- mem_total (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 - rabbitmq_queue
- consumer_utilisation (float, percent) - tags:
- consumers (int, int) - url
- idle_since (string, time - e.g., "2006-01-02 15:04:05") - queue
- memory (int, bytes) - vhost
- message_bytes (int, bytes) - node
- message_bytes_persist (int, bytes) - durable
- message_bytes_ram (int, bytes) - auto_delete
- message_bytes_ready (int, bytes) - fields:
- message_bytes_unacked (int, bytes) - consumer_utilisation (float, percent)
- messages (int, count) - consumers (int, int)
- messages_ack (int, count) - idle_since (string, time - e.g., "2006-01-02 15:04:05")
- messages_ack_rate (float, messages per second) - memory (int, bytes)
- messages_deliver (int, count) - message_bytes (int, bytes)
- messages_deliver_rate (float, messages per second) - message_bytes_persist (int, bytes)
- messages_deliver_get (int, count) - message_bytes_ram (int, bytes)
- messages_deliver_get_rate (float, messages per second) - message_bytes_ready (int, bytes)
- messages_publish (int, count) - message_bytes_unacked (int, bytes)
- messages_publish_rate (float, messages per second) - messages (int, count)
- messages_ready (int, count) - messages_ack (int, count)
- messages_redeliver (int, count) - messages_ack_rate (float, messages per second)
- messages_redeliver_rate (float, messages per second) - messages_deliver (int, count)
- messages_unack (integer, 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 (integer, count)
- rabbitmq_exchange + rabbitmq_exchange
- messages_publish_in (int, count) - tags:
- messages_publish_in_rate (int, messages per second) - url
- messages_publish_out (int, count) - exchange
- messages_publish_out_rate (int, messages per second) - 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 - rabbitmq_federation
- acks_uncommitted (int, count) - tags:
- consumers (int, count) - url
- messages_unacknowledged (int, count) - vhost
- messages_uncommitted (int, count) - type
- messages_unconfirmed (int, count) - upstream
- messages_confirm (int, count) - exchange
- messages_publish (int, count) - upstream_exchange
- messages_return_unroutable (int, count) - 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)
### Tags: ### Sample Queries
- All measurements have the following tags:
- url
- rabbitmq_overview
- name
- rabbitmq_node
- node
- url
- rabbitmq_queue
- url
- queue
- vhost
- node
- durable
- auto_delete
- rabbitmq_exchange
- url
- exchange
- type
- vhost
- internal
- durable
- auto_delete
- rabbitmq_federation
- url
- vhost
- type
- upstream
- local_entity
- upstream_entity
### Sample Queries:
Message rates for the entire node can be calculated from total message counts. For instance, to get the rate of messages published per minute, use this query: Message rates for the entire node can be calculated from total message counts. For instance, to get the rate of messages published per minute, use this query:
``` ```
SELECT NON_NEGATIVE_DERIVATIVE(LAST("messages_published"), 1m) AS messages_published_rate SELECT NON_NEGATIVE_DERIVATIVE(LAST("messages_published"), 1m) AS messages_published_rate FROM rabbitmq_overview WHERE time > now() - 10m GROUP BY time(1m)
FROM rabbitmq_overview WHERE time > now() - 10m GROUP BY time(1m)
``` ```
### Example Output: ### Example Output
``` ```
rabbitmq_queue,url=http://amqp.example.org:15672,queue=telegraf,vhost=influxdb,node=rabbit@amqp.example.org,durable=true,auto_delete=false,host=amqp.example.org 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_queue,url=http://amqp.example.org:15672,queue=telegraf,vhost=influxdb,node=rabbit@amqp.example.org,durable=true,auto_delete=false,host=amqp.example.org 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

16
plugins/inputs/rabbitmq/rabbitmq.go
View File

@ -34,25 +34,25 @@ const DefaultClientTimeout = 4
// RabbitMQ defines the configuration necessary for gathering metrics, // RabbitMQ defines the configuration necessary for gathering metrics,
// see the sample config for further details // see the sample config for further details
type RabbitMQ struct { type RabbitMQ struct {
URL string URL string `toml:"url"`
Name string Name string `toml:"name"`
Username string Username string `toml:"username"`
Password string Password string `toml:"password"`
tls.ClientConfig tls.ClientConfig
ResponseHeaderTimeout internal.Duration `toml:"header_timeout"` ResponseHeaderTimeout internal.Duration `toml:"header_timeout"`
ClientTimeout internal.Duration `toml:"client_timeout"` ClientTimeout internal.Duration `toml:"client_timeout"`
Nodes []string Nodes []string `toml:"nodes"`
Queues []string Queues []string `toml:"queues"`
Exchanges []string Exchanges []string `toml:"exchanges"`
QueueInclude []string `toml:"queue_name_include"` QueueInclude []string `toml:"queue_name_include"`
QueueExclude []string `toml:"queue_name_exclude"` QueueExclude []string `toml:"queue_name_exclude"`
FederationUpstreamInclude []string `toml:"federation_upstream_include"` FederationUpstreamInclude []string `toml:"federation_upstream_include"`
FederationUpstreamExclude []string `toml:"federation_upstream_exclude"` FederationUpstreamExclude []string `toml:"federation_upstream_exclude"`
Client *http.Client Client *http.Client `toml:"-"`
filterCreated bool filterCreated bool
excludeEveryQueue bool excludeEveryQueue bool