Skip to content

Commit

Permalink
GEODE-4101: User Guide - document the --redirect-output flag in GFSH …
Browse files Browse the repository at this point in the history 
…commands
  • Loading branch information
@davebarnes97
davebarnes97 committed Mar 1, 2018
1 parent 1c901de commit 291c4e5
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 26 deletions.
57 changes: 31 additions & 26 deletions geode-docs/tools_modules/gfsh/command-pages/start.html.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<a id="topic_3151ACDA3677431BB5059EB7FCB47D87"></a>


Start servers, locators, gateway senders and gateway receivers, and monitoring tools.

Expand Down Expand Up @@ -64,13 +62,13 @@ Note that you can only have one gateway receiver on each member, and unlike a ga
``` pre
start gateway-receiver [--groups=value(,value)*] [--members=value(,value)*]
```
**Parameters, start gateway-receiver**
| Name | Description |
|------------------------------------------------|------------------------------------------------------------------|
| <span class="keyword parmname">\\-\\-members</span> | Name or ID of the member(s) on which to start the Gateway Receiver. |
| <span class="keyword parmname">\\-\\-groups</span> | Group(s) of members on which to start the Gateway Receiver. |
<span class="tablecap">Table 1. Start Gateway-Receiver Parameters</span>
**Example Commands:**
Expand Down Expand Up @@ -116,15 +114,14 @@ Note: By default, gateway senders are configured to start automatically. Manual
``` pre
start gateway-sender --id=value [--groups=value(,value)*] [--members=value(,value)*]
```
**Parameters, start gateway-sender**
| Name | Description |
|------------------------------------------------|-----------------------------------------------------------|
| <span class="keyword parmname">\\-\\-id</span> | *Required.* ID of the GatewaySender. |
| <span class="keyword parmname">\\-\\-groups</span> | Group(s) of members on which to start the Gateway Sender. |
| <span class="keyword parmname">\\-\\-members</span> | Member(s) on which to start the Gateway Sender |
<span class="tablecap">Table 2. Start Gateway-Sender Parameters</span>
**Example Commands:**
``` pre
Expand Down Expand Up @@ -173,15 +170,15 @@ start jconsole [--interval=<seconds>] [--notile] [--version]
[--J<jconsole JVM options>]
```
| Name | Description | Default Value |
|----------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| <span class="keyword parmname">\\-\\-interval</span> | Set the update interval to n seconds (default is 4 seconds). (Equivalent to JConsole's `-interval=n`) | 4 |
| <span class="keyword parmname">\\-\\-notile</span> | Whether to initially tile windows for two or more connections. This parameter is passed as `-notile` to JConsole. | false |
| <span class="keyword parmname">&#8209;&#8209;pluginpath</span> | Directories or JAR files which are searched for JConsole plugins. The path should contain a provider-configuration file named:`META-INF/services/com.sun.tools.jconsole.JConsolePlugin` containing one line for each plugin specifying the fully qualified class name of the class implementing the `com.sun.tools.jconsole.JConsolePlugin` class. |   |
| <span class="keyword parmname">\\-\\-version</span> | Display the JConsole version information. This parameter is passed as `-version` to JConsole. | false |
| <span class="keyword parmname">\\-\\-J</span> | Arguments passed to the JVM on which JConsole runs |   |
**Parameters, start jconsole**
<span class="tablecap">Table 3. Start JConsole Parameters</span>
| Name | Description | Default Value |
|--------------|----------------|---------------|
| <span class="keyword parmname">\\-\\-interval</span> | Set the update interval to n seconds (default is 4 seconds). (Equivalent to JConsole's `-interval=n`) | 4 |
| <span class="keyword parmname">\\-\\-notile</span> | Whether to initially tile windows for two or more connections. This parameter is passed as `-notile` to JConsole. | false |
| <span class="keyword parmname">&#8209;&#8209;pluginpath</span> | Directories or JAR files which are searched for JConsole plugins. The path should contain a provider-configuration file named:`META-INF/services/com.sun.tools.jconsole.JConsolePlugin` containing one line for each plugin specifying the fully qualified class name of the class implementing the `com.sun.tools.jconsole.JConsolePlugin` class. |   |
| <span class="keyword parmname">\\-\\-version</span> | Display the JConsole version information. This parameter is passed as `-version` to JConsole. | false |
| <span class="keyword parmname">\\-\\-J</span> | Arguments passed to the JVM on which JConsole runs |   |
**Example Commands:**
Expand Down Expand Up @@ -234,11 +231,11 @@ Start the JDK's Java VisualVM monitoring application in a separate process.
start jvisualvm [--J=value(,value)*]
```
| Name | Description |
|-------------------------------------------|------------------------------------------------------------------------------------------------|
| <span class="keyword parmname">\\-\\-J</span> | VM-option passed to the spawned CacheServer VM. For example: `-J-Dfoo.bar=true` for setting foo.bar to 'true'. |
**Parameters, start jvisualvm**
<span class="tablecap">Table 4. Start JVisalVM Parameters</span>
| Name | Description |
|------------|-------------|
| <span class="keyword parmname">\\-\\-J</span> | VM-option passed to the spawned CacheServer VM. For example: `-J-Dfoo.bar=true` for setting foo.bar to 'true'. |
**Example Commands:**
Expand Down Expand Up @@ -270,11 +267,13 @@ start locator --name=value [--bind-address=value] [--force(=value)]
[--locators=value] [--log-level=value] [--mcast-address=value] [--mcast-port=value] [--port=value] [--dir=value]
[--properties-file=value] [--security-properties-file=value] [--initial-heap=value] [--max-heap=value]
[--connect(=value)] [--enable-cluster-configuration(=value)] [--load-cluster-configuration-from-dir(=value)]
[--cluster-config-dir=value]
[--cluster-config-dir=value] [--redirect-output(=value)]
[--http-service-port=value] [--http-service-bind-address=value]
[--J=value(,value)*]
```
**Parameters, start locator**
<table>
<colgroup>
<col width="33%" />
Expand Down Expand Up @@ -392,6 +391,11 @@ See <a href="../../../configuring/cluster_config/gfsh_persist.html">Overview of
<td>cluster-config</td>
</tr>
<tr class="even">
<td><span class="keyword parmname">\-\-redirect-output</span></td>
<td>When true, redirect standard out and standard error to the locator log file. If specified without a value, the value is set to true.</td>
<td>false</td>
</tr>
<tr class="even">
<td><span class="keyword parmname">\-\-http-service-port</span></td>
<td>Specifies the HTTP service port.</td>
<td>7070</td>
Expand All @@ -416,8 +420,6 @@ See <a href="../../../configuring/cluster_config/gfsh_persist.html">Overview of
</tbody>
</table>
<span class="tablecap">Table 5. Start Locator Parameters</span>
**Example Commands:**
``` pre
Expand All @@ -438,12 +440,12 @@ For more information on <%=vars.product_name%> Pulse, see [<%=vars.product_name%
start pulse [--url=value]
```
**Parameters, start pulse**
| Name | Description | Default |
|---------------------------------------------|----------------------------------|-------------------------------|
| <span class="keyword parmname">\\-\\-url</span> | URL of the Pulse Web application | `http://localhost:7070/pulse` |
<span class="tablecap">Table 6. Start Pulse Parameters</span>
**Example Commands:**
``` pre
Expand Down Expand Up @@ -480,12 +482,12 @@ start server --name=value [--assign-buckets(=value)] [--bind-address=value]
[--hostname-for-clients=value] [--max-connections=value]
[--message-time-to-live=value] [--max-message-count=value] [--max-threads=value]
[--socket-buffer-size=value] [--lock-memory=value] [--off-heap-memory-size=value]
[--start-rest-api=value]
[--start-rest-api=value] [--redirect-output(=value)]
[--http-service-port=value] [--http-service-bind-address=value]
[--user=value] [--password=value]
```
<a id="topic_3764EE2DB18B4AE4A625E0354471738A__table_at5_bwg_2w"></a>
**Parameters, start server**
<table>
<colgroup>
Expand Down Expand Up @@ -734,6 +736,11 @@ See <a href="../../../configuring/cluster_config/gfsh_persist.html">Overview of
<td>false</td>
</tr>
<tr class="even">
<td><span class="keyword parmname">\-\-redirect-output</span></td>
<td>When true, redirect standard out and standard error to the server log file. If specified without a value, the value is set to true.</td>
<td>false</td>
</tr>
<tr class="even">
<td><span class="keyword parmname">\-\-http-service-port</span></td>
<td>Specifies the HTTP service port.</td>
<td>7070</td>
Expand Down Expand Up @@ -762,8 +769,6 @@ the cluster.
</tbody>
</table>

<span class="tablecap">Table 7. Start Server Parameters</span>


### <a id="topic_3764EE2DB18B4AE4A625E0354471738A__section_A50120613D3C4A848463236C4EFF18C7" class="no-quick-link"></a>Examples

Expand Down
13 changes: 13 additions & 0 deletions geode-docs/tools_modules/gfsh/configuring_gfsh.html.md.erb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,19 @@ gfsh writes several log files for any members that are started via gfsh. Useful
- **&lt;server\_name&gt;.log**. Details a server's configuration (including all gemfire.properties) and all activity that occurs on the server after startup. This log file is written to a directory that is named after the server. For example, if you start a server named server1, the file is written as `server1.log` in the `<product_dir>/server1` directory. If you stop and start the server with an identical name, the older log files are kept in the same directory but renamed for versioning purposes.
- **vf.gf.server.pid**. Contains the process ID of the server. You can use the PID to stop or view the status of this server. This file is written to the same location as the server log file.
## Viewing Standard Out and Standard Error
By default, <%=vars.product_name%> does not show messages written by the application to `stdout` and
`stderr`. To allow these messages to be written to the locator and server log files, respectively,
specify the `--redirect-output` option with the gfsh `start locator` or `start server` commands. For
example, the following command causes `stdout` and `stderr` messages to be written to the
`locator1.log` file:
```
gfsh> start locator --name=locator1 --redirect-output
```
## <a id="concept_3B9C6CE2F64841E98C33D9F6441DF487__section_jcs_ltx_n4" class="no-quick-link"></a>Tab Completion
*This section applies only to UNIX installations.*
Expand Down

0 comments on commit 291c4e5

Please sign in to comment.