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
|
%% 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-2021 VMware, Inc. or its affiliates. All rights reserved.
%%
-module(rabbit_nodes).
-export([names/1, diagnostics/1, make/1, make/2, parts/1, cookie_hash/0,
is_running/2, is_process_running/2,
cluster_name/0, set_cluster_name/1, set_cluster_name/2, ensure_epmd/0,
all_running/0, name_type/0, running_count/0, total_count/0,
await_running_count/2, is_single_node_cluster/0,
boot/0]).
-export([persistent_cluster_id/0, seed_internal_cluster_id/0, seed_user_provided_cluster_name/0]).
-export([all/0, all_running_with_hashes/0, target_cluster_size_hint/0, reached_target_cluster_size/0]).
-export([lock_id/1, lock_retries/0]).
-include_lib("kernel/include/inet.hrl").
-include_lib("rabbit_common/include/rabbit.hrl").
-define(SAMPLING_INTERVAL, 1000).
-define(INTERNAL_CLUSTER_ID_PARAM_NAME, internal_cluster_id).
% Retries as passed to https://erlang.org/doc/man/global.html#set_lock-3
% To understand how retries map to the timeout, read
% https://github.com/erlang/otp/blob/d256ae477014158a49bb860b283df9c040011197/lib/kernel/src/global.erl#L2062-L2075
% 80 corresponds to a timeout of ca 300 seconds.
-define(DEFAULT_LOCK_RETRIES, 80).
-define(DEFAULT_TARGET_CLUSTER_SIZE, 1).
%%----------------------------------------------------------------------------
%% API
%%----------------------------------------------------------------------------
boot() ->
seed_internal_cluster_id(),
seed_user_provided_cluster_name().
name_type() ->
#{nodename_type := NodeType} = rabbit_prelaunch:get_context(),
NodeType.
-spec names(string()) ->
rabbit_types:ok_or_error2([{string(), integer()}], term()).
names(Hostname) ->
rabbit_nodes_common:names(Hostname).
-spec diagnostics([node()]) -> string().
diagnostics(Nodes) ->
rabbit_nodes_common:diagnostics(Nodes).
make(NameOrParts) ->
rabbit_nodes_common:make(NameOrParts).
make(ShortName, Hostname) ->
make({ShortName, Hostname}).
parts(NodeStr) ->
rabbit_nodes_common:parts(NodeStr).
-spec cookie_hash() -> string().
cookie_hash() ->
rabbit_nodes_common:cookie_hash().
-spec is_running(node(), atom()) -> boolean().
is_running(Node, Application) ->
rabbit_nodes_common:is_running(Node, Application).
-spec is_process_running(node(), atom()) -> boolean().
is_process_running(Node, Process) ->
rabbit_nodes_common:is_process_running(Node, Process).
-spec cluster_name() -> binary().
cluster_name() ->
case rabbit_runtime_parameters:value_global(cluster_name) of
not_found -> cluster_name_default();
Name -> Name
end.
cluster_name_default() ->
{ID, _} = parts(node()),
FQDN = rabbit_net:hostname(),
list_to_binary(atom_to_list(make({ID, FQDN}))).
-spec persistent_cluster_id() -> binary().
persistent_cluster_id() ->
case rabbit_runtime_parameters:lookup_global(?INTERNAL_CLUSTER_ID_PARAM_NAME) of
not_found ->
seed_internal_cluster_id(),
persistent_cluster_id();
Param ->
#{value := Val, name := ?INTERNAL_CLUSTER_ID_PARAM_NAME} = maps:from_list(Param),
Val
end.
-spec seed_internal_cluster_id() -> binary().
seed_internal_cluster_id() ->
case rabbit_runtime_parameters:lookup_global(?INTERNAL_CLUSTER_ID_PARAM_NAME) of
not_found ->
Id = rabbit_guid:binary(rabbit_guid:gen(), "rabbitmq-cluster-id"),
rabbit_log:info("Initialising internal cluster ID to '~s'", [Id]),
rabbit_runtime_parameters:set_global(?INTERNAL_CLUSTER_ID_PARAM_NAME, Id, ?INTERNAL_USER),
Id;
Param ->
#{value := Val, name := ?INTERNAL_CLUSTER_ID_PARAM_NAME} = maps:from_list(Param),
Val
end.
seed_user_provided_cluster_name() ->
case application:get_env(rabbit, cluster_name) of
undefined -> ok;
{ok, Name} ->
rabbit_log:info("Setting cluster name to '~s' as configured", [Name]),
set_cluster_name(rabbit_data_coercion:to_binary(Name))
end.
-spec set_cluster_name(binary()) -> 'ok'.
set_cluster_name(Name) ->
set_cluster_name(Name, ?INTERNAL_USER).
-spec set_cluster_name(binary(), rabbit_types:username()) -> 'ok'.
set_cluster_name(Name, Username) ->
%% Cluster name should be binary
BinaryName = rabbit_data_coercion:to_binary(Name),
rabbit_runtime_parameters:set_global(cluster_name, BinaryName, Username).
ensure_epmd() ->
rabbit_nodes_common:ensure_epmd().
-spec all() -> [node()].
all() -> rabbit_mnesia:cluster_nodes(all).
-spec all_running() -> [node()].
all_running() -> rabbit_mnesia:cluster_nodes(running).
-spec running_count() -> integer().
running_count() -> length(all_running()).
-spec total_count() -> integer().
total_count() -> length(rabbit_nodes:all()).
-spec is_single_node_cluster() -> boolean().
is_single_node_cluster() ->
total_count() =:= 1.
-spec await_running_count(integer(), integer()) -> 'ok' | {'error', atom()}.
await_running_count(TargetCount, Timeout) ->
Retries = round(Timeout/?SAMPLING_INTERVAL),
await_running_count_with_retries(TargetCount, Retries).
await_running_count_with_retries(1, _Retries) -> ok;
await_running_count_with_retries(_TargetCount, Retries) when Retries =:= 0 ->
{error, timeout};
await_running_count_with_retries(TargetCount, Retries) ->
case running_count() >= TargetCount of
true -> ok;
false ->
timer:sleep(?SAMPLING_INTERVAL),
await_running_count_with_retries(TargetCount, Retries - 1)
end.
-spec all_running_with_hashes() -> #{non_neg_integer() => node()}.
all_running_with_hashes() ->
maps:from_list([{erlang:phash2(Node), Node} || Node <- all_running()]).
-spec target_cluster_size_hint() -> non_neg_integer().
target_cluster_size_hint() ->
cluster_formation_key_or_default(target_cluster_size_hint, ?DEFAULT_TARGET_CLUSTER_SIZE).
-spec reached_target_cluster_size() -> boolean().
reached_target_cluster_size() ->
running_count() >= target_cluster_size_hint().
-spec lock_id(Node :: node()) -> {ResourceId :: string(), LockRequesterId :: node()}.
lock_id(Node) ->
{cookie_hash(), Node}.
-spec lock_retries() -> integer().
lock_retries() ->
cluster_formation_key_or_default(internal_lock_retries, ?DEFAULT_LOCK_RETRIES).
%%
%% Implementation
%%
cluster_formation_key_or_default(Key, Default) ->
case application:get_env(rabbit, cluster_formation) of
{ok, PropList} ->
proplists:get_value(Key, PropList, Default);
undefined ->
Default
end.
|
