Merge pull request #15975 from rabbitmq/connection-info-disable-metrics-conn

HTTP API: Display static connection info when stats are disabled

Author: michaelklishin

deps/rabbitmq_management/priv/www/js/formatters.js

@@ -971,6 +971,10 @@ function group_count(mode, group, bools) {
     var options = COLUMNS[mode][group];
     for (var i = 0; i < options.length; i++) {
         var column = options[i][0];
+        if (mode === 'connections' && disable_stats &&
+            (column === 'from_client' || column === 'to_client')) {
+            continue;
+        }
         if (show_column(mode, column)) count++;
     }
     return count;

deps/rabbitmq_management/priv/www/js/global.js

@@ -170,8 +170,19 @@ var DISABLED_STATS_COLUMNS =
                    ['msgs-persistent', 'Persistent',     false],
                    ['msgs-total',      'Total',          true]]},
      'connections':
-     {'Overview': [['user',   'User name', true],
-                   ['state',  'State',     true]]},
+     {'Overview': [['container_id', 'Container ID', true],
+                   ['user',   'User name', true]],
+      'Details': [['ssl',            'TLS',      true],
+                  ['ssl_info',       'TLS details',    false],
+                  ['protocol',       'Protocol',       true],
+                  ['channel_max',    'Channel max',    false],
+                  ['frame_max',      'Frame max',      false],
+                  ['auth_mechanism', 'SASL auth mechanism', false],
+                  ['client',         'Client',         false]],
+      'Network': [['from_client',  'From client',  false],
+                  ['to_client',    'To client',    false],
+                  ['heartbeat',    'Heartbeat',    false],
+                  ['connected_at', 'Connected at', false]]},
 
      'vhosts':
      {'Overview': [['cluster-state',   'Cluster state',  false]]}};

deps/rabbitmq_management/priv/www/js/tmpl/columns-options.ejs

@@ -15,7 +15,12 @@
     <tr>
       <th><label><%= group %>:</label></th>
       <td>
-      <% for (var i = 0; i < options.length; i++) { %>
+      <% for (var i = 0; i < options.length; i++) {
+           if (mode === 'connections' && disable_stats &&
+               (options[i][0] === 'from_client' || options[i][0] === 'to_client')) {
+             continue;
+           }
+      %>
           <%= fmt_checkbox(mode + '-' + options[i][0], options[i][1], get_pref('column-' + mode + '-' + options[i][0]) == 'true') %>
       <% } %>
       </td>

deps/rabbitmq_management/priv/www/js/tmpl/connection.ejs

@@ -1,10 +1,11 @@
 <h2>Connection <%= fmt_string(connection.name) %> <%= fmt_maybe_vhost(connection.vhost) %></h1>
 
-<% if (!disable_stats) { %>
 <div class="section" id="connection-overview-section">
 <h2>Overview</h2>
 <div class="hider updatable">
+<% if (!disable_stats) { %>
   <%= data_rates('data-rates-conn', connection, 'Data rates') %>
+<% } %>
 
 <h3>Details</h3>
 <table class="facts facts-l">
@@ -83,6 +84,7 @@
 </div>
 </div>
 
+<% if (!disable_stats) { %>
 <% if (connection.protocol === 'AMQP 1-0' ||
        connection.protocol === 'Web AMQP 1-0') { %>
 
@@ -102,6 +104,7 @@
   </div>
 </div>
 
+<% } %>
 <% } %>
 
 <% if (connection.ssl) { %>
@@ -157,7 +160,7 @@
 </div>
 <% } %>
 
-<% if(connection.reductions || connection.garbage_collection) { %>
+<% if (!disable_stats && (connection.reductions || connection.garbage_collection)) { %>
 <div class="section-hidden" id="connection-runtime-metrics-section">
 <h2>Runtime Metrics (Advanced)</h2>
  <div class="hider updatable">
@@ -194,7 +197,6 @@
  </div>
 </div>
 
-<% } %>
 <% } %>
 
 <div class="section-hidden" id="connection-close-section">

deps/rabbitmq_management/priv/www/js/tmpl/connections.ejs

@@ -8,10 +8,8 @@
  <thead>
   <tr>
     <%= group_heading('connections', 'Overview', [vhosts_interesting, nodes_interesting, true]) %>
-    <% if (!disable_stats) { %>
     <%= group_heading('connections', 'Details', []) %>
     <%= group_heading('connections', 'Network', []) %>
-    <% } %>
     <th class="plus-minus"><span class="popup-options-link" title="Click to change columns" type="columns" for="connections">+/-</span></th>
   </tr>
   <tr>
@@ -32,8 +30,7 @@
 <% if (show_column('connections',      'user')) { %>
     <th><%= fmt_sort('User name',      'user') %></th>
 <% } %>
-<% if (!disable_stats) { %>
-<% if (show_column('connections',      'state')) { %>
+<% if (show_column('connections',      'state')  && !disable_stats) { %>
     <th><%= fmt_sort('State',          'state') %></th>
 <% } %>
 <% if (show_column('connections',      'ssl')) { %>
@@ -45,7 +42,7 @@
 <% if (show_column('connections',      'protocol')) { %>
     <th><%= fmt_sort('Protocol',       'protocol') %></th>
 <% } %>
-<% if (show_column('connections',      'channels')) { %>
+<% if (show_column('connections',      'channels')  && !disable_stats) { %>
     <th><%= fmt_sort('Channels',       'channels') %></th>
 <% } %>
 <% if (show_column('connections',      'channel_max')) { %>
@@ -60,18 +57,17 @@
 <% if (show_column('connections',      'client')) { %>
     <th><%= fmt_sort('Client',         'properties') %></th>
 <% } %>
-<% if (show_column('connections',      'from_client')) { %>
+<% if (show_column('connections',      'from_client') && !disable_stats) { %>
     <th><%= fmt_sort('From client',    'recv_oct_details.rate') %></th>
 <% } %>
-<% if (show_column('connections',      'to_client')) { %>
+<% if (show_column('connections',      'to_client') && !disable_stats) { %>
     <th><%= fmt_sort('To client',      'send_oct_details.rate') %></th>
 <% } %>
 <% if (show_column('connections',      'heartbeat')) { %>
     <th><%= fmt_sort('Heartbeat',      'timeout') %></th>
 <% } %>
 <% if (show_column('connections',      'connected_at')) { %>
     <th><%= fmt_sort('Connected at',   'connected_at') %></th>
-<% } %>
 <% } %>
   </tr>
  </thead>
@@ -107,8 +103,7 @@
 <% if (show_column('connections', 'user')) { %>
     <td class="c"><%= fmt_string(connection.user) %></td>
 <% } %>
-<% if (!disable_stats) { %>
-<% if (show_column('connections', 'state')) { %>
+<% if (show_column('connections', 'state') && !disable_stats) { %>
     <td><%= fmt_object_state(connection) %></td>
 <% } %>
 <% if (show_column('connections', 'ssl')) { %>
@@ -129,7 +124,7 @@
 <% if (show_column('connections', 'protocol')) { %>
     <td class="c"><%= connection.protocol %></td>
 <% } %>
-<% if (show_column('connections', 'channels')) { %>
+<% if (show_column('connections', 'channels')  && !disable_stats) { %>
     <td class="r"><%= fmt_string(connection.channels, '') %></td>
 <% } %>
 <% if (show_column('connections', 'channel_max')) { %>
@@ -144,10 +139,10 @@
 <% if (show_column('connections', 'client')) { %>
     <td><%= fmt_client_name(connection.client_properties) %></td>
 <% } %>
-<% if (show_column('connections', 'from_client')) { %>
+<% if (show_column('connections', 'from_client') && !disable_stats) { %>
     <td><%= fmt_detail_rate_bytes(connection, 'recv_oct') %></td>
 <% } %>
-<% if (show_column('connections', 'to_client')) { %>
+<% if (show_column('connections', 'to_client') && !disable_stats) { %>
     <td><%= fmt_detail_rate_bytes(connection, 'send_oct') %></td>
 <% } %>
 <% if (show_column('connections', 'heartbeat')) { %>
@@ -156,7 +151,6 @@
 <% if (show_column('connections', 'connected_at')) { %>
     <td><%= fmt_timestamp_mini(connection.connected_at) %></td>
 <% } %>
-  <% } %>
   </tr>
   <% } %>
  </tbody>

deps/rabbitmq_management/src/rabbit_mgmt_db.erl

@@ -23,7 +23,8 @@
          get_channel/2, get_connection/2,
          get_all_channels/1, get_all_connections/1,
          get_all_consumers/0, get_all_consumers/1,
-         get_overview/2, get_overview/1]).
+         get_overview/2, get_overview/1,
+         get_all_connections/0, get_connection/1]).
 
 -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2,
          code_change/3, handle_pre_hibernate/1,
@@ -189,6 +190,11 @@ get_connection(Name, Ranges) ->
                    end
            end).
 
+get_connection(Name) ->
+    submit(fun(_Interval) ->
+                   created_stats_delegated(Name, connection_created_stats)
+           end).
+
 get_all_channels(?NO_RANGES = Ranges) ->
     submit_cached(channels,
                   fun(Interval) ->
@@ -213,6 +219,11 @@ get_all_connections(Ranges) ->
                    connection_stats(Ranges, Chans, Interval)
            end).
 
+get_all_connections() ->
+    submit(fun(_) ->
+                   created_stats_delegated(connection_created_stats)
+           end).
+
 get_all_consumers() -> get_all_consumers(all).
 get_all_consumers(VHosts) ->
     submit(fun(_Interval) -> consumers_stats(VHosts) end).

deps/rabbitmq_management/src/rabbit_mgmt_wm_connection.erl

@@ -35,16 +35,25 @@ resource_exists(ReqData, Context) ->
     end.
 
 to_json(ReqData, Context) ->
-    case rabbit_mgmt_util:disable_stats(ReqData) of
-        false ->
-            ConnStats = conn_stats(ReqData),
-            ConnStatsWithoutPids = rabbit_mgmt_format:strip_pids(ConnStats),
-            ReplyData = maps:from_list(ConnStatsWithoutPids),
-            rabbit_mgmt_util:reply(ReplyData, ReqData, Context);
-        true ->
-            ReplyData = [{name, rabbit_mgmt_util:id(connection, ReqData)}],
-            rabbit_mgmt_util:reply(ReplyData, ReqData, Context)
-    end.
+    ConnStats =
+        case rabbit_mgmt_util:disable_stats(ReqData) of
+            false ->
+                conn_stats(ReqData);
+            true ->
+                case rabbit_mgmt_db:get_connection(
+                       rabbit_mgmt_util:id(connection, ReqData)) of
+                    not_found ->
+                        %% IMPORTANT: connection_created_stats is empty when
+                        %% the metrics collector is disabled. Fall back to
+                        %% the tracked-connection record.
+                        conn(ReqData);
+                    Stats ->
+                        Stats
+                end
+        end,
+    ConnStatsWithoutPids = rabbit_mgmt_format:strip_pids(ConnStats),
+    ReplyData = maps:from_list(ConnStatsWithoutPids),
+    rabbit_mgmt_util:reply(ReplyData, ReqData, Context).
 
 delete_resource(ReqData, Context) ->
     case conn(ReqData) of

deps/rabbitmq_management/src/rabbit_mgmt_wm_connections.erl

@@ -48,6 +48,15 @@ do_connections_query(ReqData, Context) ->
         false ->
             augmented(ReqData, Context);
         true ->
-            rabbit_mgmt_util:filter_tracked_conn_list(rabbit_connection_tracking:list(),
-                                                      ReqData, Context)
+            case rabbit_mgmt_agent_config:is_metrics_collector_enabled() of
+                true ->
+                    rabbit_mgmt_util:filter_conn_ch_list(
+                      rabbit_mgmt_db:get_all_connections(), ReqData, Context);
+                false ->
+                    %% IMPORTANT: connection_created_stats is empty when the
+                    %% metrics collector is disabled. Fall back to the
+                    %% tracked-connection list.
+                    rabbit_mgmt_util:filter_tracked_conn_list(
+                      rabbit_connection_tracking:list(), ReqData, Context)
+            end
     end.

deps/rabbitmq_management/test/rabbit_mgmt_only_http_SUITE.erl

@@ -317,7 +317,7 @@ connections_test(Config) ->
                [LocalPort, amqp_port(Config)])),
     await_condition(fun() ->
         C = http_get(Config, Path, ?OK),
-        maps:size(C) =:= 1 andalso maps:is_key(name, C) andalso
+        maps:is_key(name, C) andalso maps:is_key(client_properties, C) andalso
         not maps:is_key(recv_oct_details, C)
     end),
     http_delete(Config, Path, {group, '2xx'}),