| Overview |  |
riaknostic module is the entry point for
the escript.
The riaknostic 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.
The getopt application and module is used
for command-line parsing. The defined switches and arguments are:
$ ./riaknostic --etc etc --base base --user user [-d level] [-l] [-h] [check_name...]
--etc etc | the location of the Riak
configuration directory (set automatically by
riak-admin) |
--base base | the base directory of
Riak, aka RUNNER_BASE_DIR (set automatically by
riak-admin) |
--user user | the user that Riak runs as
(set automatically by riak-admin) |
-d, --level level | the severity of
messages you want to see, defaulting to 'notice'. Equivalent to
syslog/lager severity levels. |
-l, --list | lists available checks,
that is, modules that implement riaknostic_check. A
"short name" will be given for ease-of-use. |
-h, --help | - print command usage ("help") |
check_name | when given, a specific check or list of checks to run |
| main/1 | The main entry point for the riaknostic escript. |
main(CommandLineArguments::[string()]) -> any()
The main entry point for the riaknostic escript.
Generated by EDoc, Feb 18 2012, 03:37:56.
