New HTTP API health check endpoints
for the check introduced in #13487. Note that encoding a regular expression pattern with percent encoding is a pain (e.g. '.*' = '.%2a'), so these endpoints fall back to a default pattern value that matches all queues.
This commit is contained in:
Michael Klishin
parent
14d53f83cd
commit
601d4f2b6c
|
|
@ -202,6 +202,10 @@ dispatcher() ->
|
|||
{"/health/checks/port-listener/:port", rabbit_mgmt_wm_health_check_port_listener, []},
|
||||
{"/health/checks/protocol-listener/:protocol", rabbit_mgmt_wm_health_check_protocol_listener, []},
|
||||
{"/health/checks/virtual-hosts", rabbit_mgmt_wm_health_check_virtual_hosts, []},
|
||||
{"/health/checks/quorum-queues-without-elected-leaders/all-vhosts/", rabbit_mgmt_wm_health_check_quorum_queues_without_elected_leaders_across_all_vhosts, []},
|
||||
{"/health/checks/quorum-queues-without-elected-leaders/vhost/:vhost/", rabbit_mgmt_wm_health_check_quorum_queues_without_elected_leaders, []},
|
||||
{"/health/checks/quorum-queues-without-elected-leaders/all-vhosts/pattern/:pattern", rabbit_mgmt_wm_health_check_quorum_queues_without_elected_leaders_across_all_vhosts, []},
|
||||
{"/health/checks/quorum-queues-without-elected-leaders/vhost/:vhost/pattern/:pattern", rabbit_mgmt_wm_health_check_quorum_queues_without_elected_leaders, []},
|
||||
{"/health/checks/node-is-quorum-critical", rabbit_mgmt_wm_health_check_node_is_quorum_critical, []},
|
||||
{"/reset", rabbit_mgmt_wm_reset, []},
|
||||
{"/reset/:node", rabbit_mgmt_wm_reset, []},
|
||||
|
|
|
|||
|
|
@ -0,0 +1,68 @@
|
|||
%% 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-2025 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
|
||||
%%
|
||||
|
||||
%% An HTTP API counterpart of 'rabbitmq-diagnostics check_for_quorum_queues_without_an_elected_leader'
|
||||
-module(rabbit_mgmt_wm_health_check_quorum_queues_without_elected_leaders).
|
||||
|
||||
-export([init/2, to_json/2, content_types_provided/2, is_authorized/2]).
|
||||
-export([resource_exists/2]).
|
||||
-export([variances/2]).
|
||||
|
||||
-include_lib("rabbitmq_management_agent/include/rabbit_mgmt_records.hrl").
|
||||
|
||||
-define(DEFAULT_PATTERN, <<".*">>).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
|
||||
init(Req, _State) ->
|
||||
{cowboy_rest, rabbit_mgmt_headers:set_common_permission_headers(Req, ?MODULE), #context{}}.
|
||||
|
||||
variances(Req, Context) ->
|
||||
{[<<"accept-encoding">>, <<"origin">>], Req, Context}.
|
||||
|
||||
content_types_provided(ReqData, Context) ->
|
||||
{rabbit_mgmt_util:responder_map(to_json), ReqData, Context}.
|
||||
|
||||
resource_exists(ReqData, Context) ->
|
||||
Result = case {vhost(ReqData), pattern(ReqData)} of
|
||||
{none, _} -> false;
|
||||
{_, none} -> false;
|
||||
_ -> true
|
||||
end,
|
||||
{Result, ReqData, Context}.
|
||||
|
||||
to_json(ReqData, Context) ->
|
||||
case rabbit_quorum_queue:leader_health_check(pattern(ReqData), vhost(ReqData)) of
|
||||
[] ->
|
||||
rabbit_mgmt_util:reply(#{status => ok}, ReqData, Context);
|
||||
Qs when length(Qs) > 0 ->
|
||||
Msg = <<"Detected quorum queues without an elected leader">>,
|
||||
failure(Msg, Qs, ReqData, Context)
|
||||
end.
|
||||
|
||||
failure(Message, Qs, ReqData, Context) ->
|
||||
Body = #{status => failed,
|
||||
reason => Message,
|
||||
queues => Qs},
|
||||
{Response, ReqData1, Context1} = rabbit_mgmt_util:reply(Body, ReqData, Context),
|
||||
{stop, cowboy_req:reply(503, #{}, Response, ReqData1), Context1}.
|
||||
|
||||
is_authorized(ReqData, Context) ->
|
||||
rabbit_mgmt_util:is_authorized(ReqData, Context).
|
||||
|
||||
%%
|
||||
%% Implementation
|
||||
%%
|
||||
|
||||
vhost(ReqData) ->
|
||||
rabbit_mgmt_util:id(vhost, ReqData).
|
||||
|
||||
pattern(ReqData) ->
|
||||
case rabbit_mgmt_util:id(pattern, ReqData) of
|
||||
none -> ?DEFAULT_PATTERN;
|
||||
Other -> Other
|
||||
end.
|
||||
|
|
@ -0,0 +1,61 @@
|
|||
%% 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-2025 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. All rights reserved.
|
||||
%%
|
||||
|
||||
%% An HTTP API counterpart of 'rabbitmq-diagnostics check_for_quorum_queues_without_an_elected_leader --across-all-vhosts'
|
||||
-module(rabbit_mgmt_wm_health_check_quorum_queues_without_elected_leaders_across_all_vhosts).
|
||||
|
||||
-export([init/2, to_json/2, content_types_provided/2, is_authorized/2]).
|
||||
-export([resource_exists/2]).
|
||||
-export([variances/2]).
|
||||
|
||||
-include_lib("rabbitmq_management_agent/include/rabbit_mgmt_records.hrl").
|
||||
|
||||
-define(ACROSS_ALL_VHOSTS, across_all_vhosts).
|
||||
-define(DEFAULT_PATTERN, <<".*">>).
|
||||
|
||||
%%--------------------------------------------------------------------
|
||||
|
||||
init(Req, _State) ->
|
||||
{cowboy_rest, rabbit_mgmt_headers:set_common_permission_headers(Req, ?MODULE), #context{}}.
|
||||
|
||||
variances(Req, Context) ->
|
||||
{[<<"accept-encoding">>, <<"origin">>], Req, Context}.
|
||||
|
||||
content_types_provided(ReqData, Context) ->
|
||||
{rabbit_mgmt_util:responder_map(to_json), ReqData, Context}.
|
||||
|
||||
resource_exists(ReqData, Context) ->
|
||||
{true, ReqData, Context}.
|
||||
|
||||
to_json(ReqData, Context) ->
|
||||
case rabbit_quorum_queue:leader_health_check(pattern(ReqData), ?ACROSS_ALL_VHOSTS) of
|
||||
[] ->
|
||||
rabbit_mgmt_util:reply(#{status => ok}, ReqData, Context);
|
||||
Qs when length(Qs) > 0 ->
|
||||
Msg = <<"Detected quorum queues without an elected leader">>,
|
||||
failure(Msg, Qs, ReqData, Context)
|
||||
end.
|
||||
|
||||
failure(Message, Qs, ReqData, Context) ->
|
||||
Body = #{status => failed,
|
||||
reason => Message,
|
||||
queues => Qs},
|
||||
{Response, ReqData1, Context1} = rabbit_mgmt_util:reply(Body, ReqData, Context),
|
||||
{stop, cowboy_req:reply(503, #{}, Response, ReqData1), Context1}.
|
||||
|
||||
is_authorized(ReqData, Context) ->
|
||||
rabbit_mgmt_util:is_authorized(ReqData, Context).
|
||||
|
||||
%%
|
||||
%% Implementation
|
||||
%%
|
||||
|
||||
pattern(ReqData) ->
|
||||
case rabbit_mgmt_util:id(pattern, ReqData) of
|
||||
none -> ?DEFAULT_PATTERN;
|
||||
Other -> Other
|
||||
end.
|
||||
Loading…
Reference in New Issue