RabbitMQ message queue monitoring API
Request address http://ip Port number/interface name
It is recommended that the monitoring data collection interval be 60 seconds.
HTTP API URL |
HTTP request type |
Interface Meaning |
/api/connections |
GET |
Get all open connections under the current RabbitMQ cluster |
/api/nodes |
GET |
Get the status information of all node instances in the current RabbitMQ cluster |
/api/vhosts/{vhost}/connections |
GET |
Get all open connection connections under a virtual machine host |
/api/connections/{name}/channels |
GET |
Get all pipeline information under a connection |
/api/vhosts/{vhost}/channels |
GET |
Getting Pipeline Information under a Virtual Machine Host |
/api/consumers/{vhost} |
GET |
Get all consumer information under a virtual machine host |
/api/exchanges/{vhost} |
GET |
Get all switch information under a virtual machine host |
/api/queues/{vhost} |
GET |
Get all queue information under a virtual machine host |
/api/users |
GET |
Get all user information in the cluster |
/api/users/{name} |
GET/PUT/DELETE |
Get/update/delete specified user information |
/api/users/{user}/permissions |
GET |
Get all permission information for the current specified user |
/api/permissions/{vhost}/{user} |
GET/PUT/DELETE |
Gets/updates/deletes the permissions of a specific user under a specified virtual host |
/api/exchanges/{vhost}/{name}/publish |
POST |
Publish a message on the specified virtual machine host and switch |
/api/queues/{vhost}/{name}/get |
POST |
Get the message in the specified virtual machine host and queue name, and the action will modify the queue status test |
/api/healthchecks/node/{node} |
GET |
Gets the health check status of the specified node |
/api/nodes/{node}/memory |
GET |
Gets memory usage information for the specified node |
Some API examples
/ api/overview returns cluster metrics
Field name |
Significance |
cluster_name |
Cluster name |
management_version |
Edition |
message_stats |
message rate |
object_totals.connections |
Total number of connections |
object_totals.channels |
Total number of channels |
object_totals.queues |
Number of queues |
object_totals.consumers |
Total number of consumers |
queue_totals.messages |
Total number of ready and unacknowledged messages |
queue_totals.messages_ready |
Number of messages ready to be sent |
queue_totals.messages_unacknowledged |
Number of unacknowledged messages |
message_stats.publish` |
Recent news |
message_stats.publish_details.rate |
Message Release Rate |
message_stats.deliver_get |
Recent messages to consumers |
message_stats.deliver_get.rate |
Mail delivery rate |
message_stats |
Other news statistics |
{
"management_version": "3.7.14",
"rates_mode": "basic",
"sample_retention_policies": {
"global": [
600,
3600,
28800,
86400
],
"basic": [
600,
3600
],
"detailed": [
600
]
},
"exchange_types": [
{
"name": "fanout",
"description": "AMQP fanout exchange, as per the AMQP specification",
"enabled": true
},
{
"name": "headers",
"description": "AMQP headers exchange, as per the AMQP specification",
"enabled": true
},
{
"name": "x-delayed-message",
"description": "Delayed Message Exchange.",
"enabled": true
},
{
"name": "direct",
"description": "AMQP direct exchange, as per the AMQP specification",
"enabled": true
},
{
"name": "topic",
"description": "AMQP topic exchange, as per the AMQP specification",
"enabled": true
}
],
"rabbitmq_version": "3.7.14",
"cluster_name": "rabbit@wangtaodeMacBook-Pro",
"erlang_version": "21.3.2",
"erlang_full_version": "Erlang/OTP 21 [erts-10.3.1] [source]
[64-bit] [smp:12:12] [ds:12:12:10] [async-threads:192]
[hipe] [dtrace]",
"message_stats": {
"disk_reads": 2,
"disk_reads_details": {
"rate": 0
},
"disk_writes": 0,
"disk_writes_details": {
"rate": 0
}
},
"churn_rates": {
"channel_closed": 0,
"channel_closed_details": {
"rate": 0
},
"channel_created": 0,
"channel_created_details": {
"rate": 0
},
"connection_closed": 0,
"connection_closed_details": {
"rate": 0
},
"connection_created": 0,
"connection_created_details": {
"rate": 0
},
"queue_created": 0,
"queue_created_details": {
"rate": 0
},
"queue_declared": 0,
"queue_declared_details": {
"rate": 0
},
"queue_deleted": 0,
"queue_deleted_details": {
"rate": 0
}
},
"queue_totals": {
"messages": 2,
"messages_details": {
"rate": 0
},
"messages_ready": 2,
"messages_ready_details": {
"rate": 0
},
"messages_unacknowledged": 0,
"messages_unacknowledged_details": {
"rate": 0
}
},
"object_totals": {
"channels": 0,
"connections": 0,
"consumers": 0,
"exchanges": 16,
"queues": 10
},
"statistics_db_event_queue": 0,
"node": "rabbit@localhost",
"listeners": [
{
"node": "rabbit@localhost",
"protocol": "amqp",
"ip_address": "127.0.0.1",
"port": 5672,
"socket_opts": {
"backlog": 128,
"nodelay": true,
"linger": [
true,
0
],
"exit_on_close": false
}
},
{
"node": "rabbit@localhost",
"protocol": "clustering",
"ip_address": "::",
"port": 25672,
"socket_opts": []
},
{
"node": "rabbit@localhost",
"protocol": "http",
"ip_address": "::",
"port": 15672,
"socket_opts": {
"port": 15672
}
},
{
"node": "rabbit@localhost",
"protocol": "mqtt",
"ip_address": "::",
"port": 1883,
"socket_opts": {
"backlog": 128,
"nodelay": true
}
},
{
"node": "rabbit@localhost",
"protocol": "stomp",
"ip_address": "::",
"port": 61613,
"socket_opts": {
"backlog": 128,
"nodelay": true
}
}
],
"contexts": [
{
"ssl_opts": [],
"node": "rabbit@localhost",
"description": "RabbitMQ Management",
"path": "/",
"port": "15672"
}
]
}
/ api/nodes returns all cluster member statistics messages
Field name |
Significance |
mem_used |
Total memory used |
mem_limit |
Memory utilization |
mem_alarm |
Memory Alarm Switch |
disk_free_limit |
Disk space limit size |
disk_free_alarm |
Disk Space Limit Switch |
fd_total |
File descriptor limits |
fd_used |
Does the file descriptor start? |
io_file_handle_open_attempt_count |
io file handle open attempt counting |
sockets_total |
Number of socket s |
sockets_used |
Number of socket s in use |
message_stats.disk_reads |
Number of messages read by disk |
message_stats.disk_writes |
Number of messages written to disk |
cluster_links |
Inter-node communication link |
gc_num |
GC Number |
gc_bytes_reclaimed |
The number of bytes recovered by GC |
proc_total |
Erlang process limit number |
proc_used |
Number of Erlang usage |
run_queue |
Runtime queue number |
[
{
"partitions": [],
"os_pid": "4470",
"fd_total": 256,
"sockets_total": 138,
"mem_limit": 6871947673,
"mem_alarm": false,
"disk_free_limit": 50000000,
"disk_free_alarm": false,
"proc_total": 1048576,
"rates_mode": "basic",
"uptime": 4176419,
"run_queue": 1,
"processors": 12,
"exchange_types": [
{
"name": "fanout",
"description": "AMQP fanout exchange, as per the AMQP specification",
"enabled": true
},
{
"name": "headers",
"description": "AMQP headers exchange, as per the AMQP specification",
"enabled": true
},
{
"name": "x-delayed-message",
"description": "Delayed Message Exchange.",
"enabled": true
},
{
"name": "direct",
"description": "AMQP direct exchange, as per the AMQP specification",
"enabled": true
},
{
"name": "topic",
"description": "AMQP topic exchange, as per the AMQP specification",
"enabled": true
}
],
"auth_mechanisms": [
{
"name": "RABBIT-CR-DEMO",
"description": "RabbitMQ Demo challenge-response authentication mechanism",
"enabled": false
},
{
"name": "AMQPLAIN",
"description": "QPid AMQPLAIN mechanism",
"enabled": true
},
{
"name": "PLAIN",
"description": "SASL PLAIN authentication mechanism",
"enabled": true
}
],
"applications": [
{
"name": "amqp10_common",
"description": "Modules shared by rabbitmq-amqp1.0
and rabbitmq-amqp1.0-client",
"version": "3.7.14"
},
{
"name": "amqp_client",
"description": "RabbitMQ AMQP Client",
"version": "3.7.14"
},
{
"name": "asn1",
"description": "The Erlang ASN1 compiler version 5.0.8",
"version": "5.0.8"
},
{
"name": "compiler",
"description": "ERTS CXC 138 10",
"version": "7.3.2"
},
{
"name": "cowboy",
"description": "Small, fast, modern HTTP server.",
"version": "2.6.1"
},
{
"name": "cowlib",
"description": "Support library for manipulating Web protocols.",
"version": "2.7.0"
},
{
"name": "crypto",
"description": "CRYPTO",
"version": "4.4.1"
},
{
"name": "goldrush",
"description": "Erlang event stream processor",
"version": "0.1.9"
},
{
"name": "inets",
"description": "INETS CXC 138 49",
"version": "7.0.6"
},
{
"name": "jsx",
"description": "a streaming, evented json parsing toolkit",
"version": "2.9.0"
},
{
"name": "kernel",
"description": "ERTS CXC 138 10",
"version": "6.3"
},
{
"name": "lager",
"description": "Erlang logging framework",
"version": "3.6.9"
},
{
"name": "mnesia",
"description": "MNESIA CXC 138 12",
"version": "4.15.6"
},
{
"name": "os_mon",
"description": "CPO CXC 138 46",
"version": "2.4.7"
},
{
"name": "public_key",
"description": "Public key infrastructure",
"version": "1.6.5"
},
{
"name": "rabbit",
"description": "RabbitMQ",
"version": "3.7.14"
},
{
"name": "rabbit_common",
"description": "Modules shared by rabbitmq-server
and rabbitmq-erlang-client",
"version": "3.7.14"
},
{
"name": "rabbitmq_amqp1_0",
"description": "AMQP 1.0 support for RabbitMQ",
"version": "3.7.14"
},
{
"name": "rabbitmq_delayed_message_exchange",
"description": "RabbitMQ Delayed Message Exchange",
"version": "20171201-3.7.x"
},
{
"name": "rabbitmq_management",
"description": "RabbitMQ Management Console",
"version": "3.7.14"
},
{
"name": "rabbitmq_management_agent",
"description": "RabbitMQ Management Agent",
"version": "3.7.14"
},
{
"name": "rabbitmq_mqtt",
"description": "RabbitMQ MQTT Adapter",
"version": "3.7.14"
},
{
"name": "rabbitmq_stomp",
"description": "RabbitMQ STOMP plugin",
"version": "3.7.14"
},
{
"name": "rabbitmq_web_dispatch",
"description": "RabbitMQ Web Dispatcher",
"version": "3.7.14"
},
{
"name": "ranch",
"description": "Socket acceptor pool for TCP protocols.",
"version": "1.7.1"
},
{
"name": "recon",
"description": "Diagnostic tools for production use",
"version": "2.4.0"
},
{
"name": "sasl",
"description": "SASL CXC 138 11",
"version": "3.3"
},
{
"name": "ssl",
"description": "Erlang/OTP SSL application",
"version": "9.2.1"
},
{
"name": "stdlib",
"description": "ERTS CXC 138 10",
"version": "3.8"
},
{
"name": "syntax_tools",
"description": "Syntax tools",
"version": "2.1.7"
},
{
"name": "sysmon_handler",
"description": "Rate-limiting system_monitor event handler",
"version": "1.1.0"
},
{
"name": "xmerl",
"description": "XML parser",
"version": "1.3.20"
}
],
"contexts": [
{
"description": "RabbitMQ Management",
"path": "/",
"port": "15672"
}
],
"log_files": [
"/usr/local/var/log/rabbitmq/rabbit@localhost.log",
"/usr/local/var/log/rabbitmq/rabbit@localhost_upgrade.log"
],
"db_dir": "/usr/local/var/lib/rabbitmq/mnesia/rabbit@localhost",
"config_files": [],
"net_ticktime": 60,
"enabled_plugins": [
"rabbitmq_amqp1_0",
"rabbitmq_delayed_message_exchange",
"rabbitmq_management",
"rabbitmq_mqtt",
"rabbitmq_stomp"
],
"mem_calculation_strategy": "rss",
"name": "rabbit@localhost",
"type": "disc",
"running": true,
"mem_used": 86556672,
"mem_used_details": {
"rate": 4096
},
"fd_used": 72,
"fd_used_details": {
"rate": -0.4
},
"sockets_used": 0,
"sockets_used_details": {
"rate": 0
},
"proc_used": 457,
"proc_used_details": {
"rate": 0
},
"disk_free": 172579655680,
"disk_free_details": {
"rate": -15564.8
},
"gc_num": 22686,
"gc_num_details": {
"rate": 4.6
},
"gc_bytes_reclaimed": 1060411720,
"gc_bytes_reclaimed_details": {
"rate": 158604.8
},
"context_switches": 307064,
"context_switches_details": {
"rate": 37.4
},
"io_read_count": 22,
"io_read_count_details": {
"rate": 0
},
"io_read_bytes": 2083,
"io_read_bytes_details": {
"rate": 0
},
"io_read_avg_time": 0.02909090909090909,
"io_read_avg_time_details": {
"rate": 0
},
"io_write_count": 0,
"io_write_count_details": {
"rate": 0
},
"io_write_bytes": 0,
"io_write_bytes_details": {
"rate": 0
},
"io_write_avg_time": 0,
"io_write_avg_time_details": {
"rate": 0
},
"io_sync_count": 0,
"io_sync_count_details": {
"rate": 0
},
"io_sync_avg_time": 0,
"io_sync_avg_time_details": {
"rate": 0
},
"io_seek_count": 0,
"io_seek_count_details": {
"rate": 0
},
"io_seek_avg_time": 0,
"io_seek_avg_time_details": {
"rate": 0
},
"io_reopen_count": 0,
"io_reopen_count_details": {
"rate": 0
},
"mnesia_ram_tx_count": 60,
"mnesia_ram_tx_count_details": {
"rate": 0
},
"mnesia_disk_tx_count": 10,
"mnesia_disk_tx_count_details": {
"rate": 0
},
"msg_store_read_count": 0,
"msg_store_read_count_details": {
"rate": 0
},
"msg_store_write_count": 0,
"msg_store_write_count_details": {
"rate": 0
},
"queue_index_journal_write_count": 0,
"queue_index_journal_write_count_details": {
"rate": 0
},
"queue_index_write_count": 0,
"queue_index_write_count_details": {
"rate": 0
},
"queue_index_read_count": 3,
"queue_index_read_count_details": {
"rate": 0
},
"io_file_handle_open_attempt_count": 73,
"io_file_handle_open_attempt_count_details": {
"rate": 0
},
"io_file_handle_open_attempt_avg_time": 0.031643835616438354,
"io_file_handle_open_attempt_avg_time_details": {
"rate": 0
},
"connection_created": 0,
"connection_created_details": {
"rate": 0
},
"connection_closed": 0,
"connection_closed_details": {
"rate": 0
},
"channel_created": 0,
"channel_created_details": {
"rate": 0
},
"channel_closed": 0,
"channel_closed_details": {
"rate": 0
},
"queue_declared": 0,
"queue_declared_details": {
"rate": 0
},
"queue_created": 0,
"queue_created_details": {
"rate": 0
},
"queue_deleted": 0,
"queue_deleted_details": {
"rate": 0
},
"cluster_links": [],
"metrics_gc_queue_length": {
"connection_closed": 0,
"channel_closed": 0,
"consumer_deleted": 0,
"exchange_deleted": 0,
"queue_deleted": 0,
"vhost_deleted": 0,
"node_node_deleted": 0,
"channel_consumer_deleted": 0
}
}
]
/ api/nodes/{node name} returns statistics for a single node
{
"partitions": [],
"os_pid": "4470",
"fd_total": 256,
"sockets_total": 138,
"mem_limit": 6871947673,
"mem_alarm": false,
"disk_free_limit": 50000000,
"disk_free_alarm": false,
"proc_total": 1048576,
"rates_mode": "basic",
"uptime": 11728280,
"run_queue": 1,
"processors": 12,
"exchange_types": [
{
"name": "fanout",
"description": "AMQP fanout exchange, as per the AMQP specification",
"enabled": true
},
{
"name": "headers",
"description": "AMQP headers exchange, as per the AMQP specification",
"enabled": true
},
{
"name": "x-delayed-message",
"description": "Delayed Message Exchange.",
"enabled": true
},
{
"name": "direct",
"description": "AMQP direct exchange, as per the AMQP specification",
"enabled": true
},
{
"name": "topic",
"description": "AMQP topic exchange, as per the AMQP specification",
"enabled": true
}
],
"auth_mechanisms": [
{
"name": "RABBIT-CR-DEMO",
"description": "RabbitMQ Demo challenge-response authentication mechanism",
"enabled": false
},
{
"name": "AMQPLAIN",
"description": "QPid AMQPLAIN mechanism",
"enabled": true
},
{
"name": "PLAIN",
"description": "SASL PLAIN authentication mechanism",
"enabled": true
}
],
"applications": [
{
"name": "amqp10_common",
"description": "Modules shared by rabbitmq-amqp1.0 and rabbitmq-amqp1.0-client",
"version": "3.7.14"
},
{
"name": "amqp_client",
"description": "RabbitMQ AMQP Client",
"version": "3.7.14"
},
{
"name": "asn1",
"description": "The Erlang ASN1 compiler version 5.0.8",
"version": "5.0.8"
},
{
"name": "compiler",
"description": "ERTS CXC 138 10",
"version": "7.3.2"
},
{
"name": "cowboy",
"description": "Small, fast, modern HTTP server.",
"version": "2.6.1"
},
{
"name": "cowlib",
"description": "Support library for manipulating Web protocols.",
"version": "2.7.0"
},
{
"name": "crypto",
"description": "CRYPTO",
"version": "4.4.1"
},
{
"name": "goldrush",
"description": "Erlang event stream processor",
"version": "0.1.9"
},
{
"name": "inets",
"description": "INETS CXC 138 49",
"version": "7.0.6"
},
{
"name": "jsx",
"description": "a streaming, evented json parsing toolkit",
"version": "2.9.0"
},
{
"name": "kernel",
"description": "ERTS CXC 138 10",
"version": "6.3"
},
{
"name": "lager",
"description": "Erlang logging framework",
"version": "3.6.9"
},
{
"name": "mnesia",
"description": "MNESIA CXC 138 12",
"version": "4.15.6"
},
{
"name": "os_mon",
"description": "CPO CXC 138 46",
"version": "2.4.7"
},
{
"name": "public_key",
"description": "Public key infrastructure",
"version": "1.6.5"
},
{
"name": "rabbit",
"description": "RabbitMQ",
"version": "3.7.14"
},
{
"name": "rabbit_common",
"description": "Modules shared by rabbitmq-server and rabbitmq-erlang-client",
"version": "3.7.14"
},
{
"name": "rabbitmq_amqp1_0",
"description": "AMQP 1.0 support for RabbitMQ",
"version": "3.7.14"
},
{
"name": "rabbitmq_delayed_message_exchange",
"description": "RabbitMQ Delayed Message Exchange",
"version": "20171201-3.7.x"
},
{
"name": "rabbitmq_management",
"description": "RabbitMQ Management Console",
"version": "3.7.14"
},
{
"name": "rabbitmq_management_agent",
"description": "RabbitMQ Management Agent",
"version": "3.7.14"
},
{
"name": "rabbitmq_mqtt",
"description": "RabbitMQ MQTT Adapter",
"version": "3.7.14"
},
{
"name": "rabbitmq_stomp",
"description": "RabbitMQ STOMP plugin",
"version": "3.7.14"
},
{
"name": "rabbitmq_web_dispatch",
"description": "RabbitMQ Web Dispatcher",
"version": "3.7.14"
},
{
"name": "ranch",
"description": "Socket acceptor pool for TCP protocols.",
"version": "1.7.1"
},
{
"name": "recon",
"description": "Diagnostic tools for production use",
"version": "2.4.0"
},
{
"name": "sasl",
"description": "SASL CXC 138 11",
"version": "3.3"
},
{
"name": "ssl",
"description": "Erlang/OTP SSL application",
"version": "9.2.1"
},
{
"name": "stdlib",
"description": "ERTS CXC 138 10",
"version": "3.8"
},
{
"name": "syntax_tools",
"description": "Syntax tools",
"version": "2.1.7"
},
{
"name": "sysmon_handler",
"description": "Rate-limiting system_monitor event handler",
"version": "1.1.0"
},
{
"name": "xmerl",
"description": "XML parser",
"version": "1.3.20"
}
],
"contexts": [
{
"description": "RabbitMQ Management",
"path": "/",
"port": "15672"
}
],
"log_files": [
"/usr/local/var/log/rabbitmq/rabbit@localhost.log",
"/usr/local/var/log/rabbitmq/rabbit@localhost_upgrade.log"
],
"db_dir": "/usr/local/var/lib/rabbitmq/mnesia/rabbit@localhost",
"config_files": [],
"net_ticktime": 60,
"enabled_plugins": [
"rabbitmq_amqp1_0",
"rabbitmq_delayed_message_exchange",
"rabbitmq_management",
"rabbitmq_mqtt",
"rabbitmq_stomp"
],
"mem_calculation_strategy": "rss",
"name": "rabbit@localhost",
"running": true,
"type": "disc",
"mem_used": 86814720,
"mem_used_details": {
"rate": -117964.8
},
"fd_used": 72,
"fd_used_details": {
"rate": 0
},
"sockets_used": 0,
"sockets_used_details": {
"rate": 0
},
"proc_used": 457,
"proc_used_details": {
"rate": 0
},
"disk_free": 172549808128,
"disk_free_details": {
"rate": -31129.6
},
"gc_num": 38308,
"gc_num_details": {
"rate": 3.4
},
"gc_bytes_reclaimed": 1616503320,
"gc_bytes_reclaimed_details": {
"rate": 152201.6
},
"context_switches": 423307,
"context_switches_details": {
"rate": 37.6
},
"io_read_count": 22,
"io_read_count_details": {
"rate": 0
},
"io_read_bytes": 2083,
"io_read_bytes_details": {
"rate": 0
},
"io_read_avg_time": 0.02909090909090909,
"io_read_avg_time_details": {
"rate": 0
},
"io_write_count": 0,
"io_write_count_details": {
"rate": 0
},
"io_write_bytes": 0,
"io_write_bytes_details": {
"rate": 0
},
"io_write_avg_time": 0,
"io_write_avg_time_details": {
"rate": 0
},
"io_sync_count": 0,
"io_sync_count_details": {
"rate": 0
},
"io_sync_avg_time": 0,
"io_sync_avg_time_details": {
"rate": 0
},
"io_seek_count": 0,
"io_seek_count_details": {
"rate": 0
},
"io_seek_avg_time": 0,
"io_seek_avg_time_details": {
"rate": 0
},
"io_reopen_count": 0,
"io_reopen_count_details": {
"rate": 0
},
"mnesia_ram_tx_count": 60,
"mnesia_ram_tx_count_details": {
"rate": 0
},
"mnesia_disk_tx_count": 10,
"mnesia_disk_tx_count_details": {
"rate": 0
},
"msg_store_read_count": 0,
"msg_store_read_count_details": {
"rate": 0
},
"msg_store_write_count": 0,
"msg_store_write_count_details": {
"rate": 0
},
"queue_index_journal_write_count": 0,
"queue_index_journal_write_count_details": {
"rate": 0
},
"queue_index_write_count": 0,
"queue_index_write_count_details": {
"rate": 0
},
"queue_index_read_count": 3,
"queue_index_read_count_details": {
"rate": 0
},
"io_file_handle_open_attempt_count": 73,
"io_file_handle_open_attempt_count_details": {
"rate": 0
},
"io_file_handle_open_attempt_avg_time": 0.031643835616438354,
"io_file_handle_open_attempt_avg_time_details": {
"rate": 0
},
"connection_created": 0,
"connection_created_details": {
"rate": 0
},
"connection_closed": 0,
"connection_closed_details": {
"rate": 0
},
"channel_created": 0,
"channel_created_details": {
"rate": 0
},
"channel_closed": 0,
"channel_closed_details": {
"rate": 0
},
"queue_declared": 0,
"queue_declared_details": {
"rate": 0
},
"queue_created": 0,
"queue_created_details": {
"rate": 0
},
"queue_deleted": 0,
"queue_deleted_details": {
"rate": 0
},
"cluster_links": [],
"metrics_gc_queue_length": {
"connection_closed": 0,
"channel_closed": 0,
"consumer_deleted": 0,
"exchange_deleted": 0,
"queue_deleted": 0,
"vhost_deleted": 0,
"node_node_deleted": 0,
"channel_consumer_deleted": 0
}
}