GEODE-2778: gfsh help now uses log4j log levels: update user guide This closes #484
Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/b81ebcb1 Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/b81ebcb1 Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/b81ebcb1 Branch: refs/heads/feature/GEM-1353 Commit: b81ebcb194d3b31bcb6afcc4ce2addd6ba049f58 Parents: dc6b600 Author: Dave Barnes <[email protected]> Authored: Fri Apr 28 15:55:50 2017 -0700 Committer: Dave Barnes <[email protected]> Committed: Tue May 2 14:40:36 2017 -0700 ---------------------------------------------------------------------- .../gfsh/command-pages/alter.html.md.erb | 22 ++++++-------------- .../gfsh/command-pages/change.html.md.erb | 18 ++++------------ .../gfsh/command-pages/export.html.md.erb | 2 +- .../gfsh/command-pages/start.html.md.erb | 4 ++-- .../gfsh/configuring_gfsh.html.md.erb | 2 +- 5 files changed, 14 insertions(+), 34 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/b81ebcb1/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb index 4601975..f28c1ce 100644 --- a/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb +++ b/geode-docs/tools_modules/gfsh/command-pages/alter.html.md.erb @@ -445,20 +445,10 @@ alter runtime [--member=value] [--group=value] [--archive-disk-space-limit=value <td>0</td> </tr> <tr class="odd"> -<td><span class="keyword parmname">\-\-log-level </span></td> -<td>Log level. Valid values are: -<ul> -<li><code class="ph codeph">none</code></li> -<li><code class="ph codeph">error</code></li> -<li><code class="ph codeph">info</code></li> -<li><code class="ph codeph">config</code></li> -<li><code class="ph codeph">warning</code></li> -<li><code class="ph codeph">severe</code></li> -<li><code class="ph codeph">fine</code></li> -<li><code class="ph codeph">finer</code></li> -<li><code class="ph codeph">finest</code></li> -</ul></td> -<td>config</td> +<td><span class="keyword parmname">\-\-loglevel </span></td> +<td>The new log level. This option is required and you must specify a value. +Valid values are: `ALL`, `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`, `OFF`. +<td>INFO</td> </tr> <tr class="even"> <td><span class="keyword parmname">\-\-statistic-archive-file </span></td> @@ -508,13 +498,13 @@ alter runtime [--member=value] [--group=value] [--archive-disk-space-limit=value **Example Commands:** ``` pre -alter runtime --member=server1 --log-level=finest --enable-statistics=true +alter runtime --member=server1 --loglevel=WARN --enable-statistics=true ``` **Sample Output:** ``` pre -gfsh>alter runtime --member=server1 --log-level=finest --enable-statistics=true +gfsh>alter runtime --member=server1 --loglevel=WARN --enable-statistics=true Runtime configuration altered successfully for the following member(s) 192.0.2.0(server1:240)<v1>:64871 ``` http://git-wip-us.apache.org/repos/asf/geode/blob/b81ebcb1/geode-docs/tools_modules/gfsh/command-pages/change.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/change.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/change.html.md.erb index 1ea2e0d..8ff5e9b 100644 --- a/geode-docs/tools_modules/gfsh/command-pages/change.html.md.erb +++ b/geode-docs/tools_modules/gfsh/command-pages/change.html.md.erb @@ -60,18 +60,8 @@ change loglevel --loglevel=value [--members=value(nullvalue)*] [--groups=value(n <tr class="odd"> <td><span class="keyword parmname">\-\-loglevel</span></td> <td><em>Required.</em> Log level to change. Valid options are: -<ul> -<li><code class="ph codeph">all</code></li> -<li><code class="ph codeph">finest</code></li> -<li><code class="ph codeph">finer</code></li> -<li><code class="ph codeph">fine</code></li> -<li><code class="ph codeph">config</code></li> -<li><code class="ph codeph">info</code></li> -<li><code class="ph codeph">warning</code></li> -<li><code class="ph codeph">error</code></li> -<li><code class="ph codeph">severe</code></li> -<li><code class="ph codeph">none</code></li> -</ul></td> + `ALL`, `TRACE`, `DEBUG`, `INFO`, `WARN`, `ERROR`, `FATAL`, `OFF`. +</td> <td>Â </td> </tr> </tbody> @@ -82,13 +72,13 @@ change loglevel --loglevel=value [--members=value(nullvalue)*] [--groups=value(n **Example Commands:** ``` pre -gfsh>change loglevel --loglevel=severe --members=server1 +gfsh>change loglevel --loglevel=DEBUG --members=server1 ``` **Sample Output:** ``` pre -gfsh>change loglevel --loglevel=severe --members=server1 +gfsh>change loglevel --loglevel=DEBUG --members=server1 Summary http://git-wip-us.apache.org/repos/asf/geode/blob/b81ebcb1/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb index d8dbb1b..ccf95cc 100644 --- a/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb +++ b/geode-docs/tools_modules/gfsh/command-pages/export.html.md.erb @@ -178,7 +178,7 @@ export logs [--dir=value] [--group=value(,value)*] [--member=value(,value)*] | <span class="keyword parmname">\\-\\-dir</span> | Local directory to which log files will be written when logs are exported using an http connection. Ignored when the command is executed over JMX. | Â | | <span class="keyword parmname">\\-\\-group</span> | Group of members whose log files will be exported. | Â | | <span class="keyword parmname">‑‑member</span> | Name/ID of the member whose log files will be exported. | Â | -| <span class="keyword parmname">\\-\\-log-level</span> | Minimum level of log entries to export. Valid values are: `fatal`, `error`, `warn`, `info`, `debug`, `trace`, and `all`. | `info` | +| <span class="keyword parmname">\\-\\-log-level</span> | Minimum level of log entries to export. Valid values are: `OFF`, `FATAL`, `ERROR`, `WARN`, `INFO`, `DEBUG`, `TRACE`, and `ALL`. | `INFO` | | <span class="keyword parmname">\\-\\-only-log-level</span> | Whether to only include only entries that exactly match the <span class="keyword parmname">\\-\\-log-level</span> specified. | false | | <span class="keyword parmname">‑‑merge‑log</span> | Whether to merge logs after exporting to the target directory (deprecated). | false | | <span class="keyword parmname">\\-\\-start-time</span> | Log entries that occurred after this time will be exported. Format: yyyy/MM/dd/HH/mm/ss/SSS/z OR yyyy/MM/dd | no limit | http://git-wip-us.apache.org/repos/asf/geode/blob/b81ebcb1/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb b/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb index 4cdab79..e2a4edc 100644 --- a/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb +++ b/geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb @@ -329,7 +329,7 @@ start locator --name=value [--bind-address=value] [--force(=value)] [--group=val </tr> <tr class="odd"> <td><span class="keyword parmname">\-\-log-level</span></td> -<td>Level of output logged to the locator log file. Possible values for log-level include: finest, finer, fine, config, info, warning, severe, none.</td> +<td>Level of output logged to the locator log file. Possible values for log-level include: ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF.</td> <td>Â </td> </tr> <tr class="even"> @@ -611,7 +611,7 @@ start server --name=value [--assign-buckets(=value)] [--bind-address=value] </tr> <tr class="even"> <td><span class="keyword parmname">\-\-log-level</span></td> -<td>Sets the level of output logged to the Cache Server log file. Possible values for log-level include: finest, finer, fine, config, info, warning, severe, none.</td> +<td>Sets the level of output logged to the Cache Server log file. Possible values for log-level include: ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF.</td> <td>Â </td> </tr> <tr class="odd"> http://git-wip-us.apache.org/repos/asf/geode/blob/b81ebcb1/geode-docs/tools_modules/gfsh/configuring_gfsh.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/gfsh/configuring_gfsh.html.md.erb b/geode-docs/tools_modules/gfsh/configuring_gfsh.html.md.erb index 3c8d3a7..b112e66 100644 --- a/geode-docs/tools_modules/gfsh/configuring_gfsh.html.md.erb +++ b/geode-docs/tools_modules/gfsh/configuring_gfsh.html.md.erb @@ -58,7 +58,7 @@ See [Useful gfsh Shell Variables](useful_gfsh_shell_variables.html#concept_731EC ## <a id="concept_3B9C6CE2F64841E98C33D9F6441DF487__section_BE7FB8B355E748FA8BEFE75B2C3CB86E" class="no-quick-link"></a>Configuring gfsh Session Logging -By default, `gfsh` session logging is disabled. To enable gfsh logging, you must set the Java system property `-Dgfsh.log-level=desired_log_level `where *desired\_log \_level* is one of the following values: severe, warning, info, config, fine, finer, finest. For example, in Linux: +By default, `gfsh` session logging is disabled. To enable gfsh logging, you must set the Java system property `-Dgfsh.log-level=desired_log_level` where *desired\_log \_level* is one of the following values: severe, warning, info, config, fine, finer, finest. For example, in Linux: ``` pre export JAVA_ARGS=-Dgfsh.log-level=info
