Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 8AAC7200CA8 for ; Wed, 31 May 2017 19:01:10 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 88E9C160BE4; Wed, 31 May 2017 17:01:10 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 9428A160BE3 for ; Wed, 31 May 2017 19:01:08 +0200 (CEST) Received: (qmail 31228 invoked by uid 500); 31 May 2017 17:01:07 -0000 Mailing-List: contact commits-help@geode.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@geode.apache.org Delivered-To: mailing list commits@geode.apache.org Received: (qmail 30433 invoked by uid 99); 31 May 2017 17:01:06 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 31 May 2017 17:01:06 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 9EF65E109B; Wed, 31 May 2017 17:01:06 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: klund@apache.org To: commits@geode.apache.org Date: Wed, 31 May 2017 17:01:18 -0000 Message-Id: <965a87cf09744587891878370a743c28@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [13/32] geode git commit: GEODE-2941 Update Pulse documentation archived-at: Wed, 31 May 2017 17:01:10 -0000 GEODE-2941 Update Pulse documentation Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/7b34cfd9 Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/7b34cfd9 Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/7b34cfd9 Branch: refs/heads/feature/GEODE-1279 Commit: 7b34cfd9fd7865ee30f2d1518977b3c7bce294a4 Parents: b7faa08 Author: Dave Barnes Authored: Wed May 24 17:18:58 2017 -0700 Committer: Dave Barnes Committed: Thu May 25 13:29:42 2017 -0700 ---------------------------------------------------------------------- .../source/subnavs/geode-subnav.erb | 13 +- .../cluster_config/gfsh_persist.html.md.erb | 2 +- .../15_minute_quickstart_gfsh.html.md.erb | 2 +- .../management/jmx_manager_node.html.md.erb | 2 +- .../management_system_overview.html.md.erb | 4 +- .../managing/management/mm_overview.html.md.erb | 2 +- geode-docs/tools_modules/book_intro.html.md.erb | 2 +- .../gfsh/command-pages/start.html.md.erb | 4 +- .../lucene_integration.html.md.erb | 2 - .../pulse/chapter_overview.html.md.erb | 49 -- .../tools_modules/pulse/pulse-auth.html.md.erb | 63 ++ .../pulse/pulse-embedded.html.md.erb | 76 ++ .../pulse/pulse-hosted.html.md.erb | 89 ++ .../pulse/pulse-overview.html.md.erb | 49 ++ .../pulse/pulse-requirements.html.md.erb | 34 + .../tools_modules/pulse/pulse-views.html.md.erb | 453 ++++++++++ .../tools_modules/pulse/quickstart.html.md.erb | 827 ------------------- .../pulse/system_requirements.html.md.erb | 35 - .../tools_modules/redis_adapter.html.md.erb | 2 - 19 files changed, 781 insertions(+), 929 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-book/master_middleman/source/subnavs/geode-subnav.erb ---------------------------------------------------------------------- diff --git a/geode-book/master_middleman/source/subnavs/geode-subnav.erb b/geode-book/master_middleman/source/subnavs/geode-subnav.erb index 12b2151..aa0faf4 100644 --- a/geode-book/master_middleman/source/subnavs/geode-subnav.erb +++ b/geode-book/master_middleman/source/subnavs/geode-subnav.erb @@ -2271,19 +2271,22 @@ gfsh
  • - Geode Pulse + Geode Pulse
    • http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb b/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb index 45f73f9..4e21735 100644 --- a/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb +++ b/geode-docs/configuring/cluster_config/gfsh_persist.html.md.erb @@ -91,7 +91,7 @@ There are some configurations that you cannot create using `gfsh`, and that you - `cache-writer` - `compressor` - `serializer` - - `instantiantor` + - `instantiator` - `pdx-serializer` **Note:** http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/getting_started/15_minute_quickstart_gfsh.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/getting_started/15_minute_quickstart_gfsh.html.md.erb b/geode-docs/getting_started/15_minute_quickstart_gfsh.html.md.erb index 894b998..954dcf8 100644 --- a/geode-docs/getting_started/15_minute_quickstart_gfsh.html.md.erb +++ b/geode-docs/getting_started/15_minute_quickstart_gfsh.html.md.erb @@ -73,7 +73,7 @@ If you run `start locator` from gfsh without specifying the member name, gfsh wi ## Step 3: Start Pulse -Start up the browser-based Pulse monitoring tool. Pulse is a Web Application that provides a graphical dashboard for monitoring vital, real-time health and performance of Geode clusters, members, and regions. See [Geode Pulse](../tools_modules/pulse/chapter_overview.html). +Start up the browser-based Pulse monitoring tool. Pulse is a Web Application that provides a graphical dashboard for monitoring vital, real-time health and performance of Geode clusters, members, and regions. See [Geode Pulse](../tools_modules/pulse/pulse-overview.html). ``` pre gfsh>start pulse http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/managing/management/jmx_manager_node.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/jmx_manager_node.html.md.erb b/geode-docs/managing/management/jmx_manager_node.html.md.erb index 97ca066..d002734 100644 --- a/geode-docs/managing/management/jmx_manager_node.html.md.erb +++ b/geode-docs/managing/management/jmx_manager_node.html.md.erb @@ -23,7 +23,7 @@ limitations under the License. Any member can host an embedded JMX Manager, which provides a federated view of all MBeans for the distributed system. The member can be configured to be a manager at startup or anytime during its life by invoking the appropriate API calls on the ManagementService. -You need to have a JMX Manager started in your distributed system in order to use Geode management and monitoring tools such as [gfsh](../../tools_modules/gfsh/chapter_overview.html) and [Geode Pulse](../../tools_modules/pulse/chapter_overview.html). +You need to have a JMX Manager started in your distributed system in order to use Geode management and monitoring tools such as [gfsh](../../tools_modules/gfsh/chapter_overview.html) and [Geode Pulse](../../tools_modules/pulse/pulse-overview.html). **Note:** Each node that acts as the JMX Manager has additional memory requirements depending on the number of resources that it is managing and monitoring. Being a JMX Manager can increase the memory footprint of any process, including locator processes. See [Memory Requirements for Cached Data](../../reference/topics/memory_requirements_for_cache_data.html#calculating_memory_requirements) for more information on calculating memory overhead on your Geode processes. http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/managing/management/management_system_overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/management_system_overview.html.md.erb b/geode-docs/managing/management/management_system_overview.html.md.erb index ecf69f5..13a3de0 100644 --- a/geode-docs/managing/management/management_system_overview.html.md.erb +++ b/geode-docs/managing/management/management_system_overview.html.md.erb @@ -105,8 +105,8 @@ You can also execute gfsh commands using the ManagementService API. See [Executi This section lists the currently available tools for managing and monitoring Geode: - **gfsh**. Apache Geode command-line interface that provides a simple & powerful command shell that supports the administration, debugging and deployment of Geode applications. It features context sensitive help, scripting and the ability to invoke any commands from within the application using a simple API. See [gfsh](../../tools_modules/gfsh/chapter_overview.html). -- **Geode Pulse**. Easy-to-use, browser-based dashboard for monitoring Geode deployments. Geode Pulse provides an integrated view of all Geode members within a distributed system. See [Geode Pulse](../../tools_modules/pulse/chapter_overview.html). -- **Pulse Data Browser**. This Geode Pulse utility provides a graphical interface for performing OQL ad-hoc queries in a Geode distributed system. See [Data Browser](../../tools_modules/pulse/quickstart.html#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__sec_pulsedatabrowser). +- **Geode Pulse**. Easy-to-use, browser-based dashboard for monitoring Geode deployments. Geode Pulse provides an integrated view of all Geode members within a distributed system. See [Geode Pulse](../../tools_modules/pulse/pulse-overview.html). +- **Pulse Data Browser**. This Geode Pulse utility provides a graphical interface for performing OQL ad-hoc queries in a Geode distributed system. See [Data Browser](../../tools_modules/pulse/pulse-views.html#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__sec_pulsedatabrowser). - **Other Java Monitoring Tools such as JConsole and jvisualvm.** JConsole is a JMX-based management and monitoring tool provided in the Java 2 Platform that provides information on the performance and consumption of resources by Java applications. See [http://docs.oracle.com/javase/6/docs/technotes/guides/management/jconsole.html](http://docs.oracle.com/javase/6/docs/technotes/guides/management/jconsole.html). **Java VisualVM (jvisualvm)** is a profiling tool for analyzing your Java Virtual Machine. Java VisualVM is useful to Java application developers to troubleshoot applications and to monitor and improve the applications' performance. Java VisualVM can allow developers to generate and analyse heap dumps, track down memory leaks, perform and monitor garbage collection, and perform lightweight memory and CPU profiling. For more details on using jvisualvm, see [http://docs.oracle.com/javase/6/docs/technotes/tools/share/jvisualvm.html](http://docs.oracle.com/javase/6/docs/technot es/tools/share/jvisualvm.html). http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/managing/management/mm_overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/mm_overview.html.md.erb b/geode-docs/managing/management/mm_overview.html.md.erb index 89a8df5..21967cb 100644 --- a/geode-docs/managing/management/mm_overview.html.md.erb +++ b/geode-docs/managing/management/mm_overview.html.md.erb @@ -85,7 +85,7 @@ Geode Pulse is a Web Application that provides a graphical dashboard for monitor Use Pulse to examine total memory, CPU, and disk space used by members, uptime statistics, client connections, and critical notifications. Pulse communicates with a Geode JMX manager to provide a complete view of your Geode deployment. -See [Geode Pulse](../../tools_modules/pulse/chapter_overview.html). +See [Geode Pulse](../../tools_modules/pulse/pulse-overview.html). ## JConsole http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/tools_modules/book_intro.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/book_intro.html.md.erb b/geode-docs/tools_modules/book_intro.html.md.erb index e7390c5..2bf0930 100644 --- a/geode-docs/tools_modules/book_intro.html.md.erb +++ b/geode-docs/tools_modules/book_intro.html.md.erb @@ -35,7 +35,7 @@ limitations under the License. The Apache Geode HTTP Session Management modules provide fast, scalable, and reliable session replication for HTTP servers without requiring application changes. -- **[Geode Pulse](pulse/chapter_overview.html)** +- **[Geode Pulse](pulse/pulse-overview.html)** Geode Pulse is a Web Application that provides a graphical dashboard for monitoring vital, real-time health and performance of Geode clusters, members, and regions. http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/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 e2a4edc..0bec322 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 @@ -458,7 +458,7 @@ Cluster configuration service is up and running. Launch the Geode Pulse monitoring dashboard tool in the user's default system browser and navigates the user to the landing page (login page). -For more information on Geode Pulse, see [Geode Pulse](../../pulse/chapter_overview.html). +For more information on Geode Pulse, see [Geode Pulse](../../pulse/pulse-overview.html). **Availability:** Online or offline. @@ -483,7 +483,7 @@ start pulse start pulse --url=http://gemfire.example.com:7070/pulse ``` -**Sample Output:** See [Geode Pulse](../../pulse/chapter_overview.html) for examples of Pulse. +**Sample Output:** See [Geode Pulse](../../pulse/pulse-overview.html) for examples of Pulse. ## start server http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/tools_modules/lucene_integration.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/lucene_integration.html.md.erb b/geode-docs/tools_modules/lucene_integration.html.md.erb index b83705b..7f5afdc 100644 --- a/geode-docs/tools_modules/lucene_integration.html.md.erb +++ b/geode-docs/tools_modules/lucene_integration.html.md.erb @@ -1,8 +1,6 @@ --- title: Apache Lucene® Integration --- - - - -Geode Pulse is a Web Application that provides a graphical dashboard for monitoring vital, real-time health and performance of Geode clusters, members, and regions. - -Use Pulse to examine total memory, CPU, and disk space used by members, uptime statistics, client connections, WAN connections, and critical notifications. Pulse communicates with a Geode JMX manager to provide a complete view of your Geode deployment. You can drill down from a high-level cluster view to examine individual members and even regions within a member, to filter the type of information and level of detail. - -By default, Geode Pulse runs in an embedded container within a Geode JMX manager node. You can optionally deploy Pulse to a Web application server of your choice, so that the tool runs independently of your Geode clusters. Hosting Pulse on an application server also enables you to use SSL for accessing the application. - -- **[Pulse System Requirements](system_requirements.html)** - - Verify that your system meets the installation and runtime requirements for GemFire Pulse. - - -- **[Pulse Quick Start (Embedded Mode)](quickstart.html#topic_523F6DE33FE54307BBE8F83BB7D9355D)** - - Use Pulse in embedded mode to monitor a Geode deployment directly from a Geode JMX Manager. By default, the embedded Pulse application connects to the local JMX Manager that hosts the Pulse application. Optionally, configure Pulse to connect to a Geode system of your choice. - -- **[Hosting Pulse on a Web Application Server](quickstart.html#topic_795C97B46B9843528961A094EE520782)** - - Host Pulse on a dedicated Web application server to make the Pulse application available at a consistent address, or to use SSL for accessing the Pulse application. When you host Pulse in this way, you also configure Pulse to connect to a specific locator or JMX Manager node for monitoring. - -- **[Configuring Pulse Authentication](quickstart.html#topic_AC9FFAA6FB044279BAED7A3E099E07AC)** - - Pulse requires all users to authenticate themselves before they can use the Pulse Web application. If you have configured JMX authentication on the Geode JMX Manager node, the Pulse Web application itself may also need to authenticate itself to the Geode JMX Manager node on startup. - -- **[Using Pulse Views](quickstart.html#topic_F0ECE9E8179541CCA3D6C5F4FBA84404)** - - Pulse provides a variety of different views to help you monitor Geode clusters, members, and regions. - - http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/tools_modules/pulse/pulse-auth.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/pulse/pulse-auth.html.md.erb b/geode-docs/tools_modules/pulse/pulse-auth.html.md.erb new file mode 100644 index 0000000..d834592 --- /dev/null +++ b/geode-docs/tools_modules/pulse/pulse-auth.html.md.erb @@ -0,0 +1,63 @@ +--- +title: Configuring Pulse Authentication +--- + + + +Pulse requires all users to authenticate themselves before they can use the Pulse Web application. + +If you run Pulse in embedded mode, the Pulse application runs on the JMX Manager node and no JMX authentication is required. You do not need to specify valid JMX credentials to start an embedded Pulse application. + +If you host Pulse on a Web Application server (non-embedded mode) and you configure JMX authentication on the Geode manager node, then the Pulse Web application must authenticate itself with the manager node when it starts. Specify the credentials of a valid JMX user account in the `pulse.properties` file, as described in [Hosting Pulse on a Web Application Server](pulse-hosted.html). + +**Note:** +The credentials that you specify must have both read and write privileges in the JMX Manager node. See [Configuring a JMX Manager](../../managing/management/jmx_manager_operations.html#topic_263072624B8D4CDBAD18B82E07AA44B6). + +# Configuring Pulse to Use HTTPS + +You can configure Pulse to use HTTPS in either embedded or non-embedded mode. + +In non-embedded mode where you are running Pulse on a standalone Web application server, you must use the Web server's SSL configuration to make the HTTP requests secure. + +In embedded mode, Geode uses an embedded Jetty server to host the +Pulse Web application. To make the embedded server use HTTPS, you must +enable the `http` SSL component in +`gemfire.properties` or `gfsecurity-properties`. +See [SSL](../../managing/security/ssl_overview.html) for details on configuring these parameters. + +These SSL parameters apply to all HTTP services hosted on the JMX Manager, which includes the following: + +- Developer REST API service +- Management REST API service (for remote cluster management) +- Pulse monitoring tool + +When the `http` SSL component is enabled, all HTTP services become +SSL-enabled and you must configure your client applications +accordingly. For SSL-enabled Pulse, you will need to configure your +browsers with proper certificates. + +If a JMX manager or locator is configured to use SSL, you can configure Pulse to connect to these +processes. Create a file named `pulsesecurity.properties` and save it somewhere in the classpath of +your Web application server. Include standard Java SSL properties, such as: + +``` +javax.net.ssl.keyStore={KeyStorePath} +javax.net.ssl.keyStorePassword={KeyStorePassword} +javax.net.ssl.trustStore={TrustStorePath} +javax.net.ssl.trustStorePassword={TrustStorePassword} +``` http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/tools_modules/pulse/pulse-embedded.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/pulse/pulse-embedded.html.md.erb b/geode-docs/tools_modules/pulse/pulse-embedded.html.md.erb new file mode 100644 index 0000000..955e554 --- /dev/null +++ b/geode-docs/tools_modules/pulse/pulse-embedded.html.md.erb @@ -0,0 +1,76 @@ +--- +title: Running Pulse in Embedded Mode (Quick Start) +--- + + + +Use Pulse in embedded mode to monitor a Geode deployment directly from a Geode JMX Manager. By +default, the embedded Pulse application connects to the local JMX Manager that hosts the Pulse +application. Optionally, configure Pulse to connect to a Geode system of your choice. + +To run Pulse in embedded mode: + +1. Configure a Geode member to run as a JMX Manager node, specifying the HTTP port on which you +will access the Pulse Web application (port 7070 by default). For example, the following command +starts a Geode locator as a JMX Manager node, using the default HTTP port 7070 for the Pulse +application: + + ``` pre + gfsh + gfsh> start locator --name=loc1 + ``` + + **Note:** + Geode locators become JMX Manager nodes by default. To start a non-locator member as a JMX + Manager node, include the `--J=-Dgemfire.jmx-manager=true` option. To specify a non-default port + number for the HTTP service that hosts the Pulse application, include the + `--J=-Dgemfire.http-service-port=port_number` option when starting the JMX Manager node. + + When the JMX Manager node boots, it starts an embedded Jetty instance and deploys the Pulse Web + application at the specified or default HTTP port or 7070 by default. + + `gfsh` automatically connects to the manager when you start it in this way. If you already + started a manager process earlier, use the `connect` command in `gfsh` to connect to that + process. + +2. Access the embedded Pulse application from a Web browser. If you are connected to the Geode +cluster using gfsh, use the `start pulse` command to load the correct URL in your browser: + + ``` pre + gfsh> start pulse + ``` + + Or, enter the URL http://*address*:*http-service-port*/pulse directly in your Web browser, + substituting the address and HTTP port of the manager. For example, you access Pulse on the + local locator machine from Step 1 at the URL http://localhost:7070/pulse. + +3. If you have configured authentication for the Pulse application, enter the username and password +of a valid Pulse account in the login screen. Otherwise, enter the default "admin" in both +fields. Click **Sign In** to continue. + + See [Configuring Pulse Authentication](pulse-auth.html). + +4. After you log in, Pulse displays the main cluster view for the local distributed system. See +[Using Pulse Views](pulse-views.html). + +**Note:** +When running in embedded mode, the Pulse application connects only to the JMX Manager running in the +locator or member that hosts Pulse. This enables you to monitor all members of that distributed +system. You can also view (but not monitor) connected WAN clusters, and can view gateway senders and +receivers that are configured in the local cluster. + http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/tools_modules/pulse/pulse-hosted.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/pulse/pulse-hosted.html.md.erb b/geode-docs/tools_modules/pulse/pulse-hosted.html.md.erb new file mode 100644 index 0000000..ceed530 --- /dev/null +++ b/geode-docs/tools_modules/pulse/pulse-hosted.html.md.erb @@ -0,0 +1,89 @@ +--- +title: Hosting Pulse on a Web Application Server +--- + + + +Host Pulse on a dedicated Web application server to make the Pulse application available at a consistent address, or to use SSL for accessing the Pulse application. When you host Pulse in this way, you also configure Pulse to connect to a specific locator or JMX Manager node for monitoring. + +To host Pulse on a Web application server: + +1. Set the `http-service-port` property to zero (`-Dgemfire.http-service-port=0`) when you start your Geode JMX Manager nodes. Setting this property to zero disables the embedded Web server for hosting the Pulse application. +2. Create a `pulse.properties` file somewhere in the classpath of your Web application server. For example, if you are hosting Pulse on Tomcat, create the `pulse.properties` file in the `$TOMCAT_SERVER/lib` directory. + +3. Define the following configuration properties in the `pulse.properties` file: + + + + + + + + + + + + + + + + + + + + + + + + + + +
    PropertyDescription
    pulse.useLocatorSpecify "true" to configure Pulse to connect to a Geode Locator member, or "false" to connect directly to a JMX Manager. +

    When Pulse connects to a Geode locator, the locator provides the address and port of an available JMX Manager to use for monitoring the distributed system. In most production deployments, you should connect Pulse to a locator instance; this allows Pulse to provide monitoring services using any available JMX Manager.

    +

    If you specify "false," Pulse connects directly to a specific JMX Manager. If this manager is not available, the Pulse connection fails, even if another JMX Manager is available in the distributed system.

    pulse.hostSpecify the DNS name or IP address of the Geode locator or JMX Manager machine to which Pulse should connect. You specify either a locator or JMX Manager address depending on how you configured the pulse.useLocator property.
    pulse.portSpecify the port number of the Geode locator or the HTTP port number of the JMX Manager to which Pulse should connect. You specify either a locator or JMX Manager port depending on how you configured the pulse.useLocator property. +

    If you configured pulse.useLocator=false, then pulse.port must correspond to the http-service-port setting of the JMX Manager.

    + + For example, with this configuration Pulse connects to the locator at mylocator\[10334\] and accesses any available JMX Manager: + + ``` pre + pulse.useLocator=true + pulse.host=locsrv.gemstone.com + pulse.port=10334 + ``` + + With this configuration Pulse accesses only the JMX Manager instance at manager1\[8080\]: + + ``` pre + pulse.useLocator=false + pulse.host=jmxsrv.gemstone.com + pulse.port=8080 + ``` + +4. (Optional.) Configure authentication for the Pulse Web application using the instructions in [Configuring Pulse Authentication](pulse-auth.html). + +5. Deploy the Pulse Web application to your application server. Geode installs the `pulse.war` file in the `tools/Pulse` subdirectory of your Geode installation directory. Depending on your application server, you may need to copy the `pulse.war` file to a deployment directory or use a configuration tool to deploy the file. +6. Access the Pulse application using the address, port, and application URL that you configure in your Web application server. For example, with Tomcat the default URL is http://*address*:8080/pulse. Your application server provides options for configuring the address, port, and application name; substitute the correct items to access the deployed Pulse application. + + Pulse connects to the locator or JMX Manager that you configured in the `pulse.properties` file, authenticating using the credentials that you configured in the file. + +7. If you have configured authentication for the Pulse application, enter the username and password of a valid Pulse account in the login screen. Otherwise, enter the default "admin" in both fields. Click **Sign In** to continue. + + See [Configuring Pulse Authentication](pulse-auth.html). + +8. After you log in, Pulse displays the main cluster view for the distributed system to which it has connected. See [Using Pulse Views](pulse-views.html). + http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/tools_modules/pulse/pulse-overview.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/pulse/pulse-overview.html.md.erb b/geode-docs/tools_modules/pulse/pulse-overview.html.md.erb new file mode 100644 index 0000000..ec723d2 --- /dev/null +++ b/geode-docs/tools_modules/pulse/pulse-overview.html.md.erb @@ -0,0 +1,49 @@ +--- +title: Geode Pulse +--- + + + +Geode Pulse is a Web Application that provides a graphical dashboard for monitoring vital, real-time health and performance of Geode clusters, members, and regions. + +Use Pulse to examine total memory, CPU, and disk space used by members, uptime statistics, client connections, WAN connections, and critical notifications. Pulse communicates with a Geode JMX manager to provide a complete view of your Geode deployment. You can drill down from a high-level cluster view to examine individual members and even regions within a member, to filter the type of information and level of detail. + +By default, Geode Pulse runs in an embedded container within a Geode JMX manager node. You can optionally deploy Pulse to a Web application server of your choice, so that the tool runs independently of your Geode clusters. Hosting Pulse on an application server also enables you to use SSL for accessing the application. + +- **[Pulse System Requirements](pulse-requirements.html)** + + Verify that your system meets the installation and runtime requirements for GemFire Pulse. + + +- **[Running Pulse in Embedded Mode (Quick Start)](pulse-embedded.html)** + + Use Pulse in embedded mode to monitor a Geode deployment directly from a Geode JMX Manager. By default, the embedded Pulse application connects to the local JMX Manager that hosts the Pulse application. Optionally, configure Pulse to connect to a Geode system of your choice. + +- **[Hosting Pulse on a Web Application Server](pulse-hosted.html)** + + Host Pulse on a dedicated Web application server to make the Pulse application available at a consistent address, or to use SSL for accessing the Pulse application. When you host Pulse in this way, you also configure Pulse to connect to a specific locator or JMX Manager node for monitoring. + +- **[Configuring Pulse Authentication](pulse-auth.html)** + + Pulse requires all users to authenticate themselves before they can use the Pulse Web application. If you have configured JMX authentication on the Geode JMX Manager node, the Pulse Web application itself may also need to authenticate itself to the Geode JMX Manager node on startup. + +- **[Using Pulse Views](pulse-views.html)** + + Pulse provides a variety of different views to help you monitor Geode clusters, members, and regions. + + http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/tools_modules/pulse/pulse-requirements.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/pulse/pulse-requirements.html.md.erb b/geode-docs/tools_modules/pulse/pulse-requirements.html.md.erb new file mode 100644 index 0000000..1163983 --- /dev/null +++ b/geode-docs/tools_modules/pulse/pulse-requirements.html.md.erb @@ -0,0 +1,34 @@ +--- +title: Pulse System Requirements +--- + + + +Verify that your system meets the installation and runtime requirements for Pulse. + +The Pulse Web application has been tested for compatibility with the following Web browsers: + +- Internet Explorer 9.0.8112.16421 +- Safari 5.1.7 for Windows +- Google Chrome 22.0.1229.79 m +- Mozilla Firefox 16.0.1 + +Pulse has been tested for standalone deployment on Tomcat and Jetty. +Pulse may work with other operating systems and browsers upon which it has not been tested. + + http://git-wip-us.apache.org/repos/asf/geode/blob/7b34cfd9/geode-docs/tools_modules/pulse/pulse-views.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/tools_modules/pulse/pulse-views.html.md.erb b/geode-docs/tools_modules/pulse/pulse-views.html.md.erb new file mode 100644 index 0000000..d3bb367 --- /dev/null +++ b/geode-docs/tools_modules/pulse/pulse-views.html.md.erb @@ -0,0 +1,453 @@ +--- +title: Using Pulse Views +--- + + + +Pulse provides a variety of different views to help you monitor Geode clusters, members, and regions. + +The following sections provide an overview of the main Pulse views: + +- [Cluster View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_9794B5754E474E10ABFBCD8B1DA240F8) +- [Member View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_3629814A3DF64D31A190495782DB0DBF) +- [Region View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_D151776BAC8B4704A71F37F8B5CE063D) +- [Data Browser](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__sec_pulsedatabrowser) +- [Alerts Widget](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_bfk_sc3_wn) + +# Cluster View + +The cluster view is a high-level overview of the Geode distributed system. It is displayed immediately after you log into Pulse. Information displays around the perimeter of the cluster view show statistics such as memory usage, JVM pauses, and throughput. You can use the cluster view to drill down into details for individual members and regions in the distributed system. + + + +Use these basic controls while in Cluster view: + +1. Click Members or Data to display information about Geode members or data regions in the distributed system. +2. Click the display icons to display the Geode members using icon view, block view, or table view. Note that icon view is available only when displaying Members. + + For example, the following shows Geode Members displayed in table view: + + + - While in block view or table view, click the name of a Geode member to display additional information in the [Member View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_3629814A3DF64D31A190495782DB0DBF). + - Click Topology, Server Groups, or Redundancy Zones to filter the view based on all members in the topology, configured server groups, or configured redundancy zones. + The following shows Geode Regions displayed in table view: + + - While in block view or table view, click the name of a Geode region to display additional information in the [Region View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_D151776BAC8B4704A71F37F8B5CE063D). + +3. While in icon view, click a host machine icon to display the Geode members on that machine. +4. In the Alerts pane, click the severity tabs to filter the message display by the level of severity. + +**Cluster View Screen Components** + +The following table describes the data pieces displayed on the Cluster View screen. + + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Screen ComponentDescription
    Cluster StatusOverall status of the distributed system being monitored. Possible statuses include Normal, Warning, or Severe.
    Total HeapTotal amount of memory (in GB) allocated to the Java heap across all members.
    MembersTotal number of members in the cluster.
    ServersTotal number of servers in the cluster.
    ClientsTotal number of clients in the cluster.
    LocatorsTotal number of locators in the cluster.
    RegionsTotal number of regions in the cluster.
    FunctionsTotal number of functions registered in the cluster.
    Unique CQsTotal number of unique CQs. Corresponds to the UNIQUE _CQ_QUERY statistic.
    SubscriptionsTotal number of client event subscriptions.
    Cluster MembersGraphical, block, or table view of the members in the cluster.
    TopologyOrganizes cluster members by DistributedMember Id.
    Server GroupsOrganizes cluster members by server group membership. If no server groups are configured, all members appear under the "Default" server group.
    Redundancy ZonesOrganizes cluster members by redundancy zones. If no redundancy zones are configured, all members appear under the "Default" zone.
    Host MachineWhen you mouse over a machine icon in Topology View, a pop-up appears with the following machine statistics: +
      +
    • CPU Usage. Percentage of CPU being used by Geode processes on the machine.
      • +
    • Memory Usage. Amount of memory (in MB) being used by Geode processes.
      • +
    • Load Avg. Average number of threads on the host machine that are in the run queue or are waiting for disk I/O over the last minutes. Corresponds to the Linux System statistic loadAverage1. If the load average is not available, a negative value is shown.
      • +
    • Sockets. Number of sockets currently open on the machine.
      • +
    MemberWhen you mouse over a member icon in Graphical View, a pop-up appears with the following member statistics: +
      +
    • CPU Usage. Percentage of CPU being used by the Geode member process.
      • +
    • Threads. Number of threads running on the member.
      • +
    • JVM Pauses. Number of times the JVM used by the member process has paused due to garbage collection or excessive CPU usage.
      • +
    • Regions. Number of regions hosted on the member process.
      • +
    • Clients. Number of client currently connected to the member process.
      • +
    • Gateway Sender. Number of gateway senders configured on the member.
      • +
    • Port. Server port of the cache server member where clients can connect and perform cache operations.
      • +
    • GemFire Version. The version of the Geode member.
      • +
    MemberIn List View, the following data fields are displayed for each member: +
      +
    • ID. DistributedMember Id of the member.
      • +
    • Name. Name of the member.
      • +
    • Host. Hostname or IP address where the member is running.
      • +
    • Heap Usage. Amount of JVM heap memory being used by the member process.
      • +
    • CPU Usage. Percentage of CPU being used by the Geode member process.
      • +
    • Uptime. How long the member has been up and running.
      • +
    • Clients. Number of clients currently connected to the member. It will have a value only if the member acts as a CacheServer.
      • +
    Key StatisticsDisplays a few key performance measurements of the distributed system (over the last 15 minutes).
    Write/SecNumber of write operations per second that have occurred across the cluster. Each put/putAll operation counts as a write; for example, a putAll of 50 entries is counted as one write.
    Read/SecNumber of read operations per second that have occurred across the cluster.
    Queries/SecNumber of queries per second that have been executed across the cluster.
    No. of JVM PausesNumber of times the JVM has paused during the last five minutes to perform garbage collection.
    WAN InformationIf you have configured gateway senders or receivers for a multi-site (WAN) deployment, this box displays whether the remote cluster is reachable (working connectivity represented by a green triangle).
    Disk ThroughputTotal disk throughput for all disks in cluster.
    Alerts ViewDisplays alerts for the cluster.
    + +# Member View + +When you select an individual Geode member in Cluster View, Pulse displays the regions available on that member, as well as member-specific information such as the configured listen ports. + + + +Use these basic controls while in Member View: + +1. Click the display icons to display regions using block view or table view. +2. Use the drop down menu to select a specific member or search for specific members by name. +3. Click **Cluster View** to return to Cluster View. See [Cluster View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_9794B5754E474E10ABFBCD8B1DA240F8). +4. Click **Data Browser** to query region data. See [Data Browser](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__sec_pulsedatabrowser). + +**Member View Screen Components** + +The following table describes the data elements displayed on the Member View screen. + + ++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    Screen ComponentDescription
    Member StatusOverall status of the member being monitored. Possible statuses include Normal, Warning, or Severe.
    RegionsTotal number of regions hosted on the member.
    ThreadsTotal number of threads being executed on the member.
    SocketsTotal number of sockets currently open on the member.
    Load Avg.Average number of threads on the member that are in the run queue or are waiting for disk I/O over the last minute. Corresponds to the Linux System statistic loadAverage1. If the load average is not available, a negative value is shown.
    ClientsCurrent number of client connections to the member.
    Member RegionsBlock or table view of the regions hosted on the member.
    RegionsWhen you mouse over a region in block view, a pop-up appears with the following data fields: +
      +
    • Name. Region name.
      • +
    • Type. For example, REPLICATE, PARTITION.
      • +
    • EntryCount. Number of entries in the region.
      • +
    • EntrySize. The aggregate entry size (in bytes) of all entries. For replicated regions this field will only provide a value if the eviction algorithm has been set to EvictionAlgorithm#LRU_ MEMORY. All partition regions will have this value. However, the value includes redundant entries and will also count the size of all the secondary entries on the node.
      • +
    RegionsIn table view, the following fields are listed for each region: +
      +
    • Name. Region name.
      • +
    • Type. For example, REPLICATE, PARTITION.
      • +
    • EntryCount. Number of entries in the region.
      • +
    • EntrySize. The aggregate entry size (in bytes) of all entries. For replicated regions this field will only provide a value if the eviction algorithm has been set to EvictionAlgorithm#LRU_ MEMORY. All partition regions will have this value. However, the value includes redundant entries and will also count the size of all the secondary entries on the node.
      • +
    • Scope. Scope configured for the region.
      • +
    • Disk Store Name. Name of disk stores (if any) associated with the region.
      • +
    • Disk Synchronous. True if writes to disk are set to synchronous and false if not. This field reflects the configured disk-synchronous region attribute.
      • +
    • Gateway Enabled. Whether gateway sender and receiver configurations have been defined on members hosting this region.
      • +
    Member ClientsIn table view, the following fields are listed for each client: +
      +
    • Id. DistributedMember ID of the client process.
      • +
    • Name. Name of the client process.
      • +
    • Host. Hostname or IP address of the client process.
      • +
    • Connected. Whether the client process is currently connected to the member.
      • +
    • Queue Size. The size of the queue used by server to send events in case of a subscription enabled client or a client that has continuous queries running on the server.
      • +
    • CPU Usage. Percentage of CPU being used by the client process.
      • +
    • Uptime. Amount of time the client process has been running.
      • +
    • Threads. Threads being used by the member clients
      • +
    • Gets. Total number of successful get requests completed.
      • +
    • Puts. Total number of successful put requests completed.
      • +
    Key StatisticsDisplays a few key performance measurements for the member (over the last 15 minutes).
    % CPU UsagePercentage of CPU used by the member.
    Read/SecNumber of read operations per second that have occurred on the member.
    Write/SecNumber of write operations per second that have occurred on the member. Each put/putAll operation counts as a write; for example, a putAll of 50 entries is counted as one write.
    Memory UsageTotal memory used on the member in MB.
    No. of JVM PausesNumber of times the JVM has paused during the last five minutes due to garbage collection or excessive CPU usage.
    WAN InformationDisplays cluster information. This dialog box only appears if you have configured WAN functionality (gateway senders and gateway receivers).
    Disk ThroughputRate of disk writes on the member.
    + +# Region View + +The Pulse Region View provides a comprehensive overview of all regions in the Geode distributed system: + + + +Use these basic controls while in Region View: + +1. Click the display icons to display all members that host the region using block view or table view. + + (Click the name of a member to change to that member's [Member View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_3629814A3DF64D31A190495782DB0DBF).) + +2. Search for specific members that host the current region. +3. Hover over a member name to display information such as the region entry count, entry size, and throughput on that member. +4. Click [Cluster View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_9794B5754E474E10ABFBCD8B1DA240F8) or [Data Browser](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__sec_pulsedatabrowser) to go to those screens. + +**Region View Screen Components** + +The following table describes the data elements displayed on the Region View screen. + + ++++ + + + + + + + + + + + + + + + + + + + + + + + + +
    Screen ComponentDescription
    Region MembersLists information about Geode members that host the region, either in block view or table view.
    Region Member (Detail View)When you hover over a region member in block view, a pop-up appears with the following data fields: +
      +
    • Member Name. The name of the Geode member hosting the region.
      • +
    • EntryCount. Number of entries for the region on that member.
      • +
    • EntrySize. The aggregate entry size (in bytes) of all entries on that member. For replicated regions this field will only provide a value if the eviction algorithm has been set to EvictionAlgorithm#LRU_ MEMORY. All partition regions will have this value. However, the value includes redundant entries and will also count the size of all the secondary entries on the node.
      • +
    • Accessor. Indicates whether the member is an accessor member.
      • +
    • Reads/Writes. Summary of reads and writes served from memory and from disk stores over the last 15 minutes.
      • +
    Region Member (Table View)In table view, the following fields are listed for each region member: +
      +
    • ID. The unique member ID.
      • +
    • Name. Region name.
      • +
    • Host. Member hostname.
      • +
    • Heap Usage. The total amount of heap used on the member in MB.
      • +
    • CPU Usage. CPU usage as a percent of available CPU.
      • +
    • Uptime. The amount of time elapsed since the member started.
      • +
    • Accessor. Indicates whether the member is an accessor member.
      • +
    Region DetailWhen you have selected a region, the right hand pane displays the following information about the region: +
      +
    • Name. Name of the region.
      • +
    • Region Path. Path for the region.
      • +
    • Type. For example, REPLICATE, PARTITION
      • +
    • Members. Number of members that are hosting the region.
      • +
    • Empty Nodes. Nodes where the region DataPolicy is defined as EMPTY or where LocalMaxMemory is set to 0.
      • +
    • Entry Count. Total number of entries in the region.
      • +
    • Disk Usage. Persistent data usage.
      • +
    • Persistence. Indicates whether the region's data is persisted to disk.
      • +
    • Memory Usage. The amount of memory used and total available memory (also shown as a percentage).
      • +
    • Reads/Writes. Summary of reads and writes served from memory and from disk stores over the last 15 minutes.
      • +
    + +# Data Browser + +The Pulse Data Browser enables you to query region data. Note that there are two key attributes available on DistributedSystemMXBean (see [List of Geode JMX MBeans](../../managing/management/list_of_mbeans.html#topic_4BCF867697C3456D96066BAD7F39FC8B)) that you can use to configure limits for the result sets displayed in Data Browser: + +- `QueryResultSetLimit` limits the number of rows that Data Browser queries return. 1000 rows are displayed by default. +- `QueryCollectionsDepth` limits the number of elements of a collection that Data Browser queries return. This attribute applies to query results contain collections such as Map, List, and so forth. The default value is 100 elements. + +See the `org.apache.geode.management.DistributedSystemMXBean` JavaDocs for information on available MBean methods and attributes. + +The following shows an example Data Browser view: + + + +Use these basic controls while in Data Browser view: + +1. Search for the name of a specific region. +2. Select one or more regions to display the Geode members that host those regions. The hosting Geode members appear in the Region Members section. +3. Select one or more members from the Region Members section to restrict query results to those members. +4. Type in the text of a query to execute. See [Querying](../../developing/querying_basics/chapter_overview.html). +5. Display a list of previously-executed queries. Double-click on a query from the history list to copy it to the Query Editor, or delete the query from your history. +6. Execute your query or clear the contents of the Query Editor. +7. View the current query results. +8. Export the query results to a text file. +9. Return to [Cluster View](#topic_F0ECE9E8179541CCA3D6C5F4FBA84404__section_9794B5754E474E10ABFBCD8B1DA240F8). + +# Alerts Widget + +The Alerts Widget appears in the right portion of the screen and displays a list of alerts. + +The alerts displayed for the cluster appear based on the alertLevel field set in the DistributedSystemMXBean. By default, log messages with the level of SEVERE are shown as alerts. You can modify the level by using the `DistributedMXBean.changeAlertLevel` method. See [System Alert Notifications](../../managing/management/notification_federation_and_alerts.html#topic_212EE5A2ABAB4E8E8EF71807C9ECEF1A__section_7463D13112D54406953416356835E290) for more information. + + + +Use these basic controls in the Alerts Widget: + +1. Select an alert level to view only alerts with a specific severity. +2. Enter text in the search box to filter the list of alerts. +3. Select an alert and click Clear to remove it from the alert list. +4. Click **Clear All** to remove all alerts from the widget. +5. Double-click an alert to open a pop-up window that displays the full text of the alert message. +6. Click the check mark in an alert pop-up window to acknowledge the alert. Acknowledged alerts display a check mark in the list of alerts. +7. Triple-click the alert in the pop-up or in the alert list to select the message text. You can then copy and paste the text into another application. +8. Click the **X** to close the pop-up alert window. +