Mercurial > hg > ThermostatQA
changeset 175:34de0ddba44a
updated help messages texts
line wrap: on
line diff
--- a/outputtexts/head/output_of_exit_therm_shell.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/output_of_exit_therm_shell.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,3 +1,3 @@ -Thermostat version 1.1.0 +Thermostat version 1.99.2 Thermostat - > exit
--- a/outputtexts/head/output_of_help_therm_shell.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/output_of_help_therm_shell.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,29 +1,30 @@ -Thermostat version 1.1.0 +Thermostat version 1.99.2 Thermostat - > help list of commands: help show help for a given command or help overview - agent-info shows info for specified agent + agent-info show info for an agent clean-data drop all data related to all of the specified agents connect persistently connect to storage - disconnect disconnect from the currently used storage + disconnect disconnect from the currently connected storage dump-heap trigger a heap dump on the VM - find-objects finds objects in a heapdump - find-root finds the shortest path from an object to a GC root + find-objects find objects in a heapdump + find-root find the shortest path from an object to a GC root gc perform Garbage Collection on the given vm kill-vm kill the specified vm - list-agents lists all agents for the current host - list-categories lists all registered categories in Storage + list-agents list all agents + list-categories list all registered categories list-heap-dumps list all heap dumps - list-vms lists all currently monitored VMs - object-info prints information about an object in a heap dump - ping using the Command Channel, send a ping to a running agent - profile-vm profile a target vm - save-heap-dump-to-file saves a heap dump to a local file + list-vms list all known VMs + object-info show information about an object in a heap dump + ping send a ping to a running agent + profile-vm instrument and profile a target vm + save-heap-dump-to-file save a heap dump to a local file + show-gc-name show the configured garbage collector name of a given VM show-heap-histogram show the heap histogram storage-profile profile how fast storage operations are - validate validates a thermostat plug-in XML file against the schema - vm-info shows basic information about a VM + validate validate a thermostat plug-in XML file + vm-info show basic information about a VM vm-stat show various statistics about a VM Thermostat - > exit
--- a/outputtexts/head/thermostat.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,30 +1,31 @@ list of commands: help show help for a given command or help overview - add-mongodb-user adds a new mongodb user to the thermostat DB, reading credentials from standard input - agent starts and stops the thermostat agent - agent-info shows info for specified agent + add-mongodb-user add a new mongodb user to the thermostat DB + agent run the thermostat agent + agent-info show info for an agent clean-data drop all data related to all of the specified agents dump-heap trigger a heap dump on the VM - find-objects finds objects in a heapdump - find-root finds the shortest path from an object to a GC root + find-objects find objects in a heapdump + find-root find the shortest path from an object to a GC root gc perform Garbage Collection on the given vm - gui launches the GUI client + gui launch the GUI client kill-vm kill the specified vm - list-agents lists all agents for the current host - list-categories lists all registered categories in Storage + list-agents list all agents + list-categories list all registered categories list-heap-dumps list all heap dumps - list-vms lists all currently monitored VMs - object-info prints information about an object in a heap dump - ping using the Command Channel, send a ping to a running agent - profile-vm profile a target vm - save-heap-dump-to-file saves a heap dump to a local file - service starts and stops the thermostat storage and agent - shell launches the Thermostat interactive shell + list-vms list all known VMs + object-info show information about an object in a heap dump + ping send a ping to a running agent + profile-vm instrument and profile a target vm + save-heap-dump-to-file save a heap dump to a local file + service run the thermostat storage and agent + shell launch the Thermostat interactive shell + show-gc-name show the configured garbage collector name of a given VM show-heap-histogram show the heap histogram - storage starts and stops the thermostat storage + storage control or view the status of the thermostat storage storage-profile profile how fast storage operations are - validate validates a thermostat plug-in XML file against the schema - vm-info shows basic information about a VM + validate validate a thermostat plug-in XML file + vm-info show basic information about a VM vm-stat show various statistics about a VM - web-storage-service starts mongodb storage, an embedded servlet container with the web archive deployed and then connects an agent to this web endpoint + web-storage-service start mongodb storage, an embedded servlet container and an agent
--- a/outputtexts/head/thermostat_help.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,30 +1,31 @@ list of commands: help show help for a given command or help overview - add-mongodb-user adds a new mongodb user to the thermostat DB, reading credentials from standard input - agent starts and stops the thermostat agent - agent-info shows info for specified agent + add-mongodb-user add a new mongodb user to the thermostat DB + agent run the thermostat agent + agent-info show info for an agent clean-data drop all data related to all of the specified agents dump-heap trigger a heap dump on the VM - find-objects finds objects in a heapdump - find-root finds the shortest path from an object to a GC root + find-objects find objects in a heapdump + find-root find the shortest path from an object to a GC root gc perform Garbage Collection on the given vm - gui launches the GUI client + gui launch the GUI client kill-vm kill the specified vm - list-agents lists all agents for the current host - list-categories lists all registered categories in Storage + list-agents list all agents + list-categories list all registered categories list-heap-dumps list all heap dumps - list-vms lists all currently monitored VMs - object-info prints information about an object in a heap dump - ping using the Command Channel, send a ping to a running agent - profile-vm profile a target vm - save-heap-dump-to-file saves a heap dump to a local file - service starts and stops the thermostat storage and agent - shell launches the Thermostat interactive shell + list-vms list all known VMs + object-info show information about an object in a heap dump + ping send a ping to a running agent + profile-vm instrument and profile a target vm + save-heap-dump-to-file save a heap dump to a local file + service run the thermostat storage and agent + shell launch the Thermostat interactive shell + show-gc-name show the configured garbage collector name of a given VM show-heap-histogram show the heap histogram - storage starts and stops the thermostat storage + storage control or view the status of the thermostat storage storage-profile profile how fast storage operations are - validate validates a thermostat plug-in XML file against the schema - vm-info shows basic information about a VM + validate validate a thermostat plug-in XML file + vm-info show basic information about a VM vm-stat show various statistics about a VM - web-storage-service starts mongodb storage, an embedded servlet container with the web archive deployed and then connects an agent to this web endpoint + web-storage-service start mongodb storage, an embedded servlet container and an agent
--- a/outputtexts/head/thermostat_help_agent.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_agent.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,5 +1,8 @@ usage: thermostat agent [-d <url>] [-s] [-l <level>] - starts and stops the thermostat agent + Run the thermostat agent as a foreground process. The agent is + responsible for gathering various pieces of data from the host + and JVMs. It also performs user-trigged actions on-demand. The + agent will stop when this process exits. thermostat agent -d,--dbUrl <dbUrl> connect to the given URL
--- a/outputtexts/head/thermostat_help_connect.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_connect.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,5 +1,6 @@ usage: thermostat connect -d <url> [-l <level>] - persistently connect to storage + Persistently connect to a storage. This will prompt for + username and password for authentication. Note: this command is only supported inside the shell thermostat connect -d,--dbUrl <dbUrl> connect to the given URL
--- a/outputtexts/head/thermostat_help_disconnect.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_disconnect.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,5 +1,7 @@ usage: thermostat disconnect [-l <level>] - disconnect from the currently used storage + Disconnect from the currently connected storage. Any further + actions that require a connection to the storage will connect + again and prompt for authentication. Note: this command is only supported inside the shell thermostat disconnect --help show usage of command
--- a/outputtexts/head/thermostat_help_dump-heap.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_dump-heap.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,6 +1,6 @@ usage: thermostat dump-heap --vmId <vm> --hostId <host> [--dbUrl <dbUrl>] [--logLevel <logLevel>] - trigger a heap dump on the VM + Trigger a heap dump on the VM. thermostat dump-heap -a,--hostId <host> the ID of the host to monitor
--- a/outputtexts/head/thermostat_help_find-objects.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_find-objects.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,6 +1,6 @@ usage: thermostat find-objects --heapId <heap> [--dbUrl <dbUrl>] [--limit <limit>] [--logLevel <logLevel>] pattern - finds objects in a heapdump + Find objects in a heapdump. thermostat find-objects -d,--dbUrl <dbUrl> connect to the given URL
--- a/outputtexts/head/thermostat_help_find-root.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_find-root.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,6 +1,7 @@ usage: thermostat find-root --objectId <heap> --heapId <heap> [--dbUrl <dbUrl>] [--all] [--logLevel <logLevel>] - finds the shortest path from an object to a GC root + Find the shortest path, or all paths, from an object to a GC + root. thermostat find-root -a,--all finds all paths to GC roots
--- a/outputtexts/head/thermostat_help_gui.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_gui.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,5 +1,6 @@ usage: thermostat gui [-l <level>] - launches the GUI client + Launch the GUI client. The GUI client provides a graphical + interface to all the features. thermostat gui --help show usage of command
--- a/outputtexts/head/thermostat_help_list-heap-dumps.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_list-heap-dumps.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,6 +1,6 @@ usage: thermostat list-heap-dumps [--vmId <vm>] [--dbUrl <dbUrl>] [--hostId <host>] [--logLevel <logLevel>] - list all heap dumps + List all heap dumps. thermostat list-heap-dumps -a,--hostId <host> the ID of the host to monitor
--- a/outputtexts/head/thermostat_help_list-vms.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_list-vms.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,5 +1,6 @@ usage: thermostat list-vms [-d <url>] [-l <level>] - lists all currently monitored VMs + List all known VMs. This includes both alive VMs as well as + (possibly) dead VMs. thermostat list-vms -d,--dbUrl <dbUrl> connect to the given URL
--- a/outputtexts/head/thermostat_help_object-info.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_object-info.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,6 +1,6 @@ usage: thermostat object-info --objectId <object> --heapId <heap> [--dbUrl <dbUrl>] [--logLevel <logLevel>] - prints information about an object in a heap dump + Show information about an object in a heap dump. thermostat object-info -d,--dbUrl <dbUrl> connect to the given URL
--- a/outputtexts/head/thermostat_help_ping.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_ping.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,5 +1,7 @@ usage: thermostat ping <agentId> [-d <url>] [-l <level>] - using the Command Channel, send a ping to a running agent + Send a ping to a running agent. This uses the command channel + and verifies that command-channel-related functionality is + working correctly between the current client and the agent. thermostat ping -d,--dbUrl <dbUrl> connect to the given URL
--- a/outputtexts/head/thermostat_help_save-heap-dump-to-file.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_save-heap-dump-to-file.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,6 +1,6 @@ usage: thermostat save-heap-dump-to-file --file <filename> --heapId <heap> [--dbUrl <dbUrl>] [--logLevel <logLevel>] - saves a heap dump to a local file + Save a heap dump to a local file. thermostat save-heap-dump-to-file -d,--dbUrl <dbUrl> connect to the given URL
--- a/outputtexts/head/thermostat_help_service.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_service.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,5 +1,8 @@ usage: thermostat service [-l <level>] - starts and stops the thermostat storage and agent + Start the thermostat storage and agent as foreground + processes. On exit, shut them both down. This is a convenience + command that is deprecated. It may be removed in a future + release. Use 'web-storage-service' instead. thermostat service --help show usage of command
--- a/outputtexts/head/thermostat_help_shell.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_shell.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,7 +1,12 @@ usage: thermostat shell - launches the Thermostat interactive shell. The prompt displays - a "-" to indicate that it is disconnected or a "+" to indicate - that it is connected to storage + Launch the Thermostat interactive shell. The prompt can be + customized by editing the shell-prompt.conf file located in + $SYSTEM_THERMOSTAT_HOME/etc/plugins.d/shell-command. You can + also create your own shell-prompt.conf file and place it in + $USER_THERMOSTAT_HOME/etc/plugins.d/shell-command. This will + override the properties from the system config file. See the + system shell-prompt.conf file for instructions on how to write + the config file. thermostat shell --help show usage of command
--- a/outputtexts/head/thermostat_help_show-heap-histogram.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_show-heap-histogram.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,6 +1,6 @@ usage: thermostat show-heap-histogram --heapId <heap> [--dbUrl <dbUrl>] [--logLevel <logLevel>] - show the heap histogram + Show the heap histogram for a given heapId. thermostat show-heap-histogram -d,--dbUrl <dbUrl> connect to the given URL
--- a/outputtexts/head/thermostat_help_storage.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_storage.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,6 +1,6 @@ usage: thermostat storage <-start|--stop|--status> [--dryRun] [-q] [--permitLocalhostException] [-l <level>] - starts and stops the thermostat storage + Start, stop or view the status of thermostat storage. thermostat storage -d,--dryRun run the service in dry run mode
--- a/outputtexts/head/thermostat_help_vm-info.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_vm-info.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,5 +1,5 @@ usage: thermostat vm-info [-vmId <vm>] [--hostId <host>] [-d <url>] [-l <level>] - shows basic information about a VM + Show basic information about a VM. thermostat vm-info -a,--hostId <hostId> the ID of the host to monitor
--- a/outputtexts/head/thermostat_help_vm-stat.txt Thu Mar 19 12:54:36 2015 +0100 +++ b/outputtexts/head/thermostat_help_vm-stat.txt Fri Mar 20 17:36:50 2015 +0100 @@ -1,6 +1,8 @@ usage: thermostat vm-stat -hostId <host> --vmId <vm> [-c] [-s <time:timeunit>] [-d <url>] [-l <level>] - show various statistics about a VM + Show various statistics about a VM. This includes cpu and + memory information as well as any additional information + provided by plugins. thermostat vm-stat -a,--hostId <hostId> the ID of the host to monitor