changeset 194:c62d6e63c538

Added message patterns for thermostat 1.4
author Zdenek Zambersky <zzambers@redhat.com>
date Mon, 27 Jul 2015 13:41:51 +0200
parents 5b5131445da5
children 5aa76ad23f06
files outputtexts/1.4/output_of_exit_therm_shell.txt outputtexts/1.4/output_of_help_therm_shell.txt outputtexts/1.4/thermostat.txt outputtexts/1.4/thermostat_help.txt outputtexts/1.4/thermostat_help_agent.txt outputtexts/1.4/thermostat_help_connect.txt outputtexts/1.4/thermostat_help_disconnect.txt outputtexts/1.4/thermostat_help_dump-heap.txt outputtexts/1.4/thermostat_help_find-objects.txt outputtexts/1.4/thermostat_help_find-root.txt outputtexts/1.4/thermostat_help_gui.txt outputtexts/1.4/thermostat_help_list-heap-dumps.txt outputtexts/1.4/thermostat_help_list-vms.txt outputtexts/1.4/thermostat_help_object-info.txt outputtexts/1.4/thermostat_help_ping.txt outputtexts/1.4/thermostat_help_save-heap-dump-to-file.txt outputtexts/1.4/thermostat_help_service.txt outputtexts/1.4/thermostat_help_shell.txt outputtexts/1.4/thermostat_help_show-heap-histogram.txt outputtexts/1.4/thermostat_help_storage.txt outputtexts/1.4/thermostat_help_vm-info.txt outputtexts/1.4/thermostat_help_vm-stat.txt
diffstat 22 files changed, 327 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/output_of_exit_therm_shell.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,3 @@
+Thermostat version 1.3.4
+Thermostat - > exit
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/output_of_help_therm_shell.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,30 @@
+Thermostat version 1.3.4
+Thermostat - > help
+list of commands:
+
+ help                   show help for a given command or help overview
+ 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 connected storage
+ dump-heap              trigger a heap dump on the VM
+ 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            list all agents
+ list-categories        list all registered categories
+ list-heap-dumps        list all heap dumps
+ 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               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
+
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,30 @@
+list of commands:
+
+ help                   show help for a given command or help overview
+ 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           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                    launch the GUI client
+ kill-vm                kill the specified vm
+ list-agents            list all agents
+ list-categories        list all registered categories
+ list-heap-dumps        list all heap dumps
+ 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                control or view the status of the thermostat storage
+ storage-profile        profile how fast storage operations are
+ 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    start mongodb storage, an embedded servlet container and an agent
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,30 @@
+list of commands:
+
+ help                   show help for a given command or help overview
+ 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           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                    launch the GUI client
+ kill-vm                kill the specified vm
+ list-agents            list all agents
+ list-categories        list all registered categories
+ list-heap-dumps        list all heap dumps
+ 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                control or view the status of the thermostat storage
+ storage-profile        profile how fast storage operations are
+ 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    start mongodb storage, an embedded servlet container and an agent
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_agent.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,14 @@
+usage: thermostat agent [-d <url>] [-s] [-l <level>]
+                  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
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
+  -s,--saveOnExit             save the data on exit
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_connect.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,11 @@
+usage: thermostat connect -d <url> [-l <level>]
+                  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
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_disconnect.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,11 @@
+usage: thermostat disconnect [-l <level>]
+                  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
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_dump-heap.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,13 @@
+usage: thermostat dump-heap --hostId <host> --vmId <vm> [--dbUrl <dbUrl>]
+                  [--logLevel <logLevel>]
+                  trigger a heap dump on the VM
+
+thermostat dump-heap
+  -a,--hostId <host>          the ID of the host to monitor
+  -d,--dbUrl <dbUrl>          connect to the given URL
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
+  -v,--vmId <vm>              the ID of the VM to monitor
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_find-objects.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,13 @@
+usage: thermostat find-objects --heapId <heap> [--dbUrl <dbUrl>] [--limit
+                  <limit>] [--logLevel <logLevel>] pattern
+                  Find objects in a heapdump.
+
+thermostat find-objects
+  -d,--dbUrl <dbUrl>          connect to the given URL
+  -h,--heapId <heap>          the ID of the heapdump to analyze
+     --help                   show usage of command
+  -L,--limit <limit>          limit search to top N results, defaults to 10
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_find-root.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,15 @@
+usage: thermostat find-root --heapId <heap> --objectId <heap> [--all] [--dbUrl
+                  <dbUrl>] [--logLevel <logLevel>]
+                  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
+  -d,--dbUrl <dbUrl>          connect to the given URL
+  -h,--heapId <heap>          the ID of the heapdump to analyze
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
+  -o,--objectId <heap>        the ID of the object to query
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_gui.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,10 @@
+usage: thermostat gui [-l <level>]
+                  Launch the GUI client. The GUI client provides a graphical
+                  interface to all the features.
+
+thermostat gui
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_list-heap-dumps.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,13 @@
+usage: thermostat list-heap-dumps [--hostId <host>] [--dbUrl <dbUrl>] [--vmId
+                  <vm>] [--logLevel <logLevel>]
+                  list all heap dumps
+
+thermostat list-heap-dumps
+  -a,--hostId <host>          the ID of the host to monitor
+  -d,--dbUrl <dbUrl>          connect to the given URL
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
+  -v,--vmId <vm>              the ID of the VM to monitor
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_list-vms.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,11 @@
+usage: thermostat list-vms [-d <url>] [-l <level>]
+                  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
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_object-info.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,13 @@
+usage: thermostat object-info --heapId <heap> --objectId <object> [--dbUrl
+                  <dbUrl>] [--logLevel <logLevel>]
+                  Show information about an object in a heap dump.
+
+thermostat object-info
+  -d,--dbUrl <dbUrl>          connect to the given URL
+  -h,--heapId <heap>          the ID of the heapdump to analyze
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
+  -o,--objectId <object>      the ID of the object to query
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_ping.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,12 @@
+usage: thermostat ping <agentId> [-d <url>] [-l <level>]
+                  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
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_save-heap-dump-to-file.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,13 @@
+usage: thermostat save-heap-dump-to-file --file <filename> --heapId <heap>
+                  [--dbUrl <dbUrl>] [--logLevel <logLevel>]
+                  Save a heap dump to a local file.
+
+thermostat save-heap-dump-to-file
+  -d,--dbUrl <dbUrl>          connect to the given URL
+  -f,--file <filename>        the file name to save to
+  -h,--heapId <heap>          the ID of the heapdump to analyze
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_service.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,12 @@
+usage: thermostat service [-l <level>]
+                  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
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_shell.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,12 @@
+usage: thermostat shell
+                  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
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_show-heap-histogram.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,12 @@
+usage: thermostat show-heap-histogram --heapId <heap> [--dbUrl <dbUrl>]
+                  [--logLevel <logLevel>]
+                  Show the heap histogram for a given heapId.
+
+thermostat show-heap-histogram
+  -d,--dbUrl <dbUrl>          connect to the given URL
+  -h,--heapId <heap>          the ID of the heapdump to analyze
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_storage.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,17 @@
+usage: thermostat storage <-start|--stop|--status> [--dryRun] [-q]
+                  [--permitLocalhostException] [-l <level>]
+                  Start, stop or view the status of thermostat storage.
+
+thermostat storage
+  -d,--dryRun                      run the service in dry run mode
+     --help                        show usage of command
+  -l,--logLevel <logLevel>         sets the log level for this invocation.
+                                   Possible values for <logLevel> in decreasing
+                                   severity are: SEVERE, WARNING, INFO, CONFIG,
+                                   FINE, FINER, FINEST and OFF
+     --permitLocalhostException    permit local host connections with no
+                                   credentials
+  -q,--quiet                       don't produce any output
+     --start                       start the database
+     --status                      check if the database is running
+     --stop                        stop the database
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_vm-info.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,12 @@
+usage: thermostat vm-info [-vmId <vm>] [--hostId <host>] [-d <url>] [-l <level>]
+                  Show basic information about a VM.
+
+thermostat vm-info
+  -a,--hostId <hostId>        the ID of the host to monitor
+  -d,--dbUrl <dbUrl>          connect to the given URL
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
+  -v,--vmId <vmId>            the ID of the VM to monitor
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/outputtexts/1.4/thermostat_help_vm-stat.txt	Mon Jul 27 13:41:51 2015 +0200
@@ -0,0 +1,20 @@
+usage: thermostat vm-stat -hostId <host> --vmId <vm> [-c] [-s <time:timeunit>]
+                  [-d <url>] [-l <level>]
+                  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
+  -c,--continuous             print data continuously
+  -d,--dbUrl <dbUrl>          connect to the given URL
+     --help                   show usage of command
+  -l,--logLevel <logLevel>    sets the log level for this invocation. Possible
+                              values for <logLevel> in decreasing severity are:
+                              SEVERE, WARNING, INFO, CONFIG, FINE, FINER, FINEST
+                              and OFF
+  -s,--since <since>          print data since [-s time:timeunits] ago or print
+                              all data [-s all]. Defaults to since 10 minutes
+                              ago [-s 10:minutes] and accepts positive times and
+                              days, hours, minutes, or seconds
+  -v,--vmId <vmId>            the ID of the VM to monitor