Skip to content

Queues with plugins - Managment UI parts #13910

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 19, 2025
Merged

Queues with plugins - Managment UI parts #13910

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5fd3bdd
Protected queues - do not render Delete button for internal queues
ikavgo May 18, 2025
de17a77
Queues with plugins - Enable adding queues with plugins, Management UI
ikavgo Feb 7, 2025
180e7b1
Queues with plugins - switch to get_queue_type in Management UI
ikavgo Mar 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
221 changes: 219 additions & 2 deletions deps/rabbitmq_management/priv/www/js/global.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ var HELP = {
'Optional replacement routing key to use when a message is dead-lettered. If this is not set, the message\'s original routing key will be used.<br/>(Sets the "<a target="_blank" href="https://rabbitmq.com/dlx.html">x-dead-letter-routing-key</a>" argument.)',

'queue-dead-letter-strategy':
'Valid values are <code>at-most-once</code> or <code>at-least-once</code>. It defaults to <code>at-most-once</code>. This setting is understood only by quorum queues. If <code>at-least-once</code> is set, <code>Overflow behaviour</code> must be set to <code>reject-publish</code>. Otherwise, dead letter strategy will fall back to <code>at-most-once</code>.',
'Valid values are <code>at-most-once</code> or <code>at-least-once</code>. It defaults to <code>at-most-once</code>. If <code>at-least-once</code> is set, <code>Overflow behaviour</code> must be set to <code>reject-publish</code>. Otherwise, dead letter strategy will fall back to <code>at-most-once</code>.',

'queue-single-active-consumer':
'If set, makes sure only one consumer at a time consumes from the queue and fails over to another registered consumer in case the active one is cancelled or dies.<br/>(Sets the "<a target="_blank" href="https://rabbitmq.com/consumers.html#single-active-consumer">x-single-active-consumer</a>" argument.)',
Expand All @@ -235,7 +235,10 @@ var HELP = {
'Sets the data retention for stream queues in time units </br>(Y=Years, M=Months, D=Days, h=hours, m=minutes, s=seconds).<br/>E.g. "1h" configures the stream to only keep the last 1 hour of received messages.</br></br>(Sets the x-max-age argument.)',

'queue-overflow':
'Sets the <a target="_blank" href="https://www.rabbitmq.com/maxlength.html#overflow-behaviour">queue overflow behaviour</a>. This determines what happens to messages when the maximum length of a queue is reached. Valid values are <code>drop-head</code>, <code>reject-publish</code> or <code>reject-publish-dlx</code>. The quorum queue type only supports <code>drop-head</code> and <code>reject-publish</code>.',
'Sets the <a target="_blank" href="https://www.rabbitmq.com/maxlength.html#overflow-behaviour">queue overflow behaviour</a>. This determines what happens to messages when the maximum length of a queue is reached. Valid values are <code>drop-head</code>, <code>reject-publish</code> or <code>reject-publish-dlx</code>',

'quorum-queue-overflow':
'Sets the <a target="_blank" href="https://www.rabbitmq.com/maxlength.html#overflow-behaviour">queue overflow behaviour</a>. This determines what happens to messages when the maximum length of a queue is reached. Valid values for quorum queues are <code>drop-head</code> and <code>reject-publish</code>.',

'queue-master-locator':
'Deprecated: please use `queue-leader-locator` instead. <a target="_blank" href="https://www.rabbitmq.com/docs/clustering#replica-placement">Controls which node the queue will be running on.</a>',
Expand Down Expand Up @@ -887,3 +890,217 @@ var chart_data = {};
var last_page_out_of_range_error = 0;

var oauth;


///////////////////////////////////////////////////////////////////////////
// //
// Queue types //
// //
///////////////////////////////////////////////////////////////////////////

/// this queue types are very well known to the server, at the very least
/// this collection must be validated in terms of matching server queue
/// types registry. I hope I will have time for this.
var QUEUE_TYPE = function (queue) {
return QUEUE_TYPE[get_queue_type(queue)];
}
// TODO: while this allows for custom queues
// the proper way is to follow single source of truth
// and generate most of this on the server from queue type metadata
// including replacing tmpl's with data-driven generators
// For example server knows policy_apply_to for each queue
// and it knows what extra agruments each queue type accepts.
// So for the latter case we dont' need a template that lists
// queue args. We need iterator over server-supplied object.
QUEUE_TYPE["default"] = {
label: "Default",
params: {},
policy_apply_to: "classic_queue",
actions: {
get_message: true,
purge: true
},
tmpl: {
"arguments" : "classic-queue-arguments",
// TODO: this must be generated from js objects of course.
// and then those objects must be rendered by the server
"user_policy_arguments": "classic-queue-user-policy-arguments",
"operator_policy_arguments": "classic-queue-operator-policy-arguments",
"list" : "classic-queue-list",
"stats" : "classic-queue-stats",
"node_details" : "classic-queue-node-details"
}
};

QUEUE_TYPE["classic"] = {
label: "Classic",
params: {},
policy_apply_to: "classic_queue",
actions: {
get_message: true,
purge: true
},
tmpl: {
"arguments" : "classic-queue-arguments",
"user_policy_arguments": "classic-queue-user-policy-arguments",
"operator_policy_arguments": "classic-queue-operator-policy-arguments",
"list" : "classic-queue-list",
"stats" : "classic-queue-stats",
"node_details" : "classic-queue-node-details"
}
};

QUEUE_TYPE["quorum"] = {
label: "Quorum",
params: {
'durable': true,
'auto_delete': false
},
policy_apply_to: "quorum_queues",
actions: {
get_message: true,
purge: true
},
tmpl: {
"arguments" : "quorum-queue-arguments",
"user_policy_arguments": "quorum-queue-user-policy-arguments",
"operator_policy_arguments": "quorum-queue-operator-policy-arguments",
"list" : "quorum-queue-list",
"stats": "quorum-queue-stats",
"node_details" : "quorum-queue-node-details"
}
};

QUEUE_TYPE["stream"] = {
label: "Stream",
params: {
'durable': true,
'auto_delete': false
},
policy_apply_to: "streams",
actions: {
get_message: false,
purge: false
},
tmpl: {
"arguments" : "stream-queue-arguments",
"user_policy_arguments": "quorum-queue-user-policy-arguments",
"operator_policy_arguments": "stream-queue-operator-policy-arguments",
"list" : "stream-queue-list",
"stats" : "stream-queue-stats",
"node_details" : "stream-queue-node-details"
}
};

// here I'll shortcut for now and let it be like that
// other queue types can inject themlves where they want.
// since the 'sections' object will likely keep key insertion
// order custom keys for queue type will be coming last.

// maybe add helper functions?
var MEMORY_STATISTICS = {
sections: {'queue_procs' : ['classic', 'Classic queues'],
'quorum_queue_procs' : ['quorum', 'Quorum queues'],
'quorum_queue_dlx_procs' : ['quorum', 'Dead letter workers'],
'stream_queue_procs' : ['stream', 'Stream queues'],
'stream_queue_replica_reader_procs' : ['stream', 'Stream queues (replica reader)'],
'stream_queue_coordinator_procs' : ['stream', 'Stream queues (coordinator)'],
'binary' : ['binary', 'Binaries'],
'connection_readers' : ['conn', 'Connection readers'],
'connection_writers' : ['conn', 'Connection writers'],
'connection_channels' : ['conn', 'Connection channels'],
'connection_other' : ['conn', 'Connections (other)'],
'mnesia' : ['table', 'Mnesia'],
'msg_index' : ['table', 'Message store index'],
'mgmt_db' : ['table', 'Management database'],
'quorum_ets' : ['table', 'Quorum queue ETS tables'],
'other_ets' : ['table', 'Other ETS tables'],
'plugins' : ['proc', 'Plugins'],
'other_proc' : ['proc', 'Other process memory'],
'code' : ['system', 'Code'],
'atom' : ['system', 'Atoms'],
'other_system' : ['system', 'Other system'],
'allocated_unused' : ['unused', 'Allocated unused'],
'reserved_unallocated': ['unused', 'Unallocated reserved by the OS']},
keys: [[{name: 'Classic Queues', colour: 'classic',
keys: [['queue_procs', 'queues']]},
{name: 'Quorum Queues', colour: 'quorum',
keys: [['quorum_queue_procs','quorum'],
['quorum_queue_dlx_procs', 'dead letter workers']]},
{name: 'Streams', colour: 'stream',
keys: [['stream_queue_procs', 'stream'],
['stream_queue_replica_reader_procs', 'stream replica reader'],
['stream_queue_coordinator_procs', 'stream coordinator']]},
{name: 'Binaries', colour: 'binary',
keys: [['binary', '']]}],

[{name: 'Connections', colour: 'conn',
keys: [['connection_readers', 'readers'],
['connection_writers', 'writers'],
['connection_channels', 'channels'],
['connection_other', 'other']]}],

[{name: 'Tables', colour: 'table',
keys: [['mnesia', 'internal database tables'],
['msg_index', 'message store index'],
['mgmt_db', 'management database'],
['quorum_ets', 'quorum queue tables'],
['other_ets', 'other']]}],

[{name: 'Processes', colour: 'proc',
keys: [['plugins', 'plugins'],
['metadata_store', 'metadata store'],
['other_proc', 'other']]},
{name: 'System', colour: 'system',
keys: [['code', 'code'],
['atom', 'atoms'],
['other_system', 'other']
]}],

[{name: 'Preallocated memory', colour: 'unused',
keys: [['allocated_unused', 'preallocated by runtime, unused'],
['reserved_unallocated', 'unallocated, reserved by the OS']]}]]
}

var BINARY_STATISTICS = {
sections: {'queue_procs' : ['classic', 'Classic queues'],
'quorum_queue_procs' : ['quorum', 'Quorum queues'],
'quorum_queue_dlx_procs' : ['quorum', 'Dead letter workers'],
'stream_queue_procs' : ['stream', 'Stream queues'],
'stream_queue_replica_reader_procs' : ['stream', 'Stream queues (replica reader)'],
'stream_queue_coordinator_procs' : ['stream', 'Stream queues (coordinator)'],
'connection_readers' : ['conn', 'Connection readers'],
'connection_writers' : ['conn', 'Connection writers'],
'connection_channels' : ['conn', 'Connection channels'],
'connection_other' : ['conn', 'Connections (other)'],
'msg_index' : ['table', 'Message store index'],
'mgmt_db' : ['table', 'Management database'],
'plugins' : ['proc', 'Plugins'],
'metadata_store' : ['metadata_store', 'Metadata store'],
'other' : ['system', 'Other binary references']},
key: [[{name: 'Classic Queues', colour: 'classic',
keys: [['queue_procs', 'queues']]},
{name: 'Quorum Queues', colour: 'quorum',
keys: [['quorum_queue_procs', 'quorum'],
['quorum_queue_dlx_procs', 'dead letter workers']]},
{name: 'Streams', colour: 'stream',
keys: [['stream_queue_procs', 'stream'],
['stream_queue_replica_reader_procs', 'stream replica reader'],
['stream_queue_coordinator_procs', 'stream coordinator']]}],

[{name: 'Connections', colour: 'conn',
keys: [['connection_readers', 'readers'],
['connection_writers', 'writers'],
['connection_channels', 'channels'],
['connection_other', 'other']]}],

[{name: 'Tables', colour: 'table',
keys: [['msg_index', 'message store index'],
['mgmt_db', 'management database']]}],

[{name: 'Processes', colour: 'proc',
keys: [['plugins', 'plugins'],
['metadata_store', 'metadata store']]},
{name: 'System', colour: 'system',
keys: [['other', 'other']]}]]
};
11 changes: 6 additions & 5 deletions deps/rabbitmq_management/priv/www/js/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1578,11 +1578,8 @@ function collapse_multifields(params0) {
if (queue_type != 'default') {
params['arguments']['x-queue-type'] = queue_type;
}
if (queue_type == 'quorum' ||
queue_type == 'stream') {
params['durable'] = true;
params['auto_delete'] = false;
}

params = Object.assign(params, QUEUE_TYPE[queue_type].params)
}
return params;
}
Expand Down Expand Up @@ -1759,6 +1756,10 @@ function select_queue_type(queuetype) {
update();
}

function is_internal(queue) {
return queue.internal;
}

function get_queue_type (queue) {
return queue.type;
}
Expand Down
58 changes: 8 additions & 50 deletions deps/rabbitmq_management/priv/www/js/tmpl/binary.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,56 +5,14 @@
Binary statistics not available.
</p>
<% } else { %>
<%
var sections = {'queue_procs' : ['classic', 'Classic queues'],
'quorum_queue_procs' : ['quorum', 'Quorum queues'],
'quorum_queue_dlx_procs' : ['quorum', 'Dead letter workers'],
'stream_queue_procs' : ['stream', 'Stream queues'],
'stream_queue_replica_reader_procs' : ['stream', 'Stream queues (replica reader)'],
'stream_queue_coordinator_procs' : ['stream', 'Stream queues (coordinator)'],
'connection_readers' : ['conn', 'Connection readers'],
'connection_writers' : ['conn', 'Connection writers'],
'connection_channels' : ['conn', 'Connection channels'],
'connection_other' : ['conn', 'Connections (other)'],
'msg_index' : ['table', 'Message store index'],
'mgmt_db' : ['table', 'Management database'],
'plugins' : ['proc', 'Plugins'],
'metadata_store' : ['metadata_store', 'Metadata store'],
'other' : ['system', 'Other binary references']};
var total_out = [];
%>
<%= format('memory-bar', {sections: sections, memory: binary, total_out: total_out}) %>
<span class="clear">&nbsp;</span>
<div class="box">
<%
var key = [[{name: 'Classic Queues', colour: 'classic',
keys: [['queue_procs', 'queues']]},
{name: 'Quorum Queues', colour: 'quorum',
keys: [['quorum_queue_procs', 'quorum'],
['quorum_queue_dlx_procs', 'dead letter workers']]},
{name: 'Streams', colour: 'stream',
keys: [['stream_queue_procs', 'stream'],
['stream_queue_replica_reader_procs', 'stream replica reader'],
['stream_queue_coordinator_procs', 'stream coordinator']]}],

[{name: 'Connections', colour: 'conn',
keys: [['connection_readers', 'readers'],
['connection_writers', 'writers'],
['connection_channels', 'channels'],
['connection_other', 'other']]}],

[{name: 'Tables', colour: 'table',
keys: [['msg_index', 'message store index'],
['mgmt_db', 'management database']]}],

[{name: 'Processes', colour: 'proc',
keys: [['plugins', 'plugins'],
['metadata_store', 'metadata store']]},
{name: 'System', colour: 'system',
keys: [['other', 'other']]}]];
%>
<%= format('memory-table', {key: key, memory: binary}) %>
</div>
<%
var total_out = [];
%>
<%= format('memory-bar', {sections: BINARY_STATISTICS.sections, memory: binary, total_out: total_out}) %>
<span class="clear">&nbsp;</span>
<div class="box">
<%= format('memory-table', {key: BINARY_STATISTICS. key, memory: binary}) %>
</div>

<div class="memory-info">
Last updated: <b><%= fmt_date(new Date()) %></b>.<br/>
Expand Down
10 changes: 10 additions & 0 deletions deps/rabbitmq_management/priv/www/js/tmpl/classic-queue-arguments.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<span class="argument-link" field="arguments" key="x-expires" type="number">Auto expire</span> <span class="help" id="queue-expires"></span> |
<span class="argument-link" field="arguments" key="x-message-ttl" type="number">Message TTL</span> <span class="help" id="queue-message-ttl"></span> |
<span class="argument-link" field="arguments" key="x-overflow" type="string">Overflow behaviour</span> <span class="help" id="queue-overflow"></span><br/>
<span class="argument-link" field="arguments" key="x-single-active-consumer" type="boolean">Single active consumer</span> <span class="help" id="queue-single-active-consumer"></span> |
<span class="argument-link" field="arguments" key="x-dead-letter-exchange" type="string">Dead letter exchange</span> <span class="help" id="queue-dead-letter-exchange"></span> |
<span class="argument-link" field="arguments" key="x-dead-letter-routing-key" type="string">Dead letter routing key</span> <span class="help" id="queue-dead-letter-routing-key"></span><br/>
<span class="argument-link" field="arguments" key="x-max-length" type="number">Max length</span> <span class="help" id="queue-max-length"></span> |
<span class="argument-link" field="arguments" key="x-max-length-bytes" type="number">Max length bytes</span> <span class="help" id="queue-max-length-bytes"></span>
| <span class="argument-link" field="arguments" key="x-max-priority" type="number">Maximum priority</span> <span class="help" id="queue-max-priority"></span>
| <span class="argument-link" field="arguments" key="x-queue-leader-locator" type="string">Leader locator</span><span class="help" id="queue-leader-locator"></span>
4 changes: 4 additions & 0 deletions deps/rabbitmq_management/priv/www/js/tmpl/classic-queue-node-details.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<tr>
<th>Node</th>
<td><%= fmt_node(queue.node) %></td>
</tr>
11 changes: 11 additions & 0 deletions deps/rabbitmq_management/priv/www/js/tmpl/classic-queue-operator-policy-arguments.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<tr>
<td>Queues [Classic]</td>
<td>
<span class="argument-link" field="definitionop" key="expires" type="number">Auto expire</span> |
<span class="argument-link" field="definitionop" key="max-length" type="number">Max length</span> |
<span class="argument-link" field="definitionop" key="max-length-bytes" type="number">Max length bytes</span> |
<span class="argument-link" field="definitionop" key="message-ttl" type="number">Message TTL</span> |
<span class="help" id="queue-message-ttl"></span> |
<span class="argument-link" field="definitionop" key="overflow" type="string">Length limit overflow behaviour</span> <span class="help" id="queue-overflow"></span> </br>
</td>
</tr>
Loading