Skip to content

Commit

Permalink
updates to new admin section
Browse files Browse the repository at this point in the history
  • Loading branch information
@PeninaR
PeninaR committed Mar 6, 2018
1 parent 6f44950 commit 871d3ee
Show file tree
Hide file tree
Showing 5 changed files with 279 additions and 20 deletions.
155 changes: 154 additions & 1 deletion site/content/howto/admin-view-event-container-detail.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,160 @@ N/A
{{%/tab%}}

{{%tab "Web Management Console"%}}
TBD

1. In the Spaces view, highlight the Space or Space instance for which you want to see the event container details.
1. Display the Event Container pane in the lower area of the view.

OR
1. In the Processing Units view, click the **Actions **icon for the relevant Event Containers item, and select S**how in Spaces view**.

The following information is displayed:

* For synchronous polling containers (**Polling**):

<table>
<tr>
<th>Item</th>
<th>Description</th>
</tr>
<tr>
<td>Name</td>
<td>Name of the container.</td>
</tr>
<tr>
<td>Transactional</td>
<td>If checked, this container supports transactions.</td>
</tr>
<tr>
<td>Max. Concur. Consumers per Partition</td>
<td>Maximum number of concurrent consumer threads configured for this container.</td>
</tr>
<tr>
<td>Receive Timeout per Partition</td>
<td>Timeout configured for the polling container. </td>
</tr>
<tr>
<td>Receive Handler</td>
<td>Lists the receive operation handler implementations configured for the container. </td>
</tr>
<tr>
<td>Pass Array As Is</td>
<td>If checked, the container supports batch processing.</td>
</tr>
<tr>
<td>Status</td>
<td>Current state of the container.</td>
</tr>
<tr>
<td>Processed</td>
<td>Number of events processed.</td>
</tr>
<tr>
<td>Failed</td>
<td>Number of events that were not processed.</td>
</tr>
<tr>
<td>Consumers</td>
<td>Number of consumer threads currently active.</td>
</tr>
</table>

* For asynchronous polling containers (**Async Polling**):

<table>
<tr>
<th>Item</th>
<th>Description</th>
</tr>
<tr>
<td>Name</td>
<td>Name of the container.</td>
</tr>
<tr>
<td>Transactional</td>
<td>If checked, this container supports transactions.</td>
</tr>
<tr>
<td>Concur. Consumers per Partition</td>
<td>Maximum number of concurrent consumer threads configured for this container.</td>
</tr>
<tr>
<td>Receive Timeout per Partition</td>
<td>Timeout configured for the polling container. </td>
</tr>
<tr>
<td>Status</td>
<td>Current state of the container.</td>
</tr>
<tr>
<td>Processed</td>
<td>Number of events processed.</td>
</tr>
<tr>
<td>Failed</td>
<td>Number of events that were not processed.</td>
</tr>
</table>

* For notify containers (**Notify**):

<table>
<tr>
<th>Item</th>
<th>Description</th>
</tr>
<tr>
<td>Name</td>
<td>Name of the container.</td>
</tr>
<tr>
<td>Transactional</td>
<td>If checked, this container supports transactions.</td>
</tr>
<tr>
<td>Batch Size per Partition</td>
<td>Number of matching objects to accumulate per batch.</td>
</tr>
<tr>
<td>Batch Time per Partition</td>
<td>Maximum wait time between sending batches.</td>
</tr>
<tr>
<td>Comm. Type</td>
<td></td>
</tr>
<tr>
<td>Take On Notify</td>
<td></td>
</tr>
<tr>
<td>FIFO</td>
<td>If checked, the container is configured to run in FIFO mode.</td>
</tr>
<tr>
<td>Notify Operations</td>
<td>List of operations that generate notifications.</td>
</tr>
<tr>
<td>Pass Array As Is</td>
<td>If checked, the container supports batch processing.</td>
</tr>
<tr>
<td>Status</td>
<td>Current state of the container.</td>
</tr>
<tr>
<td>Processed </td>
<td>Number of events processed.</td>
</tr>
<tr>
<td>Failed</td>
<td>Number of events that were not processed.</td>
</tr>
</table>

To view the template for a specific container, double click the required container in the table.

{{%/tab%}}


Expand Down
114 changes: 111 additions & 3 deletions site/content/howto/admin-view-network-details.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,120 @@ N/A
{{%/tab%}}

{{%tab "Web Management Console"%}}
TBD

1. In the Spaces view, highlight the Space or Space instance for which you want to see the network details.
1. Display the Network pane in the lower area of the view.
1. To start receiving information about network activity in the Network pane, check the Enable the **Network Activity Monitoring** check box.
1. You can view the following network information:
* For inbound activity:

<table>
<tr>
<th>Item</th>
<th>Description</th>
</tr>
<tr>
<td>Space Instance Name</td>
<td>Name of the Space instance.</td>
</tr>
<tr>
<td>PID</td>
<td>Process ID of the Space instance.</td>
</tr>
<tr>
<td>Host IP</td>
<td>IP address of the Space instance’s host.</td>
</tr>
<tr>
<td>Receiv. Traffic (MB)</td>
<td>Total amount of received traffic, in MB.</td>
</tr>
<tr>
<td>Generated Traffic (MB)</td>
<td>Total amount of outgoing traffic that was generated due to invocation, in MB.</td>
</tr>
<tr>
<td>Total Traffic (MB)</td>
<td>Total amount of both received and generated traffic, in MB.</td>
</tr>
</table>
* For notification activity:

<table>
<tr>
<th>Item</th>
<th>Description</th>
</tr>
<tr>
<td>GSC</td>
<td>Name of the container.</td>
</tr>
<tr>
<td>PID</td>
<td>Process ID of the container.</td>
</tr>
<tr>
<td>Host IP</td>
<td>IP address of the container’s host.</td>
</tr>
<tr>
<td>Receiv. Traffic (MB)</td>
<td>Total amount of received traffic, in MB.</td>
</tr>
<tr>
<td>Generated Traffic (MB)</td>
<td>Total amount of outgoing traffic that was generated due to invocation, in MB.</td>
</tr>
<tr>
<td>Total Traffic (MB)</td>
<td>Total amount of both received and generated traffic, in MB.</td>
</tr>
<tr>
<td>Invoc. Count</td>
<td>Number of invocations.</td>
</tr>
</table>

1. To view additional information about client connections and network traffic, double click a Space instance in the lower pane. The following information is displayed:

<table>
<tr>
<th>Item</th>
<th>Description</th>
</tr>
<tr>
<td>Name</td>
<td>IP address and Process ID of the connected client, along with a list of the invoked methods.</td>
</tr>
<tr>
<td>Version</td>
<td>Client version.</td>
</tr>
<tr>
<td>Invoc.</td>
<td>For the client, the total number of invocations. For the methods, the individual number of invocations.</td>
</tr>
<tr>
<td>Receiv. </td>
<td>Amount of received traffic, in MB (per client, and per invocation).</td>
</tr>
<tr>
<td>Generated </td>
<td>Amount of outgoing traffic that was generated due to invocation, in MB (per client, and per invocation).</td>
</tr>
<tr>
<td>Total</td>
<td>Total amount of both received and generated traffic for that client, as a percentage of the overall traffic.</td>
</tr>
</table>

{{%/tab%}}


{{%tab "GigaSpaces Management Console"%}}
TBD
{{%tab "GigaSpaces Management Center"%}}

Refer to the [GigaSpaces Management Center](./gigaspaces-management-center.html) topics in the Administration section.

{{%/tab%}}


Expand Down
4 changes: 3 additions & 1 deletion site/content/howto/admin-view-space-info.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ parent: admin-spaces-pu.html
---


{{% bgcolor yellow %}}write intro for this topic{{% /bgcolor %}}
{{% bgcolor yellow %}}write intro for this topic{{% /bgcolor %}}<br>

{{% bgcolor orange %}}**the --replication-stats command _might_ belong here but the rest don't. If the updated CLI doesn't contain parallel commands, you can say as much in the topic. Need to make sure the information is paralleled as much as possible. Where information is NOT parallel, explain in the intro text why you would prefer one tool over another to perform this particular task (and give an example).**{{% /bgcolor %}}

**To view Space information:**

Expand Down
4 changes: 3 additions & 1 deletion site/content/howto/admin-view-space-stats.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ parent: admin-spaces-pu.html
---


{{% bgcolor yellow %}}write intro for this topic{{% /bgcolor %}}
{{% bgcolor yellow %}}write intro for this topic{{% /bgcolor %}}<br>

{{% bgcolor orange %}}**move the "-type-stats" command and explanation to the Viewing Data Types topic**{{% /bgcolor %}}

<br>

Expand Down
22 changes: 8 additions & 14 deletions site/content/xap/12.3/admin/scripts.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ weight: 50
Some of the features described here are part of the open source edition, while others are only available with the commercial (licensed) editions.
{{% /note %}}

The `<XAP root>/bin` folder includes the following scripts that can be used to manage and monitor [GigaSpaces Runtime](./the-runtime-environment.html) components and applications.
The `<XAP root>/bin` folder includes the following scripts that can be used to manage and monitor [GigaSpaces runtime](./the-runtime-environment.html) components and applications.

**Open-Source Scripts**

Expand All @@ -30,11 +30,7 @@ In addition to the scripts described [here](./scripts.html), the `bin` folder co

# Service Grid Scripts

If you need to start the [Service Grid](../overview/the-runtime-environment.html) components manually instead of via the [gs-agent](../overview/the-runtime-environment.html#gsa), use the following scripts.

**Additional Scripts**

The scripts listed below are available in the licensed editions of the GigaSpaces applications.
If you need to start the [Service Grid](../overview/the-runtime-environment.html) components manually instead of via the [gs-agent](../overview/the-runtime-environment.html#gsa), use the following scripts, which are available in the licensed editions of the GigaSpaces applications.

- **gsc** - starts an instance of the [GSC](../overview/the-runtime-environment.html#gsc).
- **gsm** - starts an instance of the [GSM](../overview/the-runtime-environment.html#gsm) and [LUS](../overview/the-runtime-environment.html#lus).
Expand All @@ -44,11 +40,9 @@ The scripts listed below are available in the licensed editions of the GigaSpace

# Processing Units

**Additional Scripts**

The script listed below is available in the licensed editions of the GigaSpaces applications.

- **gs-memcached** - starts standalone, un managed instance of [Memcached API](../dev-java/memcached-api.html) listener.
- **gs-memcached** - starts a standalone, unmanaged instance of [Memcached API](../dev-java/memcached-api.html) listener.

# Misc

Expand All @@ -57,7 +51,7 @@ The scripts listed below are available in the licensed editions of the GigaSpace
- **lookupbrowser** - Used with for special debug scenarios to inspect the lookup service.
- **platform-info** - prints GigaSpaces version info (Use the command line [version](./command-line-interface.html) instead).

This section explains how to start a light version of the GigaSpaces server, which loads a container and one space, using the `space-instance` script. The `space-instance` (which calls [SpaceFinder]({{% api-javadoc %}}/index.html?com/j_spaces/core/client/SpaceFinder.html)) starts by default embedded Reggie and Webster services.
This section explains how to start a light version of the GigaSpaces server, which loads a container and one Space, using the `space-instance` script. The `space-instance` (which calls [SpaceFinder]({{% api-javadoc %}}/index.html?com/j_spaces/core/client/SpaceFinder.html)) starts embedded Reggie and Webster services by default.

# Starting Embedded Mahalo

Expand Down Expand Up @@ -90,7 +84,7 @@ XAP supports space monitoring and management using JMX - The Java Management Ext
{{% /note %}}

{{% note "Note"%}}
When running `space-instance`, the Jini Lookup Service runs implicitly. When having many Jini Lookup Services running across the network, the spaces and clients might be overloaded since they publish themselves into the Lookup Service, or are trying to get updates about newly registered services.
When running `space-instance`, the Jini Lookup Service runs implicitly. When having many Jini Lookup Services running across the network, the Spaces and clients might be overloaded because they publish themselves into the Lookup Service, or are trying to get updates about newly registered services.
A good practice is to have two Lookup Services running using the `lookup-service` command located in the `<XAP Root>\bin` directory, or the GSM command located in the `<XAP Root>\bin` folder. This ensures no single point of failure for the Lookup Service.
{{% /note %}}

Expand All @@ -115,9 +109,9 @@ You can use three arguments. All arguments must be enclosed by quotes (`" "`). I

| Argument | Description |
|:---------|:------------|
| <nobr>Argument 1 <nobr>| Defines a space URL. The value is set into the `SPACE_URL` variable. If no value is passed for this argument, the space URL defined in the `space-instance` script is used. |
| Argument 2 | Defines a path which will be appended to the beginning of the used classpath. The value you define is set into the `APPEND_TO_CLASSPATH_ARG` variable. If no value is passed, the classpath defined in the `space-instance` script is used. |
| Argument 3 | Defines additional command line arguments such as system properties. The value is set into the `APPEND_ADDITIONAL_ARG` variable. |
| <nobr>Argument 1 <nobr>| Defines a Space URL. The value is set into the `SPACE_URL` variable. If no value is passed for this argument, the Space URL defined in the `space-instance` script is used. |
| Argument 2 | Defines a path that will be appended to the beginning of the used classpath. The value you define is set into the `APPEND_TO_CLASSPATH_ARG` variable. If no value is passed, the classpath defined in the `space-instance` script is used. |
| Argument 3 | Defines additional command line arguments, such as system properties. The value is set into the `APPEND_ADDITIONAL_ARG` variable. |

If you are using the third and/or second argument only, **you must use empty quote signs for the argument or arguments that come before the one you are using**. For example:

Expand Down

0 comments on commit 871d3ee

Please sign in to comment.