1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
|
## This Source Code Form is subject to the terms of the Mozilla Public
## License, v. 2.0. If a copy of the MPL was not distributed with this
## file, You can obtain one at https://mozilla.org/MPL/2.0/.
##
## Copyright (c) 2007-2022 VMware, Inc. or its affiliates. All rights reserved.
defmodule RabbitMQ.CLI.Ctl.Commands.ClusterStatusCommand do
alias RabbitMQ.CLI.Core.DocGuide
import RabbitMQ.CLI.Core.{Alarms, ANSI, Listeners, Platform, FeatureFlags}
import RabbitMQ.CLI.Core.Distribution, only: [per_node_timeout: 2]
import RabbitMQ.CLI.Core.DataCoercion
@behaviour RabbitMQ.CLI.CommandBehaviour
@default_timeout 60_000
def scopes(), do: [:ctl, :diagnostics]
use RabbitMQ.CLI.Core.AcceptsDefaultSwitchesAndTimeout
def merge_defaults(args, opts) do
timeout =
case opts[:timeout] do
nil -> @default_timeout
:infinity -> @default_timeout
other -> other
end
{args, Map.merge(%{timeout: timeout}, opts)}
end
use RabbitMQ.CLI.Core.AcceptsNoPositionalArguments
use RabbitMQ.CLI.Core.RequiresRabbitAppRunning
def run([], %{node: node_name, timeout: timeout}) do
case :rabbit_misc.rpc_call(node_name, :rabbit_mnesia, :status, []) do
{:badrpc, _} = err ->
err
status ->
case :rabbit_misc.rpc_call(node_name, :rabbit_mnesia, :cluster_nodes, [:running]) do
{:badrpc, _} = err ->
err
{:error, {:corrupt_or_missing_cluster_files, _, _}} ->
{:error, "Could not read mnesia files containing cluster status"}
nodes ->
count = length(nodes)
alarms_by_node = Enum.map(nodes, fn n -> alarms_by_node(n, per_node_timeout(timeout, count)) end)
listeners_by_node = Enum.map(nodes, fn n -> listeners_of(n, per_node_timeout(timeout, count)) end)
versions_by_node = Enum.map(nodes, fn n -> versions_by_node(n, per_node_timeout(timeout, count)) end)
maintenance_status_by_node = Enum.map(nodes,
fn n -> maintenance_status_by_node(n, per_node_timeout(timeout, count)) end)
feature_flags = case :rabbit_misc.rpc_call(node_name, :rabbit_ff_extra, :cli_info, [], timeout) do
{:badrpc, {:EXIT, {:undef, _}}} -> []
{:badrpc, _} = err -> err
val -> val
end
status ++
[{:alarms, alarms_by_node}] ++
[{:listeners, listeners_by_node}] ++
[{:versions, versions_by_node}] ++
[{:maintenance_status, maintenance_status_by_node}] ++
[{:feature_flags, feature_flags}]
end
end
end
def output({:error, :timeout}, %{node: node_name}) do
{:error, RabbitMQ.CLI.Core.ExitCodes.exit_software(),
"Error: timed out while waiting for a response from #{node_name}."}
end
def output(result, %{formatter: "erlang"}) do
{:ok, result}
end
def output(result, %{formatter: "json"}) when is_list(result) do
# format more data structures as map for sensible JSON output
m = result_map(result)
|> Map.update(:alarms, [], fn xs -> alarm_maps(xs) end)
|> Map.update(:listeners, %{}, fn m ->
Enum.map(m, fn {n, xs} -> {n, listener_maps(xs)} end) |> Enum.into(%{})
end)
{:ok, m}
end
def output(result, %{node: node_name}) when is_list(result) do
m = result_map(result)
cluster_name_section = [
"#{bright("Basics")}\n",
"Cluster name: #{m[:cluster_name]}"
]
disk_nodes_section = [
"\n#{bright("Disk Nodes")}\n",
] ++ node_lines(m[:disk_nodes])
ram_nodes_section = case m[:ram_nodes] do
[] -> []
xs -> [
"\n#{bright("RAM Nodes")}\n",
] ++ node_lines(xs)
end
running_nodes_section = [
"\n#{bright("Running Nodes")}\n",
] ++ node_lines(m[:running_nodes])
versions_section = [
"\n#{bright("Versions")}\n",
] ++ version_lines(m[:versions])
alarms_section = [
"\n#{bright("Alarms")}\n",
] ++ case m[:alarms] do
[] -> ["(none)"]
xs -> alarm_lines(xs, node_name)
end
partitions_section = [
"\n#{bright("Network Partitions")}\n"
] ++ case map_size(m[:partitions]) do
0 -> ["(none)"]
_ -> partition_lines(m[:partitions])
end
listeners_section = [
"\n#{bright("Listeners")}\n"
] ++ case map_size(m[:listeners]) do
0 -> ["(none)"]
_ -> Enum.reduce(m[:listeners], [], fn {node, listeners}, acc ->
acc ++ listener_lines(listeners, node)
end)
end
maintenance_section = [
"\n#{bright("Maintenance status")}\n",
] ++ maintenance_lines(m[:maintenance_status])
feature_flags_section = [
"\n#{bright("Feature flags")}\n"
] ++ case Enum.count(m[:feature_flags]) do
0 -> ["(none)"]
_ -> feature_flag_lines(m[:feature_flags])
end
lines = cluster_name_section ++ disk_nodes_section ++ ram_nodes_section ++ running_nodes_section ++
versions_section ++ maintenance_section ++ alarms_section ++ partitions_section ++
listeners_section ++ feature_flags_section
{:ok, Enum.join(lines, line_separator())}
end
use RabbitMQ.CLI.DefaultOutput
def formatter(), do: RabbitMQ.CLI.Formatters.String
def usage, do: "cluster_status"
def usage_doc_guides() do
[
DocGuide.clustering(),
DocGuide.cluster_formation(),
DocGuide.monitoring()
]
end
def help_section(), do: :cluster_management
def description(), do: "Displays all the nodes in the cluster grouped by node type, together with the currently running nodes"
def banner(_, %{node: node_name}), do: "Cluster status of node #{node_name} ..."
#
# Implementation
#
defp result_map(result) do
# [{nodes,[{disc,[hare@warp10,rabbit@warp10]},{ram,[flopsy@warp10]}]},
# {running_nodes,[flopsy@warp10,hare@warp10,rabbit@warp10]},
# {cluster_name,<<"rabbit@localhost">>},
# {partitions,[{flopsy@warp10,[rabbit@vagrant]},
# {hare@warp10,[rabbit@vagrant]}]},
# {alarms,[{flopsy@warp10,[]},
# {hare@warp10,[]},
# {rabbit@warp10,[{resource_limit,memory,rabbit@warp10}]}]}]
%{
cluster_name: Keyword.get(result, :cluster_name),
disk_nodes: result |> Keyword.get(:nodes, []) |> Keyword.get(:disc, []),
ram_nodes: result |> Keyword.get(:nodes, []) |> Keyword.get(:ram, []),
running_nodes: result |> Keyword.get(:running_nodes, []) |> Enum.map(&to_string/1),
alarms: Keyword.get(result, :alarms) |> Keyword.values |> Enum.concat |> Enum.uniq,
maintenance_status: Keyword.get(result, :maintenance_status, []) |> Enum.into(%{}),
partitions: Keyword.get(result, :partitions, []) |> Enum.into(%{}),
listeners: Keyword.get(result, :listeners, []) |> Enum.into(%{}),
versions: Keyword.get(result, :versions, []) |> Enum.into(%{}),
feature_flags: Keyword.get(result, :feature_flags, []) |> Enum.map(fn ff -> Enum.into(ff, %{}) end)
}
end
defp alarms_by_node(node, timeout) do
alarms = case :rabbit_misc.rpc_call(to_atom(node), :rabbit, :alarms, [], timeout) do
{:badrpc, _} -> []
xs -> xs
end
{node, alarms}
end
defp listeners_of(node, timeout) do
# This may seem inefficient since this call returns all known listeners
# in the cluster, so why do we run it on every node? See the badrpc clause,
# some nodes may be inavailable or partitioned from other nodes. This way we
# gather as complete a picture as possible. MK.
listeners = case :rabbit_misc.rpc_call(to_atom(node), :rabbit_networking, :active_listeners, [], timeout) do
{:badrpc, _} -> []
xs -> xs
end
{node, listeners_on(listeners, node)}
end
defp versions_by_node(node, timeout) do
{rmq_name, rmq_vsn, otp_vsn} = case :rabbit_misc.rpc_call(
to_atom(node), :rabbit, :product_info, [], timeout) do
{:badrpc, _} ->
{nil, nil, nil}
map ->
%{:otp_release => otp} = map
name = case map do
%{:product_name => v} -> v
%{:product_base_name => v} -> v
end
vsn = case map do
%{:product_version => v} -> v
%{:product_base_version => v} -> v
end
{name, vsn, otp}
end
{node, %{rabbitmq_name: to_string(rmq_name), rabbitmq_version: to_string(rmq_vsn), erlang_version: to_string(otp_vsn)}}
end
defp maintenance_status_by_node(node, timeout) do
target = to_atom(node)
result = case :rabbit_misc.rpc_call(target,
:rabbit_maintenance, :status_local_read, [target], timeout) do
{:badrpc, _} -> "unknown"
:regular -> "not under maintenance"
:draining -> magenta("marked for maintenance")
# forward compatibility: should we figure out a way to know when
# draining completes (it involves inherently asynchronous cluster
# operations such as quorum queue leader re-election), we'd introduce
# a new state
:drained -> magenta("marked for maintenance")
value -> to_string(value)
end
{node, result}
end
defp node_lines(nodes) do
Enum.map(nodes, &to_string/1) |> Enum.sort
end
defp version_lines(mapping) do
Enum.map(mapping, fn {node, %{rabbitmq_name: rmq_name, rabbitmq_version: rmq_vsn, erlang_version: otp_vsn}} ->
"#{node}: #{rmq_name} #{rmq_vsn} on Erlang #{otp_vsn}"
end)
end
defp partition_lines(mapping) do
Enum.map(mapping, fn {node, unreachable_peers} -> "Node #{node} cannot communicate with #{Enum.join(unreachable_peers, ", ")}" end)
end
defp maintenance_lines(mapping) do
Enum.map(mapping, fn {node, status} -> "Node: #{node}, status: #{status}" end)
end
end
|