-
Notifications
You must be signed in to change notification settings - Fork 31
/
riaknostic.erl
172 lines (162 loc) · 7.15 KB
/
riaknostic.erl
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
%% -------------------------------------------------------------------
%%
%% riaknostic - automated diagnostic tools for Riak
%%
%% Copyright (c) 2011 Basho Technologies, Inc. All Rights Reserved.
%%
%% This file is provided to you under the Apache License,
%% Version 2.0 (the "License"); you may not use this file
%% except in compliance with the License. You may obtain
%% a copy of the License at
%%
%% http://www.apache.org/licenses/LICENSE-2.0
%%
%% Unless required by applicable law or agreed to in writing,
%% software distributed under the License is distributed on an
%% "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
%% KIND, either express or implied. See the License for the
%% specific language governing permissions and limitations
%% under the License.
%%
%% -------------------------------------------------------------------
%% @doc <p>The <code>riaknostic</code> module is the entry point for
%% the escript. It is responsible for parsing command-line arguments
%% and switches, printing the available checks, listing the help text,
%% or running all or the specified checks, depending on the command
%% line.</p>
%%
%% <p>The <code>getopt</code> application and module is used
%% for command-line parsing. The defined switches and arguments are:</p>
%% <pre>$ ./riaknostic --etc etc --base base --user user [-d level] [-l] [-h] [check_name...]</pre>
%%
%% <table class="options">
%% <tr><td><code>--etc etc</code></td><td>the location of the Riak
%% configuration directory (set automatically by
%% <code>riak-admin</code>)</td></tr>
%% <tr><td><code>--base base</code></td><td>the base directory of
%% Riak, aka <code>RUNNER_BASE_DIR</code> (set automatically by
%% <code>riak-admin</code>)</td></tr>
%% <tr><td><code>--user user</code></td><td>the user that Riak runs as
%% (set automatically by <code>riak-admin</code>)</td></tr>
%% <tr><td><code>-d, --level level</code>  </td><td>the severity of
%% messages you want to see, defaulting to 'notice'. Equivalent to
%% syslog/<code>lager</code> severity levels.</td></tr>
%% <tr><td><code>-l, --list</code></td><td>lists available checks,
%% that is, modules that implement <code>riaknostic_check</code>. A
%% "short name" will be given for ease-of-use.</td></tr>
%% <tr><td><code>-h, --help</code></td><td> - print command usage
%% ("help")</td></tr>
%% <tr><td><code>check_name</code></td><td>when given, a specific
%% check or list of checks to run</td></tr>
%% </table>
%% @end
-module(riaknostic).
-export([main/1]).
-define(OPTS, [
{etc, undefined, "etc", string, undefined },
{base, undefined, "base", string, undefined },
{user, undefined, "user", string, undefined },
{level, $d, "level", {atom, notice}, "Minimum message severity level (default: notice)"},
{list, $l, "list", undefined, "Describe available diagnostic tasks" },
% should we calc and interpolate the actual cwd for the below?
{export,undefined, "export",undefined, "Package system info in '$CWD/export.zip'" }
]).
%% @doc The main entry point for the riaknostic escript.
-spec main(CommandLineArguments::[string()]) -> any().
main(Args) ->
application:load(riaknostic),
case getopt:parse(?OPTS, Args) of
{ok, {Opts, NonOptArgs}} ->
case process_opts(Opts) of
list -> list_checks();
run -> run(NonOptArgs);
export -> riaknostic_export:export()
end;
{error, Error} ->
io:format("Invalid option sequence given: ~w~n", [Error])
end.
list_checks() ->
Descriptions = [ {riaknostic_util:short_name(Mod), Mod:description()} ||
Mod <- riaknostic_check:modules() ],
io:format("Available diagnostic checks:~n~n"),
lists:foreach(fun({Mod, Desc}) ->
io:format(" ~.20s ~s~n", [Mod, Desc])
end, lists:sort(Descriptions)).
run(InputChecks) ->
case riaknostic_config:prepare() of
{error, Reason} ->
io:format("Fatal error: ~s~n", [Reason]);
_ ->
ok
end,
Checks = case InputChecks of
[] ->
riaknostic_check:modules();
_ ->
ShortNames = [{riaknostic_util:short_name(Mod), Mod} || Mod <- riaknostic_check:modules() ],
element(1, lists:foldr(fun validate_checks/2, {[], ShortNames}, InputChecks))
end,
Messages = lists:foldl(fun(Mod, Acc) ->
Acc ++ riaknostic_check:check(Mod)
end, [], Checks),
case Messages of
[] ->
io:format("No diagnostic messages to report.~n");
_ ->
%% Print the most critical messages first
LogLevelNum = lists:foldl(
fun({mask, Mask}, Acc) ->
Mask bor Acc;
(Level, Acc) when is_integer(Level) ->
{mask, Mask} = lager_util:config_to_mask(lager_util:num_to_level(Level)),
Mask bor Acc;
(_, Acc) ->
Acc
end, 0, lager:get_loglevels()),
FilteredMessages = lists:filter(fun({Level,_,_}) ->
lager_util:level_to_num(Level) =< LogLevelNum
end, Messages),
SortedMessages = lists:sort(fun({ALevel, _, _}, {BLevel, _, _}) ->
lager_util:level_to_num(ALevel) =< lager_util:level_to_num(BLevel)
end, FilteredMessages),
case SortedMessages of
[] ->
io:format("No diagnostic messages to report.~n");
_ ->
lists:foreach(fun riaknostic_check:print/1, SortedMessages)
end
end.
validate_checks(Check, {Mods, SNames}) ->
case lists:keyfind(Check, 1, SNames) of
{Check, Mod} ->
{[Mod|Mods], lists:delete({Check, Mod}, SNames)};
_ ->
io:format("Unknown check '~s' specified, skipping.~n", [Check]),
{Mods, SNames}
end.
process_opts(Opts) ->
process_opts(Opts, run).
process_opts([], Result) ->
Result;
process_opts([H|T], Result) ->
process_opts(T, process_option(H, Result)).
process_option({etc,Path}, Result) ->
application:set_env(riaknostic, etc, filename:absname(Path)),
Result;
process_option({base, Path}, Result) ->
application:set_env(riaknostic, base, filename:absname(Path)),
Result;
process_option({user, User}, Result) ->
application:set_env(riaknostic, user, User),
Result;
process_option({level, Level}, Result) ->
application:set_env(riaknostic, log_level, Level),
Result;
process_option(list, usage) -> %% Help should have precedence over listing checks
usage;
process_option(list, _) ->
list;
process_option(usage, _) ->
usage;
process_option(export, _) ->
export.