riaknostic: Automated diagnostic tools for Riak

Version: 1.0.0

Authors: Basho Technologies, Inc..

riaknostic is an escript and set of tools that diagnoses common problems that may affect a Riak node or cluster. riaknostic should be the first thing run when experiencing any problem with Riak. The tool is integrated with Riak via the riak-admin script.

$ riak-admin diag

This documentation serves to describe the API of the riaknostic application and script that powers the above command. The core of the application consists of 5 modules:

riaknostic - the core of the script, including CLI parsing and dispatching commands.
riaknostic_check - the behaviour module that all diagnostics must implement, including some general functions that support the riaknostic module.
riaknostic_config - convenience functions for inspecting the configuration of the local Riak node.
riaknostic_node - functions for sending commands to or inspecting the local Riak node or all members of the cluster.
riaknostic_util - utility functions, including for running shell programs

All other included modules are generally prefixed with riaknostic_check_ and are individual diagnostics that can be run.

riaknostic is licensed under the Apache v2 license.

Generated by EDoc, Feb 18 2012, 03:37:56.