diff options
| author | Jay Doane <jaydoane@apache.org> | 2021-04-19 20:50:27 -0700 |
|---|---|---|
| committer | Jay Doane <jaydoane@apache.org> | 2021-04-20 00:12:57 -0700 |
| commit | ad79f3c6106e7be57153225834a3ad0e3a1441ec (patch) | |
| tree | 453df1e557db773710cd8ed26f36349aedee12c9 | |
| parent | 54c880e9020ee4ea7669345f904c985e54131b40 (diff) | |
| download | couchdb-ad79f3c6106e7be57153225834a3ad0e3a1441ec.tar.gz | |
Update weatherreport documentation
| -rw-r--r-- | src/weatherreport/README.md | 17 | ||||
| -rw-r--r-- | src/weatherreport/src/weatherreport.erl | 2 |
2 files changed, 16 insertions, 3 deletions
diff --git a/src/weatherreport/README.md b/src/weatherreport/README.md index 8cd687c65..09f66421f 100644 --- a/src/weatherreport/README.md +++ b/src/weatherreport/README.md @@ -17,8 +17,9 @@ For most cases, you can just run the `weatherreport` command as given at the top ```bash weatherreport --help -Usage: weatherreport [-d <level>] [-e] [-h] [-l] [check_name ...] +Usage: weatherreport [-c <path>] [-d <level>] [-e] [-h] [-l] [check_name ...] + -c, --etc Path to the CouchDB configuration directory -d, --level Minimum message severity level (default: notice) -l, --list Describe available diagnostic tasks -e, --expert Perform more detailed diagnostics @@ -29,12 +30,24 @@ Usage: weatherreport [-d <level>] [-e] [-h] [-l] [check_name ...] To get an idea of what checks will be run, use the `--list` option: ```bash -weatherreport diag --list +weatherreport --list Available diagnostic checks: + custodian Shard safety/liveness checks + disk Data directory permissions and atime + internal_replication Check the number of pending internal replication jobs + ioq Check the total number of active IOQ requests + mem3_sync Check there is a registered mem3_sync process membership Cluster membership validity memory_use Measure memory usage + message_queues Check for processes with large mailboxes + node_stats Check useful erlang statistics for diagnostics nodes_connected Cluster node liveness + process_calls Check for large numbers of processes with the same current/initial call + process_memory Check for processes with high memory usage + safe_to_rebuild Check whether the node can safely be taken out of service + search Check the local search node is responsive + tcp_queues Measure the length of tcp queues in the kernel ``` If you want all the gory details about what WeatherReport is doing, you can run the checks at a more verbose logging level with the --level option: diff --git a/src/weatherreport/src/weatherreport.erl b/src/weatherreport/src/weatherreport.erl index 1f6ff073e..fd4b1e450 100644 --- a/src/weatherreport/src/weatherreport.erl +++ b/src/weatherreport/src/weatherreport.erl @@ -56,7 +56,7 @@ -export([main/1]). -define(OPTS, [ - {etc, undefined, "etc", string, undefined }, + {etc, $c, "etc", string, "Path to the CouchDB configuration directory"}, {level, $d, "level", {atom, notice}, "Minimum message severity level (default: notice)"}, {expert, $e, "expert", undefined, "Perform more detailed diagnostics" }, {usage, $h, "help", undefined, "Display help/usage" }, |