http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/heap_use/lock_memory.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/heap_use/lock_memory.html.md.erb b/geode-docs/managing/heap_use/lock_memory.html.md.erb index f97e7e3..81106e2 100644 --- a/geode-docs/managing/heap_use/lock_memory.html.md.erb +++ b/geode-docs/managing/heap_use/lock_memory.html.md.erb @@ -26,7 +26,7 @@ On Linux systems, you can lock memory to prevent the operating system from pagin To use this feature: -1. Configure the operating system limits for locked memory. Increase the operating system's `ulimit -l` value (the maximum size that may be locked in memory) from the default (typically 32 KB or 64 KB) to at least the total amount of memory used by Geode for on-heap or off-heap storage. To view the current setting, enter `ulimit -a` at a shell prompt and find the value for `max locked memory`: +1. Configure the operating system limits for locked memory. Increase the operating system's `ulimit -l` value (the maximum size that may be locked in memory) from the default (typically 32 KB or 64 KB) to at least the total amount of memory used by <%=vars.product_name%> for on-heap or off-heap storage. To view the current setting, enter `ulimit -a` at a shell prompt and find the value for `max locked memory`: ``` pre # ulimit -a @@ -41,12 +41,12 @@ To use this feature: # ulimit -l 64000000 ``` -2. Using locked memory in this manner increases the time required to start Geode. The additional time required to start Geode depends on the total amount of memory used, and can range from several seconds to 10 minutes or more. To improve startup time and reduce the potential of member timeouts, instruct the kernel to free operating system page caches just before starting a Geode member by issuing the following command: +2. Using locked memory in this manner increases the time required to start <%=vars.product_name%>. The additional time required to start <%=vars.product_name%> depends on the total amount of memory used, and can range from several seconds to 10 minutes or more. To improve startup time and reduce the potential of member timeouts, instruct the kernel to free operating system page caches just before starting a <%=vars.product_name%> member by issuing the following command: ``` pre $ echo 1 > /proc/sys/vm/drop_caches ``` -3. Start each Geode data store with the gfsh `-lock-memory=true` option. If you deploy more than one server per host, begin by starting each server sequentially. Starting servers sequentially avoids a race condition in the operating system that can cause failures (even machine crashes) if you accidentally over-allocate the available RAM. After you verify that the system configuration is stable, you can then start servers concurrently. +3. Start each <%=vars.product_name%> data store with the gfsh `-lock-memory=true` option. If you deploy more than one server per host, begin by starting each server sequentially. Starting servers sequentially avoids a race condition in the operating system that can cause failures (even machine crashes) if you accidentally over-allocate the available RAM. After you verify that the system configuration is stable, you can then start servers concurrently.
http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/heap_use/off_heap_management.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/heap_use/off_heap_management.html.md.erb b/geode-docs/managing/heap_use/off_heap_management.html.md.erb index 3e1515d..8c203f3 100644 --- a/geode-docs/managing/heap_use/off_heap_management.html.md.erb +++ b/geode-docs/managing/heap_use/off_heap_management.html.md.erb @@ -21,11 +21,11 @@ limitations under the License. <a id="managing-off-heap-memory"></a> -Geode can be configured to store region values in off-heap memory, which is memory within the JVM that is not subject to Java garbage collection. +<%=vars.product_name%> can be configured to store region values in off-heap memory, which is memory within the JVM that is not subject to Java garbage collection. Garbage collection (GC) within a JVM can prove to be a performance impediment. A server cannot exert control over when garbage collection within the JVM heap memory takes place, and the server has little control over the triggers for invocation. Off-heap memory offloads values to a storage area that is not subject to Java GC. By taking advantage of off-heap storage, an application can reduce the amount of heap storage that is subject to GC overhead. -Off-heap memory works in conjunction with the heap, it does not replace it. The keys are stored in heap memory space. Geode's own memory manager handles the off-heap memory with better performance than the Java garbage collector would for certain sets of region data. +Off-heap memory works in conjunction with the heap, it does not replace it. The keys are stored in heap memory space. <%=vars.product_name%>'s own memory manager handles the off-heap memory with better performance than the Java garbage collector would for certain sets of region data. The resource manager monitors the contents of off-heap memory and invokes memory management operations in accordance with two thresholds similar to those used for monitoring the JVM heap: `eviction-off-heap-percentage` and `critical-off-heap-percentage`. @@ -59,7 +59,7 @@ Off-heap storage is best suited to data patterns where: - The values do not need to be frequently deserialized - Many of the values are long-lived reference data -Be aware that Geode has to perform extra work to access the data stored in off-heap memory since it is stored in serialized form. This extra work may cause some use cases to run slower in an off-heap configuration, even though they use less memory and avoid garbage collection overhead. However, even with the extra deserialization, off-heap storage may give you the best performance. Features that may increase overhead include +Be aware that <%=vars.product_name%> has to perform extra work to access the data stored in off-heap memory since it is stored in serialized form. This extra work may cause some use cases to run slower in an off-heap configuration, even though they use less memory and avoid garbage collection overhead. However, even with the extra deserialization, off-heap storage may give you the best performance. Features that may increase overhead include - frequent updates - stored values of widely varying sizes @@ -74,7 +74,7 @@ Region values that are less than or equal to eight bytes in size will not reside ## Controlling Off-heap Use with the Resource Manager -The Geode resource manager controls off-heap memory by means of two thresholds, in much the same way as it does JVM heap memory. See [Using the Geode Resource Manager](heap_management.html#how_the_resource_manager_works). The resource manager prevents the cache from consuming too much off-heap memory by evicting old data. If the off-heap memory manager is unable to keep up, the resource manager refuses additions to the cache until the off-heap memory manager has freed an adequate amount of memory. +The <%=vars.product_name%> resource manager controls off-heap memory by means of two thresholds, in much the same way as it does JVM heap memory. See [Using the <%=vars.product_name%> Resource Manager](heap_management.html#how_the_resource_manager_works). The resource manager prevents the cache from consuming too much off-heap memory by evicting old data. If the off-heap memory manager is unable to keep up, the resource manager refuses additions to the cache until the off-heap memory manager has freed an adequate amount of memory. The resource manager has two threshold settings, each expressed as a percentage of the total off-heap memory. Both are disabled by default. @@ -152,7 +152,7 @@ off-heap-memory-size=4096m off-heap-memory-size=120g ``` -See [gemfire.properties and gfsecurity.properties (Geode Properties)](../../reference/topics/gemfire_properties.html) for details. +See [gemfire.properties and gfsecurity.properties (<%=vars.product_name%> Properties)](../../reference/topics/gemfire_properties.html) for details. The cache.xml file supports one region attribute: @@ -189,7 +189,7 @@ For example: ## <a id="managing-off-heap-memory__section_o4s_tg5_gv" class="no-quick-link"></a>Tuning Off-heap Memory Usage -Geode collects statistics on off-heap memory usage which you can view with the gfsh `show metrics` command. See [Off-Heap (OffHeapMemoryStats)](../../reference/statistics_list.html#topic_ohc_tjk_w5) for a description of available off-heap statistics. +<%=vars.product_name%> collects statistics on off-heap memory usage which you can view with the gfsh `show metrics` command. See [Off-Heap (OffHeapMemoryStats)](../../reference/statistics_list.html#topic_ohc_tjk_w5) for a description of available off-heap statistics. Off-heap memory is optimized, by default, for storing values of 128 KB in size. This figure is known as the "maximum optimized stored value size," which we will denote here by *maxOptStoredValSize*. If your data typically runs larger, you can enhance performance by increasing the OFF\_HEAP\_FREE\_LIST\_COUNT system parameter to a number larger than `maxOptStoredValSize/8`, where *maxOptStoredValSize* is expressed in KB (1024 bytes). So, the default values correspond to: http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/logging/configuring_log4j2.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/logging/configuring_log4j2.html.md.erb b/geode-docs/managing/logging/configuring_log4j2.html.md.erb index f4d5ea3..cd9796b 100644 --- a/geode-docs/managing/logging/configuring_log4j2.html.md.erb +++ b/geode-docs/managing/logging/configuring_log4j2.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Advanced UsersâConfiguring Log4j 2 for Geode ---- +<% set_title("Advanced UsersâConfiguring Log4j 2 for", product_name) %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,17 +17,17 @@ See the License for the specific language governing permissions and limitations under the License. --> -Basic Geode logging configuration is configured via the gemfire.properties file. This topic is intended for advanced users who need increased control over logging due to integration with third-party libraries. +Basic <%=vars.product_name%> logging configuration is configured via the gemfire.properties file. This topic is intended for advanced users who need increased control over logging due to integration with third-party libraries. -The default `log4j2.xml` that Geode uses is stored in geode.jar as `log4j2-default.xml`. The contents of the configuration can be viewed in the product distribution in the following location: `$GEMFIRE/defaultConfigs/log4j2.xml`. +The default `log4j2.xml` that <%=vars.product_name%> uses is stored in geode.jar as `log4j2-default.xml`. The contents of the configuration can be viewed in the product distribution in the following location: `$GEMFIRE/defaultConfigs/log4j2.xml`. -To specify your own `log4j2.xml` configuration file (or anything else supported by Log4j 2 such as .json or .yaml), use the following flag when starting up your JVM or Geode member: +To specify your own `log4j2.xml` configuration file (or anything else supported by Log4j 2 such as .json or .yaml), use the following flag when starting up your JVM or <%=vars.product_name%> member: ``` pre -Dlog4j.configurationFile=<location-of-your-file> ``` -If the Java system property `log4j.configurationFile` is specified, then Geode will not use the `log4j2-default.xml` included in geode.jar. However, Geode will still create and register a AlertAppender and LogWriterAppender if the `alert-level` and `log-file` Geode properties are configured. You can then use the Geode LogWriter to log to Geode's log or to generate an Alert and receive log statements from customer's application and all third party libraries. Alternatively, you can use any front-end logging API that is configured to log to Log4j 2. +If the Java system property `log4j.configurationFile` is specified, then <%=vars.product_name%> will not use the `log4j2-default.xml` included in geode.jar. However, <%=vars.product_name%> will still create and register a AlertAppender and LogWriterAppender if the `alert-level` and `log-file` <%=vars.product_name%> properties are configured. You can then use the <%=vars.product_name%> LogWriter to log to <%=vars.product_name%>'s log or to generate an Alert and receive log statements from customer's application and all third party libraries. Alternatively, you can use any front-end logging API that is configured to log to Log4j 2. ## Using Different Front-End Logging APIs to Log to Log4j2 @@ -43,26 +41,26 @@ For example, if you are using: See [http://logging.apache.org/log4j/2.x/faq.html](http://logging.apache.org/log4j/2.x/faq.html) for more examples. -All three of the above JAR files are in the full distribution of Log4J 2.1 which can be downloaded at [http://logging.apache.org/log4j/2.x/download.html](http://logging.apache.org/log4j/2.x/download.html). Download the appropriate bridge, adapter, or binding JARs to ensure that Geode logging is integrated with every logging API used in various third-party libraries or in your own applications. +All three of the above JAR files are in the full distribution of Log4J 2.1 which can be downloaded at [http://logging.apache.org/log4j/2.x/download.html](http://logging.apache.org/log4j/2.x/download.html). Download the appropriate bridge, adapter, or binding JARs to ensure that <%=vars.product_name%> logging is integrated with every logging API used in various third-party libraries or in your own applications. **Note:** -Apache Geode has been tested with Log4j 2.1. As newer versions of Log4j 2 come out, you can find 2.1 under Previous Releases on that page. +<%=vars.product_name_long%> has been tested with Log4j 2.1. As newer versions of Log4j 2 come out, you can find 2.1 under Previous Releases on that page. ## Customizing Your Own log4j2.xml File Advanced users may want to move away entirely from setting `log-*` gemfire properties and instead specify their own `log4j2.xml` using `-Dlog4j.configurationFile`. -Custom Log4j 2 configuration in Geode comes with some caveats and notes: +Custom Log4j 2 configuration in <%=vars.product_name%> comes with some caveats and notes: - Do not use `"monitorInterval="` in your log4j2.xml file because doing so can have significant performance impact. This setting instructs Log4j 2 to monitor the log4j2.xml config file at runtime and automatically reload and reconfigure if the file changes. -- Geode's default `log4j2.xml` specifies status="FATAL" because Log4j 2's StatusLogger generates warnings to standard out at ERROR level anytime Geode stops its AlertAppender or LogWriterAppender. Geode uses a lot of concurrent threads that are executing code with log statements; these threads may be logging while the Geode appenders are being stopped. -- Geode's default log4j2.xml specifies `shutdownHook="disable"` because Geode has a shutdown hook which disconnects the DistributedSystem and closes the Cache, which is executing the code that performs logging. If the Log4J2 shutdown hook stops logging before Geode completes its shutdown, Log4j 2 will attempt to start back up. This restart in turn attempts to register another Log4j 2 shutdown hook which fails resulting in a FATAL level message logged by Log4j 2. -- The GEMFIRE\_VERBOSE marker (Log4J2 Marker are discussed on [http://logging.apache.org/log4j/2.x/manual/markers.html](http://logging.apache.org/log4j/2.x/manual/markers.html)) can be used to enable additional verbose log statements at TRACE level. Many log statements are enabled simply by enabling DEBUG or TRACE. However, even more log statements can be further enabled by using MarkerFilter to accept GEMFIRE\_VERBOSE. The default Geode `log4j2.xml` disables GEMFIRE\_VERBOSE with this line: +- <%=vars.product_name%>'s default `log4j2.xml` specifies status="FATAL" because Log4j 2's StatusLogger generates warnings to standard out at ERROR level anytime <%=vars.product_name%> stops its AlertAppender or LogWriterAppender. <%=vars.product_name%> uses a lot of concurrent threads that are executing code with log statements; these threads may be logging while the <%=vars.product_name%> appenders are being stopped. +- <%=vars.product_name%>'s default log4j2.xml specifies `shutdownHook="disable"` because <%=vars.product_name%> has a shutdown hook which disconnects the DistributedSystem and closes the Cache, which is executing the code that performs logging. If the Log4J2 shutdown hook stops logging before <%=vars.product_name%> completes its shutdown, Log4j 2 will attempt to start back up. This restart in turn attempts to register another Log4j 2 shutdown hook which fails resulting in a FATAL level message logged by Log4j 2. +- The GEMFIRE\_VERBOSE marker (Log4J2 Marker are discussed on [http://logging.apache.org/log4j/2.x/manual/markers.html](http://logging.apache.org/log4j/2.x/manual/markers.html)) can be used to enable additional verbose log statements at TRACE level. Many log statements are enabled simply by enabling DEBUG or TRACE. However, even more log statements can be further enabled by using MarkerFilter to accept GEMFIRE\_VERBOSE. The default <%=vars.product_name%> `log4j2.xml` disables GEMFIRE\_VERBOSE with this line: ``` pre <MarkerFilter marker="GEMFIRE_VERBOSE" onMatch="DENY" onMismatch="NEUTRAL"/> ``` - You can enable the GEMFIRE\_VERBOSE log statements by changing `onMatch="DENY"` to `onMatch="ACCEPT"`. Typically, it's more useful to simply enable DEBUG or TRACE on certain classes or packages instead of for the entire Geode product. However, this setting can be used for internal debugging purposes if all other debugging methods fail. + You can enable the GEMFIRE\_VERBOSE log statements by changing `onMatch="DENY"` to `onMatch="ACCEPT"`. Typically, it's more useful to simply enable DEBUG or TRACE on certain classes or packages instead of for the entire <%=vars.product_name%> product. However, this setting can be used for internal debugging purposes if all other debugging methods fail. http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/logging/how_logging_works.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/logging/how_logging_works.html.md.erb b/geode-docs/managing/logging/how_logging_works.html.md.erb index 22634c6..0c26d8e 100644 --- a/geode-docs/managing/logging/how_logging_works.html.md.erb +++ b/geode-docs/managing/logging/how_logging_works.html.md.erb @@ -1,6 +1,4 @@ ---- -title: How Geode Logging Works ---- +<% set_title("How", product_name, "Logging Works") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,21 +17,21 @@ See the License for the specific language governing permissions and limitations under the License. --> -Apache Geode uses Apache Log4j 2 as the basis for its logging system. +<%=vars.product_name_long%> uses Apache Log4j 2 as the basis for its logging system. -Geode uses [Apache Log4j 2](http://logging.apache.org/log4j/2.x/) API and Core libraries as the basis for its logging system. Log4j 2 API is a popular and powerful front-end logging API used by all the Geode classes to generate log statements. Log4j 2 Core is a backend implementation for logging; you can route any of the front-end logging API libraries to log to this backend. Geode uses the Core backend to run two custom Log4j 2 Appenders: **AlertAppender** and **LogWriterAppender**. +<%=vars.product_name%> uses [Apache Log4j 2](http://logging.apache.org/log4j/2.x/) API and Core libraries as the basis for its logging system. Log4j 2 API is a popular and powerful front-end logging API used by all the <%=vars.product_name%> classes to generate log statements. Log4j 2 Core is a backend implementation for logging; you can route any of the front-end logging API libraries to log to this backend. <%=vars.product_name%> uses the Core backend to run two custom Log4j 2 Appenders: **AlertAppender** and **LogWriterAppender**. -Geode has been tested with Log4j 2.1. +<%=vars.product_name%> has been tested with Log4j 2.1. **Note:** -For this reason, Geode now always requires the following JARs to be in the classpath: `log4j-api-2.1.jar`, `log4j-core-2.1.jar`. Both of these JARs are distributed in the `$GEMFIRE/lib` directory and included in the appropriate `*-dependencies.jar` convenience libraries. +For this reason, <%=vars.product_name%> now always requires the following JARs to be in the classpath: `log4j-api-2.1.jar`, `log4j-core-2.1.jar`. Both of these JARs are distributed in the `$GEMFIRE/lib` directory and included in the appropriate `*-dependencies.jar` convenience libraries. -**AlertAppender** is the component that generates Geode alerts that are then managed by the JMX Management and Monitoring system. See [Notification Federation](../management/notification_federation_and_alerts.html#topic_212EE5A2ABAB4E8E8EF71807C9ECEF1A) for more details. +**AlertAppender** is the component that generates <%=vars.product_name%> alerts that are then managed by the JMX Management and Monitoring system. See [Notification Federation](../management/notification_federation_and_alerts.html#topic_212EE5A2ABAB4E8E8EF71807C9ECEF1A) for more details. -**LogWriterAppender** is the component that is configured by all the `log-*` Geode properties such as `log-file`, `log-file-size-limit` and `log-disk-space-limit`. +**LogWriterAppender** is the component that is configured by all the `log-*` <%=vars.product_name%> properties such as `log-file`, `log-file-size-limit` and `log-disk-space-limit`. -Both of these appenders are created and controlled programmatically. You configure their behavior with the `log-*` Geode properties and the alert level that is configured within the JMX Management & Monitoring system. These appenders do not currently support configuration within a `log4j2.xml` config file. +Both of these appenders are created and controlled programmatically. You configure their behavior with the `log-*` <%=vars.product_name%> properties and the alert level that is configured within the JMX Management & Monitoring system. These appenders do not currently support configuration within a `log4j2.xml` config file. -Advanced users may wish to define their own `log4j2.xml`. See [Advanced UsersâConfiguring Log4j 2 for Geode](configuring_log4j2.html) for more details. +Advanced users may wish to define their own `log4j2.xml`. See [Advanced UsersâConfiguring Log4j 2 for <%=vars.product_name%>](configuring_log4j2.html) for more details. http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/logging/logging.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/logging/logging.html.md.erb b/geode-docs/managing/logging/logging.html.md.erb index c4fbaf6..ab080a6 100644 --- a/geode-docs/managing/logging/logging.html.md.erb +++ b/geode-docs/managing/logging/logging.html.md.erb @@ -21,24 +21,24 @@ limitations under the License. Comprehensive logging messages help you confirm system configuration and debug problems in configuration and code. -- **[How Geode Logging Works](../../managing/logging/how_logging_works.html)** +- **[How <%=vars.product_name%> Logging Works](how_logging_works.html)** - Apache Geode uses Apache Log4j 2 as the basis for its logging system. + <%=vars.product_name_long%> uses Apache Log4j 2 as the basis for its logging system. -- **[Understanding Log Messages and Their Categories](../../managing/logging/logging_categories.html)** +- **[Understanding Log Messages and Their Categories](logging_categories.html)** System logging messages typically pertain to startup; logging management; connection and system membership; distribution; or cache, region, and entry management. -- **[Naming, Searching, and Creating Log Files](../../managing/logging/logging_whats_next.html)** +- **[Naming, Searching, and Creating Log Files](logging_whats_next.html)** The best way to manage and understand the logs is to have each member log to its own files. -- **[Set Up Logging](../../managing/logging/setting_up_logging.html)** +- **[Set Up Logging](setting_up_logging.html)** You configure logging in a member's `gemfire.properties` or at startup with `gfsh`. -- **[Advanced UsersâConfiguring Log4j 2 for Geode](../../managing/logging/configuring_log4j2.html)** +- **[Advanced UsersâConfiguring Log4j 2 for <%=vars.product_name%>](configuring_log4j2.html)** - Basic Geode logging configuration is configured via the gemfire.properties file. This topic is intended for advanced users who need increased control over logging due to integration with third-party libraries. + Basic <%=vars.product_name%> logging configuration is configured via the gemfire.properties file. This topic is intended for advanced users who need increased control over logging due to integration with third-party libraries. http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/logging/logging_categories.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/logging/logging_categories.html.md.erb b/geode-docs/managing/logging/logging_categories.html.md.erb index 6dc94fa..72a595f 100644 --- a/geode-docs/managing/logging/logging_categories.html.md.erb +++ b/geode-docs/managing/logging/logging_categories.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. System logging messages typically pertain to startup; logging management; connection and system membership; distribution; or cache, region, and entry management. -- **Startup information**. Describe the Java version, the Geode native version, the host system, current working directory, and environment settings. These messages contain all information about the system and configuration the process is running with. +- **Startup information**. Describe the Java version, the <%=vars.product_name%> native version, the host system, current working directory, and environment settings. These messages contain all information about the system and configuration the process is running with. - **Logging management**. Pertain to the maintenance of the log files themselves. This information is always in the main log file (see the discussion at Log File Name). - **Connections and system membership**. Report on the arrival and departure of distributed system members (including the current member) and any information related to connection activities or failures. This includes information on communication between tiers in a hierarchical cache. - **Distribution**. Report on the distribution of data between system members. These messages include information about region configuration, entry creation and modification, and region and entry invalidation and destruction. @@ -44,11 +44,11 @@ Cache initialized using "file:/Samples/quickstart/xml/PushConsumer.xml". ## <a id="how_logging_works__section_43A099C67FF04A1EB0A07B617D653A38" class="no-quick-link"></a>Log File Name -Specify your Geode system member's main log in the gemfire property `log-file` setting. +Specify your <%=vars.product_name%> system member's main log in the gemfire property `log-file` setting. -Geode uses this name for the most recent log file, actively in use if the member is running, or used for the last run. Geode creates the main log file when the application starts. +<%=vars.product_name%> uses this name for the most recent log file, actively in use if the member is running, or used for the last run. <%=vars.product_name%> creates the main log file when the application starts. -By default, the main log contains the entire log for the member session. If you specify a `log-file-size-limit`, Geode splits the logging into these files: +By default, the main log contains the entire log for the member session. If you specify a `log-file-size-limit`, <%=vars.product_name%> splits the logging into these files: - **The main, current log**. Holding current logging entries. Named with the string you specified in `log-file`. - **Child logs**. Holding older logging entries. These are created by renaming the main, current log when it reaches the size limit. @@ -132,7 +132,7 @@ These are the levels, in descending order, with sample output: - **error**. This level indicates that something is wrong in your system. You should be able to continue running, but the operation noted in the error message failed. - This error was produced by throwing a `Throwable` from a `CacheListener`. While dispatching events to a customer-implemented cache listener, Geode catches any `Throwable` thrown by the listener and logs it as an error. The text shown here is followed by the output from the `Throwable` itself. + This error was produced by throwing a `Throwable` from a `CacheListener`. While dispatching events to a customer-implemented cache listener, <%=vars.product_name%> catches any `Throwable` thrown by the listener and logs it as an error. The text shown here is followed by the output from the `Throwable` itself. ``` pre [error 2007/09/05 11:45:30.542 PDT gemfire1_newton_18222 @@ -244,4 +244,4 @@ These are the levels, in descending order, with sample output: Do not use these settings unless asked to do so by technical support. **Note:** -Geode no longer supports setting system properties for VERBOSE logging. To enable VERBOSE logging, see [Advanced UsersâConfiguring Log4j 2 for Geode](configuring_log4j2.html) +<%=vars.product_name%> no longer supports setting system properties for VERBOSE logging. To enable VERBOSE logging, see [Advanced UsersâConfiguring Log4j 2 for <%=vars.product_name%>](configuring_log4j2.html) http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/logging/setting_up_logging.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/logging/setting_up_logging.html.md.erb b/geode-docs/managing/logging/setting_up_logging.html.md.erb index f2ab52e..04f345b 100644 --- a/geode-docs/managing/logging/setting_up_logging.html.md.erb +++ b/geode-docs/managing/logging/setting_up_logging.html.md.erb @@ -24,7 +24,7 @@ You configure logging in a member's `gemfire.properties` or at startup with `gfs <a id="setting_up_logging__section_35F8A9028A91441785BCACD6CD40A498"></a> Before you begin, make sure you understand [Basic Configuration and Programming](../../basic_config/book_intro.html). -1. Run a time synchronization service such as NTP on all Geode host machines. This is the only way to produce logs that are useful for troubleshooting. Synchronized time stamps ensure that log messages from different hosts can be merged to accurately reproduce a chronological history of a distributed run. +1. Run a time synchronization service such as NTP on all <%=vars.product_name%> host machines. This is the only way to produce logs that are useful for troubleshooting. Synchronized time stamps ensure that log messages from different hosts can be merged to accurately reproduce a chronological history of a distributed run. 2. Use a sniffer to monitor your logs Look for new or unexpected warnings, errors, or severe messages. The logs output by your system have their own characteristics, indicative of your system configuration and of the particular behavior of your applications, so you must become familiar with your applications' logs to use them effectively. 3. Configure member logging in each member's `gemfire.properties` as needed: http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/management/configuring_rmi_connector.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/configuring_rmi_connector.html.md.erb b/geode-docs/managing/management/configuring_rmi_connector.html.md.erb index 5b29149..922b6d0 100644 --- a/geode-docs/managing/management/configuring_rmi_connector.html.md.erb +++ b/geode-docs/managing/management/configuring_rmi_connector.html.md.erb @@ -19,16 +19,16 @@ See the License for the specific language governing permissions and limitations under the License. --> -Geode programmatically emulates out-of-the-box JMX provided by Java and creates a JMXServiceURL with RMI Registry and RMI Connector ports on all manageable members. +<%=vars.product_name%> programmatically emulates out-of-the-box JMX provided by Java and creates a JMXServiceURL with RMI Registry and RMI Connector ports on all manageable members. ## <a id="concept_BC793A7ACF9A4BD9A29C2DCC6894767D__section_143531EBBCF94033B8058FCF5F8A5A0D" class="no-quick-link"></a>Configuring JMX Manager Port and Bind Addresses -You can configure a specific connection port and address when launching a process that will host the Geode JMX Manager. To do this, specify values for the `jmx-manager-bind-address`, which specifies the JMX manager's IP address and `jmx-manager-port`, which defines the RMI connection port. +You can configure a specific connection port and address when launching a process that will host the <%=vars.product_name%> JMX Manager. To do this, specify values for the `jmx-manager-bind-address`, which specifies the JMX manager's IP address and `jmx-manager-port`, which defines the RMI connection port. -The default Geode JMX Manager RMI port is 1099. You may need to modify this default if 1099 is reserved for other uses. +The default <%=vars.product_name%> JMX Manager RMI port is 1099. You may need to modify this default if 1099 is reserved for other uses. ## <a id="concept_BC793A7ACF9A4BD9A29C2DCC6894767D__section_BF6352A05CE94F35A8355232D22AC2BC" class="no-quick-link"></a>Using Out-of-the-Box RMI Connectors -If for some reason you need to use standard JMX RMI in your deployment for other monitoring purposes, set the Geode property `jmx-manager-port` to 0 on any members where you want to use standard JMX RMI. +If for some reason you need to use standard JMX RMI in your deployment for other monitoring purposes, set the <%=vars.product_name%> property `jmx-manager-port` to 0 on any members where you want to use standard JMX RMI. -If you use out-of-the-box JMX RMI instead of starting an embedded Geode JMX Manager, you should consider setting `-Dsun.rmi.dgc.server.gcInterval=Long.MAX_VALUE-1` when starting the JVM for customer applications and client processes. Every Geode process internally sets this setting before creating and starting the JMX RMI connector in order to prevent full garbage collection from pausing processes. +If you use out-of-the-box JMX RMI instead of starting an embedded <%=vars.product_name%> JMX Manager, you should consider setting `-Dsun.rmi.dgc.server.gcInterval=Long.MAX_VALUE-1` when starting the JVM for customer applications and client processes. Every <%=vars.product_name%> process internally sets this setting before creating and starting the JMX RMI connector in order to prevent full garbage collection from pausing processes. http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/management/gfsh_and_management_api.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/gfsh_and_management_api.html.md.erb b/geode-docs/managing/management/gfsh_and_management_api.html.md.erb index e7ee5c2..6c642d6 100644 --- a/geode-docs/managing/management/gfsh_and_management_api.html.md.erb +++ b/geode-docs/managing/management/gfsh_and_management_api.html.md.erb @@ -22,7 +22,7 @@ limitations under the License. You can also use management APIs to execute gfsh commands programmatically. **Note:** -If you start the JMX Manager programmatically and wish to enable command processing, you must also add the absolute path of `gfsh-dependencies.jar` (located in `$GEMFIRE/lib` of your Geode installation) to the CLASSPATH of your application. Do not copy this library to your CLASSPATH because this library refers to other dependencies in `$GEMFIRE/lib` by a relative path. The following code samples demonstrate how to process and execute `gfsh` commands using the Java API. +If you start the JMX Manager programmatically and wish to enable command processing, you must also add the absolute path of `gfsh-dependencies.jar` (located in `$GEMFIRE/lib` of your <%=vars.product_name%> installation) to the CLASSPATH of your application. Do not copy this library to your CLASSPATH because this library refers to other dependencies in `$GEMFIRE/lib` by a relative path. The following code samples demonstrate how to process and execute `gfsh` commands using the Java API. First, retrieve a CommandService instance. http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/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 d002734..b143436 100644 --- a/geode-docs/managing/management/jmx_manager_node.html.md.erb +++ b/geode-docs/managing/management/jmx_manager_node.html.md.erb @@ -23,10 +23,10 @@ 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/pulse-overview.html). +You need to have a JMX Manager started in your distributed system in order to use <%=vars.product_name%> management and monitoring tools such as [gfsh](../../tools_modules/gfsh/chapter_overview.html) and [<%=vars.product_name%> 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. +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 <%=vars.product_name%> processes. - **[Starting a JMX Manager](jmx_manager_operations.html)** http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/management/jmx_manager_operations.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/jmx_manager_operations.html.md.erb b/geode-docs/managing/management/jmx_manager_operations.html.md.erb index e48209c..6b85129 100644 --- a/geode-docs/managing/management/jmx_manager_operations.html.md.erb +++ b/geode-docs/managing/management/jmx_manager_operations.html.md.erb @@ -22,14 +22,14 @@ limitations under the License. <a id="topic_686158E9AFBD47518BE1B4BEB232C190"></a> -JMX Manager nodes are members that manage other Geode members (as well as themselves). A JMX Manager node can manage all other members in the distributed system. Typically a locator will function as the JMX Manager, but you can also turn any other distributed system member such as a server into a JMX Manager node as well. +JMX Manager nodes are members that manage other <%=vars.product_name%> members (as well as themselves). A JMX Manager node can manage all other members in the distributed system. Typically a locator will function as the JMX Manager, but you can also turn any other distributed system member such as a server into a JMX Manager node as well. -To allow a server to become a JMX Manager you configure Geode property `jmx-manager=true`, in the server's`gemfire.properties` file. This property configures the node to become a JMX Manager node passively; if gfsh cannot locate a JMX Manager when connecting to the distributed system, the server node will be started as a JMX Manager node. +To allow a server to become a JMX Manager you configure <%=vars.product_name%> property `jmx-manager=true`, in the server's`gemfire.properties` file. This property configures the node to become a JMX Manager node passively; if gfsh cannot locate a JMX Manager when connecting to the distributed system, the server node will be started as a JMX Manager node. **Note:** The default property setting for all locators is `gemfire.jmx-manager=true`. For other members, the default property setting is `gemfire.jmx-manager=false`. -To force a server to become a JMX Manager node whenever it is started, set the Geode properties `jmx-manager-start=true` and `jmx-manager=true` in the server's gemfire.properties file. Note that both of these properties must be set to true for the node. +To force a server to become a JMX Manager node whenever it is started, set the <%=vars.product_name%> properties `jmx-manager-start=true` and `jmx-manager=true` in the server's gemfire.properties file. Note that both of these properties must be set to true for the node. To start the member as a JMX Manager node on the command line, provide` --J=-Dgemfire.jmx-manager-start=true and --J=-Dgemfire.jmx-manager=true` as arguments to either the `start server` or `start locator` command. @@ -50,13 +50,13 @@ The following is an example of starting a new locator that also starts an embedd ``` pre gfsh>start locator --name=locator1 -Starting a Geode Locator in /Users/username/apache-geode/locator1... +Starting a <%=vars.product_name%> Locator in /Users/username/apache-geode/locator1... .... Locator in /Users/username/apache-geode/locator1 on 192.0.2.0[10334] as locator1 is currently online. Process ID: 27144 Uptime: 5 seconds -Geode Version: 1.2.0 +<%=vars.product_name%> Version: <%=vars.product_version%> Java Version: 1.8.0_111 Log File: /Users/username/apache-geode/locator1/locator1.log JVM Arguments: -Dgemfire.enable-cluster-configuration=true @@ -102,12 +102,12 @@ In the `gemfire.properties` file, you configure a JMX manager as follows. <tbody> <tr class="odd"> <td>http-service-port</td> -<td>If non-zero, then Geode starts an embedded HTTP service that listens on this port. The HTTP service is used to host the Geode Pulse Web application. If you are hosting the Pulse web app on your own Web server, then disable this embedded HTTP service by setting this property to zero. Ignored if <code class="ph codeph">jmx-manager</code> is false.</td> +<td>If non-zero, then <%=vars.product_name%> starts an embedded HTTP service that listens on this port. The HTTP service is used to host the <%=vars.product_name%> Pulse Web application. If you are hosting the Pulse web app on your own Web server, then disable this embedded HTTP service by setting this property to zero. Ignored if <code class="ph codeph">jmx-manager</code> is false.</td> <td>7070</td> </tr> <tr class="even"> <td>http-service-bind-address</td> -<td>If set, then the Geode member binds the embedded HTTP service to the specified address. If this property is not set but the HTTP service is enabled using <code class="ph codeph">http-service-port</code>, then Geode binds the HTTP service to the member's local address.</td> +<td>If set, then the <%=vars.product_name%> member binds the embedded HTTP service to the specified address. If this property is not set but the HTTP service is enabled using <code class="ph codeph">http-service-port</code>, then <%=vars.product_name%> binds the HTTP service to the member's local address.</td> <td><em>not set</em></td> </tr> <tr class="odd"> @@ -123,7 +123,7 @@ In the `gemfire.properties` file, you configure a JMX manager as follows. </tr> <tr class="odd"> <td>jmx-manager-bind-address</td> -<td>By default, the JMX Manager when configured with a port listens on all the local host's addresses. You can use this property to configure which particular IP address or host name the JMX Manager will listen on. This property is ignored if <code class="ph codeph">jmx-manager</code> is false or <code class="ph codeph">jmx-manager-port</code> is zero. This address also applies to the Geode Pulse server if you are hosting a Pulse web application.</td> +<td>By default, the JMX Manager when configured with a port listens on all the local host's addresses. You can use this property to configure which particular IP address or host name the JMX Manager will listen on. This property is ignored if <code class="ph codeph">jmx-manager</code> is false or <code class="ph codeph">jmx-manager-port</code> is zero. This address also applies to the <%=vars.product_name%> Pulse server if you are hosting a Pulse web application.</td> <td><em>not set</em></td> </tr> <tr class="even"> @@ -138,12 +138,12 @@ In the `gemfire.properties` file, you configure a JMX manager as follows. </tr> <tr class="even"> <td>jmx-manager-port</td> -<td>Port on which this JMX Manager listens for client connections. If this property is set to zero, Geode does not allow remote client connections. Alternatively, use the standard system properties supported by the JVM for configuring access from remote JMX clients. Ignored if jmx-manager is false. The Default RMI port is 1099.</td> +<td>Port on which this JMX Manager listens for client connections. If this property is set to zero, <%=vars.product_name%> does not allow remote client connections. Alternatively, use the standard system properties supported by the JVM for configuring access from remote JMX clients. Ignored if jmx-manager is false. The Default RMI port is 1099.</td> <td>1099</td> </tr> <tr class="odd"> <td>jmx-manager-ssl</td> -<td>If true and <code class="ph codeph">jmx-manager-port</code> is not zero, the JMX Manager accepts only SSL connections. The ssl-enabled property does not apply to the JMX Manager, but the other SSL properties do. This allows SSL to be configured for just the JMX Manager without needing to configure it for the other Geode connections. Ignored if <code class="ph codeph">jmx-manager</code> is false.</td> +<td>If true and <code class="ph codeph">jmx-manager-port</code> is not zero, the JMX Manager accepts only SSL connections. The ssl-enabled property does not apply to the JMX Manager, but the other SSL properties do. This allows SSL to be configured for just the JMX Manager without needing to configure it for the other <%=vars.product_name%> connections. Ignored if <code class="ph codeph">jmx-manager</code> is false.</td> <td>false</td> </tr> <tr class="even"> @@ -153,7 +153,7 @@ In the `gemfire.properties` file, you configure a JMX manager as follows. </tr> <tr class="odd"> <td>jmx-manager-update-rate</td> -<td>The rate, in milliseconds, at which this member pushes updates to any JMX Managers. Currently this value should be greater than or equal to the <code class="ph codeph">statistic-sample-rate</code>. Setting this value too high causes <code class="ph codeph">gfsh</code> and Geode Pulse to see stale values.</td> +<td>The rate, in milliseconds, at which this member pushes updates to any JMX Managers. Currently this value should be greater than or equal to the <code class="ph codeph">statistic-sample-rate</code>. Setting this value too high causes <code class="ph codeph">gfsh</code> and <%=vars.product_name%> Pulse to see stale values.</td> <td>2000</td> </tr> </tbody> http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/management/list_of_mbean_notifications.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/list_of_mbean_notifications.html.md.erb b/geode-docs/managing/management/list_of_mbean_notifications.html.md.erb index 0d9229d..5f7bcf3 100644 --- a/geode-docs/managing/management/list_of_mbean_notifications.html.md.erb +++ b/geode-docs/managing/management/list_of_mbean_notifications.html.md.erb @@ -21,7 +21,7 @@ limitations under the License. <a id="mbean_notifications_list"></a> -This topic lists all available JMX notifications emitted by Geode MBeans. +This topic lists all available JMX notifications emitted by <%=vars.product_name%> MBeans. Notifications are emitted by the following MBeans: http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/management/list_of_mbeans.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/list_of_mbeans.html.md.erb b/geode-docs/managing/management/list_of_mbeans.html.md.erb index 57a4a24..7261028 100644 --- a/geode-docs/managing/management/list_of_mbeans.html.md.erb +++ b/geode-docs/managing/management/list_of_mbeans.html.md.erb @@ -1,6 +1,4 @@ ---- -title: List of Geode JMX MBeans ---- +<% set_title("List of", product_name, "JMX MBeans") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -21,9 +19,9 @@ limitations under the License. <a id="topic_4BCF867697C3456D96066BAD7F39FC8B"></a> -This topic provides descriptions for the various management and monitoring MBeans that are available in Geode. +This topic provides descriptions for the various management and monitoring MBeans that are available in <%=vars.product_name%>. -The following diagram illustrates the relationship between the different JMX MBeans that have been developed to manage and monitor Apache Geode. +The following diagram illustrates the relationship between the different JMX MBeans that have been developed to manage and monitor <%=vars.product_name_long%>. <img src="../../images_svg/MBeans.svg" id="topic_4BCF867697C3456D96066BAD7F39FC8B__image_66525625D6804EDE9675D6CE509360A3" class="image" /> http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/management/list_of_mbeans_full.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/list_of_mbeans_full.html.md.erb b/geode-docs/managing/management/list_of_mbeans_full.html.md.erb index 169d4f6..ddc1f98 100644 --- a/geode-docs/managing/management/list_of_mbeans_full.html.md.erb +++ b/geode-docs/managing/management/list_of_mbeans_full.html.md.erb @@ -32,7 +32,7 @@ The JMX Manager node includes all local beans listed under [Managed Node MBeans] ## <a id="topic_14E3721DD0CF47D7AD8C742DFBE9FB9C__section_7B878B450B994514BDFE96571F0D3827" class="no-quick-link"></a>ManagerMXBean -Represents the Geode Management layer for the hosting member. Controls the scope of management. This MBean provides `start` and `stop` methods to turn a managed node into a JMX Manager node or to stop a node from being a JMX Manager. For potential managers (`jmx-manager=true` and `jmx-manager-start=false`), this MBean is created when a Locator requests it. +Represents the <%=vars.product_name%> Management layer for the hosting member. Controls the scope of management. This MBean provides `start` and `stop` methods to turn a managed node into a JMX Manager node or to stop a node from being a JMX Manager. For potential managers (`jmx-manager=true` and `jmx-manager-start=false`), this MBean is created when a Locator requests it. **Note:** You must configure the node to allow it to become a JMX Manager. See [Configuring a JMX Manager](jmx_manager_operations.html#topic_263072624B8D4CDBAD18B82E07AA44B6) for configuration information. @@ -54,9 +54,9 @@ System-wide aggregate MBean that provides a high-level view of the entire distri The DistributedSystemMXBean provides APIs for performing distributed system-wide operations such as backing up all members, shutting down all members or showing various distributed system metrics. -You can attach a standard JMX NotificationListener to this MBean to listen for notifications throughout the distributed system. See [Geode JMX MBean Notifications](mbean_notifications.html) for more information. +You can attach a standard JMX NotificationListener to this MBean to listen for notifications throughout the distributed system. See [<%=vars.product_name%> JMX MBean Notifications](mbean_notifications.html) for more information. -This MBean also provides some MBean model navigation APIS. These APIs should be used to navigate through all the MBeans exposed by a Geode System. +This MBean also provides some MBean model navigation APIS. These APIs should be used to navigate through all the MBeans exposed by a <%=vars.product_name%> System. **MBean Details** @@ -119,7 +119,7 @@ JMX Manager nodes will have managed node MBeans for themselves since they are al ## <a id="topic_48194A5BDF3F40F68E95A114DD702413__section_796A989549304BF7A536A33A913322A4" class="no-quick-link"></a>MemberMXBean -Member's local view of its connection and cache. It is the primary gateway to manage a particular member. It exposes member level attributes and statistics. Some operations like `createCacheServer()` and `createManager()` will help to create some Geode resources. Any JMX client can connect to the MBean server and start managing a Geode Member by using this MBean. +Member's local view of its connection and cache. It is the primary gateway to manage a particular member. It exposes member level attributes and statistics. Some operations like `createCacheServer()` and `createManager()` will help to create some <%=vars.product_name%> resources. Any JMX client can connect to the MBean server and start managing a <%=vars.product_name%> Member by using this MBean. See [MemberMXBean Notifications](list_of_mbean_notifications.html#reference_czt_hq2_vj) for a list of notifications emitted by this MBean. @@ -136,7 +136,7 @@ See the `org.apache.geode.management.MemberMXBean` JavaDocs for information on a ## <a id="topic_48194A5BDF3F40F68E95A114DD702413__section_7287A7560650426E9B8249E2D87CE55F" class="no-quick-link"></a>CacheServerMXBean -Represents the Geode CacheServer. Provides data and notifications about server, subscriptions, durable queues and indices. +Represents the <%=vars.product_name%> CacheServer. Provides data and notifications about server, subscriptions, durable queues and indices. See [CacheServerMXBean Notifications](list_of_mbean_notifications.html#cacheservermxbean_notifications) for a list of notifications emitted by this MBean. http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/management/management_and_monitoring.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/management_and_monitoring.html.md.erb b/geode-docs/managing/management/management_and_monitoring.html.md.erb index 98b18e5..35d2c4b 100644 --- a/geode-docs/managing/management/management_and_monitoring.html.md.erb +++ b/geode-docs/managing/management/management_and_monitoring.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Apache Geode Management and Monitoring ---- +<% set_title(product_name_long, "Management and Monitoring") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,33 +17,33 @@ See the License for the specific language governing permissions and limitations under the License. --> -Apache Geode provides APIs and tools for managing your distributed system and monitoring the health of your distributed system members. +<%=vars.product_name_long%> provides APIs and tools for managing your distributed system and monitoring the health of your distributed system members. -- **[Management and Monitoring Features](../../managing/management/management_and_monitoring_features.html)** +- **[Management and Monitoring Features](management_and_monitoring_features.html)** - Apache Geode uses a federated Open MBean strategy to manage and monitor all members of the distributed system. This strategy gives you a consolidated, single-agent view of the distributed system. + <%=vars.product_name_long%> uses a federated Open MBean strategy to manage and monitor all members of the distributed system. This strategy gives you a consolidated, single-agent view of the distributed system. -- **[Overview of Geode Management and Monitoring Tools](../../managing/management/mm_overview.html)** +- **[Overview of <%=vars.product_name%> Management and Monitoring Tools](mm_overview.html)** - Geode provides a variety of management tools you can use to manage a Geode distributed system. + <%=vars.product_name%> provides a variety of management tools you can use to manage a <%=vars.product_name%> distributed system. -- **[Architecture and Components](../../managing/management/management_system_overview.html)** +- **[Architecture and Components](management_system_overview.html)** - Geode's management and monitoring system consists of one JMX Manager node (there should only be one) and one or more managed nodes within a distributed system. All members in the distributed system are manageable through MBeans and Geode Management Service APIs. + <%=vars.product_name%>'s management and monitoring system consists of one JMX Manager node (there should only be one) and one or more managed nodes within a distributed system. All members in the distributed system are manageable through MBeans and <%=vars.product_name%> Management Service APIs. -- **[JMX Manager Operations](../../managing/management/jmx_manager_node.html#topic_36C918B4202D45F3AC225FFD23B11D7C)** +- **[JMX Manager Operations](jmx_manager_node.html#topic_36C918B4202D45F3AC225FFD23B11D7C)** 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. -- **[Federated MBean Architecture](../../managing/management/mbean_architecture.html)** +- **[Federated MBean Architecture](mbean_architecture.html)** - Geode uses MBeans to manage and monitor different parts of Geode. Geode's federated MBean architecture is scalable and allows you to have a single-agent view of a Geode distributed system. + <%=vars.product_name%> uses MBeans to manage and monitor different parts of <%=vars.product_name%>. <%=vars.product_name%>'s federated MBean architecture is scalable and allows you to have a single-agent view of a <%=vars.product_name%> distributed system. -- **[Configuring RMI Registry Ports and RMI Connectors](../../managing/management/configuring_rmi_connector.html)** +- **[Configuring RMI Registry Ports and RMI Connectors](configuring_rmi_connector.html)** - Geode programmatically emulates out-of-the-box JMX provided by Java and creates a JMXServiceURL with RMI Registry and RMI Connector ports on all manageable members. + <%=vars.product_name%> programmatically emulates out-of-the-box JMX provided by Java and creates a JMXServiceURL with RMI Registry and RMI Connector ports on all manageable members. -- **[Executing gfsh Commands through the Management API](../../managing/management/gfsh_and_management_api.html)** +- **[Executing gfsh Commands through the Management API](gfsh_and_management_api.html)** You can also use management APIs to execute gfsh commands programmatically. http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/management/management_and_monitoring_features.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/management_and_monitoring_features.html.md.erb b/geode-docs/managing/management/management_and_monitoring_features.html.md.erb index 1eb8c6c..425f7a1 100644 --- a/geode-docs/managing/management/management_and_monitoring_features.html.md.erb +++ b/geode-docs/managing/management/management_and_monitoring_features.html.md.erb @@ -19,18 +19,18 @@ See the License for the specific language governing permissions and limitations under the License. --> -Apache Geode uses a federated Open MBean strategy to manage and monitor all members of the distributed system. This strategy gives you a consolidated, single-agent view of the distributed system. +<%=vars.product_name_long%> uses a federated Open MBean strategy to manage and monitor all members of the distributed system. This strategy gives you a consolidated, single-agent view of the distributed system. <a id="concept_F7B9EE348DA744D3BBDFD68E7F48A604__section_37CECE9B26644505A79784EA0CD1FDAE"></a> Application and manager development is much easier because you do not have to find the right MBeanServer to make a request on an MBean. Instead, you interact with a single MBeanServer that aggregates MBeans from all other local and remote MBeanServers. -Some other key advantages and features of Geode administration architecture: +Some other key advantages and features of <%=vars.product_name%> administration architecture: -- Geode monitoring is tightly integrated into Geode's processes instead of running in a separately installed and configured monitoring agent. You can use the same framework to actually manage Geode and perform administrative operations, not just monitor it. -- All Geode MBeans are *MXBeans*. They represent useful and relevant information on the state of the distributed system and all its members. Because MXBeans use the Open MBean model with a predefined set of types, clients and remote management programs no longer require access to model-specific classes representing your MBean types. Using MXBeans adds flexibility to your selection of clients and makes the Geode management and monitoring much easier to use. +- <%=vars.product_name%> monitoring is tightly integrated into <%=vars.product_name%>'s processes instead of running in a separately installed and configured monitoring agent. You can use the same framework to actually manage <%=vars.product_name%> and perform administrative operations, not just monitor it. +- All <%=vars.product_name%> MBeans are *MXBeans*. They represent useful and relevant information on the state of the distributed system and all its members. Because MXBeans use the Open MBean model with a predefined set of types, clients and remote management programs no longer require access to model-specific classes representing your MBean types. Using MXBeans adds flexibility to your selection of clients and makes the <%=vars.product_name%> management and monitoring much easier to use. - Each member in the distributed system is manageable through MXBeans, and each member hosts its own MXBeans in a Platform MBeanServer. -- Any Geode member can be configured to provide a federated view of all the MXBeans for all members in a Geode cluster. -- Geode has also modified its use of JMX to be industry-standard and friendly to generic JMX clients. You can now easily monitor or manage the distributed system by using any third-party tool that is compliant with JMX. For example, JConsole. +- Any <%=vars.product_name%> member can be configured to provide a federated view of all the MXBeans for all members in a <%=vars.product_name%> cluster. +- <%=vars.product_name%> has also modified its use of JMX to be industry-standard and friendly to generic JMX clients. You can now easily monitor or manage the distributed system by using any third-party tool that is compliant with JMX. For example, JConsole. ## <a id="concept_F7B9EE348DA744D3BBDFD68E7F48A604__section_A3166A9657044E088DA0FE2C2B8325BE" class="no-quick-link"></a>References http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/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 13a3de0..965fe7b 100644 --- a/geode-docs/managing/management/management_system_overview.html.md.erb +++ b/geode-docs/managing/management/management_system_overview.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -Geode's management and monitoring system consists of one JMX Manager node (there should only be one) and one or more managed nodes within a distributed system. All members in the distributed system are manageable through MBeans and Geode Management Service APIs. +<%=vars.product_name%>'s management and monitoring system consists of one JMX Manager node (there should only be one) and one or more managed nodes within a distributed system. All members in the distributed system are manageable through MBeans and <%=vars.product_name%> Management Service APIs. ## <a id="concept_1BAE2CE1146B4347ABD61F50B9F9781F__section_ABE7007BE3C244FBA0418C4B5BE7E1F2" class="no-quick-link"></a>Architecture @@ -27,20 +27,20 @@ The following diagram depicts the architecture of the management and monitoring <img src="../../images_svg/JMX_Architecture.svg" id="concept_1BAE2CE1146B4347ABD61F50B9F9781F__image_1E9E8575E13D4087BC47B6A288097B7A" class="image" /> -In this architecture every Geode member is manageable. All Geode MBeans for the local Geode processes are automatically registered in the Platform MBeanServer (the default MBeanServer of each JVM that hosts platform MXBeans.) +In this architecture every <%=vars.product_name%> member is manageable. All <%=vars.product_name%> MBeans for the local <%=vars.product_name%> processes are automatically registered in the Platform MBeanServer (the default MBeanServer of each JVM that hosts platform MXBeans.) ## <a id="concept_1BAE2CE1146B4347ABD61F50B9F9781F__section_1CF2B237C16F4095A609E62F0C7146C1" class="no-quick-link"></a>Managed Node Each member of a distributed system is a managed node. Any node that is not currently also acting as a JMX Manager node is referred to simply as a managed node. A managed node has the following resources so that it can answer JMX queries both locally and remotely: -- Local MXBeans that represent the locally monitored components on the node. See [List of Geode JMX MBeans](list_of_mbeans.html#topic_4BCF867697C3456D96066BAD7F39FC8B) for a list of possible MXBeans existing for the managed node. +- Local MXBeans that represent the locally monitored components on the node. See [List of <%=vars.product_name%> JMX MBeans](list_of_mbeans.html#topic_4BCF867697C3456D96066BAD7F39FC8B) for a list of possible MXBeans existing for the managed node. - Built-in platform MBeans. ## <a id="concept_1BAE2CE1146B4347ABD61F50B9F9781F__section_8604838507194C8B86F1420FBA46894C" class="no-quick-link"></a>JMX Manager Node -A JMX Manager node is a member that can manage other Geode members --that is, other managed nodes -- as well as itself. A JMX Manager node can manage all other members in the distributed system. +A JMX Manager node is a member that can manage other <%=vars.product_name%> members --that is, other managed nodes -- as well as itself. A JMX Manager node can manage all other members in the distributed system. -To convert a managed node to a JMX Manager node, you configure the Geode property `jmx-manager=true`, in the `gemfire.properties` file, and start the member as a JMX Manager node. +To convert a managed node to a JMX Manager node, you configure the <%=vars.product_name%> property `jmx-manager=true`, in the `gemfire.properties` file, and start the member as a JMX Manager node. You start the member as a JMX Manager node when you provide` --J=-Dgemfire.jmx-manager=true` as an argument to either the` start server` or `start locator` command. See [Starting a JMX Manager](jmx_manager_operations.html#topic_686158E9AFBD47518BE1B4BEB232C190) for more information. @@ -58,15 +58,15 @@ The JMX Manager node has the following extra resources allocated so that it can ## <a id="concept_1BAE2CE1146B4347ABD61F50B9F9781F__section_32D9F98189B14AA09BAC5E843EC18EDA" class="no-quick-link"></a>JMX Integration -Management and monitoring tools such as gfsh command-line interface and Pulse use JMX/RMI as the communication layer to connect to Geode nodes. All Geode processes by default allow JMX connections to the Platform MBeanServer from localhost. By default, both managed nodes and JMX manager nodes have RMI connectors enabled to allow JMX client connections. +Management and monitoring tools such as gfsh command-line interface and Pulse use JMX/RMI as the communication layer to connect to <%=vars.product_name%> nodes. All <%=vars.product_name%> processes by default allow JMX connections to the Platform MBeanServer from localhost. By default, both managed nodes and JMX manager nodes have RMI connectors enabled to allow JMX client connections. JConsole (and other similar JMX clients that support Sun's Attach API) can connect to any local JVM without requiring an RMI connector by using the Attach API. This allows connections from the same machine. JConsole (and other JMX clients) can connect to any JVM if that JVM is configured to start an RMI connector. This allows remote connections from other machines. -JConsole can connect to any Geode member, but if it connects to a non-JMX-Manager member, JConsole only detects the local MBeans for the node, and not MBeans for the cluster. +JConsole can connect to any <%=vars.product_name%> member, but if it connects to a non-JMX-Manager member, JConsole only detects the local MBeans for the node, and not MBeans for the cluster. -When a Geode locator or server becomes a JMX Manager for the cluster, it enables the RMI connector. JConsole can then connect only to that one JVM to view the MBeans for the entire cluster. It does not need to connect to all the other JVMs. Geode manages the inter-JVM communication required to provide a federated view of all MBeans in the distributed system. +When a <%=vars.product_name%> locator or server becomes a JMX Manager for the cluster, it enables the RMI connector. JConsole can then connect only to that one JVM to view the MBeans for the entire cluster. It does not need to connect to all the other JVMs. <%=vars.product_name%> manages the inter-JVM communication required to provide a federated view of all MBeans in the distributed system. `gfsh` can only connect to a JMX Manager or to a locator. If connected to a locator, the locator provides the necessary connection information for the existing JMX Manager. If the locator detects a JMX Manager is not already running in the cluster, the locator makes itself a JMX Manager. gfsh cannot connect to other non-Manager or non-locator members. @@ -74,9 +74,9 @@ For information on how to configure the RMI registry and RMI connector, see [Con ## <a id="concept_1BAE2CE1146B4347ABD61F50B9F9781F__section_A3F9E1594982480DA019CBA3E93CA895" class="no-quick-link"></a>Management APIs -Geode management APIs represent the Geode cluster to a JMX user. However, they do not provide functionality that is otherwise present in JMX. They only provide a gateway into various services exclusively offered by Geode monitoring and management. +<%=vars.product_name%> management APIs represent the <%=vars.product_name%> cluster to a JMX user. However, they do not provide functionality that is otherwise present in JMX. They only provide a gateway into various services exclusively offered by <%=vars.product_name%> monitoring and management. -The entry point to Geode management is through the ManagementService interface. For example, to create an instance of the Management Service: +The entry point to <%=vars.product_name%> management is through the ManagementService interface. For example, to create an instance of the Management Service: ``` pre ManagementService service = ManagementService.getManagementService(cache); @@ -84,12 +84,12 @@ ManagementService service = ManagementService.getManagementService(cache); The resulting ManagementService instance is specific to the provided cache and its distributed system. The implementation of getManagementService is a singleton for now but may eventually support multiple cache instances. -You can use the Geode management APIs to accomplish the following tasks: +You can use the <%=vars.product_name%> management APIs to accomplish the following tasks: - Monitor the health status of clients. - Obtain the status and results of individual disk backups. - View metrics related to disk usage and performance for a particular member. -- Browse Geode properties set for a particular member. +- Browse <%=vars.product_name%> properties set for a particular member. - View JVM metrics such as memory, heap, and thread usage. - View network metrics, such as bytes received and sent. - View partition region attributes such as total number of buckets, redundant copy, and maximum memory information. @@ -100,13 +100,13 @@ See the JavaDocs for the `org.apache.geode.management` package for more details. You can also execute gfsh commands using the ManagementService API. See [Executing gfsh Commands through the Management API](gfsh_and_management_api.html#concept_451F0978285245E69C3E8DE795BD8635) and the JavaDocs for the `org.apache.geode.management.cli` package. -## <a id="concept_1BAE2CE1146B4347ABD61F50B9F9781F__section_E69A93A6309E4747B52850D81FE1674E" class="no-quick-link"></a>Geode Management and Monitoring Tools +## <a id="concept_1BAE2CE1146B4347ABD61F50B9F9781F__section_E69A93A6309E4747B52850D81FE1674E" class="no-quick-link"></a><%=vars.product_name%> Management and Monitoring Tools -This section lists the currently available tools for managing and monitoring Geode: +This section lists the currently available tools for managing and monitoring <%=vars.product_name%>: -- **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/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). +- **gfsh**. <%=vars.product_name_long%> command-line interface that provides a simple & powerful command shell that supports the administration, debugging and deployment of <%=vars.product_name%> 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). +- **<%=vars.product_name%> Pulse**. Easy-to-use, browser-based dashboard for monitoring <%=vars.product_name%> deployments. <%=vars.product_name%> Pulse provides an integrated view of all <%=vars.product_name%> members within a distributed system. See [<%=vars.product_name%> Pulse](../../tools_modules/pulse/pulse-overview.html). +- **Pulse Data Browser**. This <%=vars.product_name%> Pulse utility provides a graphical interface for performing OQL ad-hoc queries in a <%=vars.product_name%> 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/1b84ecbe/geode-docs/managing/management/mbean_architecture.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/mbean_architecture.html.md.erb b/geode-docs/managing/management/mbean_architecture.html.md.erb index a982701..b82348e 100644 --- a/geode-docs/managing/management/mbean_architecture.html.md.erb +++ b/geode-docs/managing/management/mbean_architecture.html.md.erb @@ -19,13 +19,13 @@ See the License for the specific language governing permissions and limitations under the License. --> -Geode uses MBeans to manage and monitor different parts of Geode. Geode's federated MBean architecture is scalable and allows you to have a single-agent view of a Geode distributed system. +<%=vars.product_name%> uses MBeans to manage and monitor different parts of <%=vars.product_name%>. <%=vars.product_name%>'s federated MBean architecture is scalable and allows you to have a single-agent view of a <%=vars.product_name%> distributed system. -## <a id="concept_40A475F186E249C597681069C835CF65__section_19948055E4184110910B11CD979A923A" class="no-quick-link"></a>Federation of Geode MBeans and MBeanServers +## <a id="concept_40A475F186E249C597681069C835CF65__section_19948055E4184110910B11CD979A923A" class="no-quick-link"></a>Federation of <%=vars.product_name%> MBeans and MBeanServers Federation of the MBeanServers means that one member, the JMX Manager Node, can provide a proxied view of all the MBeans that the MBeanServer hosts. Federation also means that operations and notifications are spread across the distributed system. -Geode federation takes care of the following functionality: +<%=vars.product_name%> federation takes care of the following functionality: - MBean proxy creation - MBean state propagation @@ -34,7 +34,7 @@ Geode federation takes care of the following functionality: ## <a id="concept_40A475F186E249C597681069C835CF65__section_AD13594ADA814194897488CF96BCC479" class="no-quick-link"></a>MBean Proxy Naming Conventions -Each Geode MBean follows a particular naming convention for easier grouping. For example: +Each <%=vars.product_name%> MBean follows a particular naming convention for easier grouping. For example: ``` pre GemFire:type=Member,service=LockService,name=<dlsName>,memberName=<memberName> @@ -52,25 +52,25 @@ GemFire:type=Member,member=<Node1> ## <a id="concept_40A475F186E249C597681069C835CF65__section_8F9D375A185E476FB50E7D6E30BE2FC7" class="no-quick-link"></a>Use of MXBeans -In its Management API, Geode provides MXBeans to ensure that any MBeans that are created are usable by any client, including remote clients, without requiring the client to access specific classes in order to access contents of the MBean. +In its Management API, <%=vars.product_name%> provides MXBeans to ensure that any MBeans that are created are usable by any client, including remote clients, without requiring the client to access specific classes in order to access contents of the MBean. ## <a id="concept_40A475F186E249C597681069C835CF65__section_DCC1B2AB80B04E8CBED041C1F3BDAB5F" class="no-quick-link"></a>MBean Proxy Creation -Geode proxies are inherently local MBeans. Every Geode JMX manager member hosts proxies pointing to the local MBeans of every managed node. Proxy MBeans will also emit any notification emitted by local MBeans in managed nodes when an event occurs in that managed node. +<%=vars.product_name%> proxies are inherently local MBeans. Every <%=vars.product_name%> JMX manager member hosts proxies pointing to the local MBeans of every managed node. Proxy MBeans will also emit any notification emitted by local MBeans in managed nodes when an event occurs in that managed node. **Note:** Aggregate MBeans on the JMX Manager node are not proxied. -- **[List of Geode JMX MBeans](../../managing/management/list_of_mbeans.html)** +- **[List of <%=vars.product_name%> JMX MBeans](../../managing/management/list_of_mbeans.html)** - This topic provides descriptions for the various management and monitoring MBeans that are available in Geode. + This topic provides descriptions for the various management and monitoring MBeans that are available in <%=vars.product_name%>. -- **[Browsing Geode MBeans through JConsole](../../managing/management/mbeans_jconsole.html)** +- **[Browsing <%=vars.product_name%> MBeans through JConsole](../../managing/management/mbeans_jconsole.html)** - You can browse all the Geode MBeans in your distributed system by using JConsole. + You can browse all the <%=vars.product_name%> MBeans in your distributed system by using JConsole. -- **[Geode JMX MBean Notifications](../../managing/management/mbean_notifications.html)** +- **[<%=vars.product_name%> JMX MBean Notifications](../../managing/management/mbean_notifications.html)** - Apache Geode MBeans emit notifications when specific events occur or if an alert is raised in the Geode system. Using standard JMX APIs, users can add notification handlers to listen for these events. + Apache <%=vars.product_name%> MBeans emit notifications when specific events occur or if an alert is raised in the <%=vars.product_name%> system. Using standard JMX APIs, users can add notification handlers to listen for these events. http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/management/mbean_notifications.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/mbean_notifications.html.md.erb b/geode-docs/managing/management/mbean_notifications.html.md.erb index bf1a799..c76bd4d 100644 --- a/geode-docs/managing/management/mbean_notifications.html.md.erb +++ b/geode-docs/managing/management/mbean_notifications.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Geode JMX MBean Notifications ---- +<% set_title(product_name, "JMX MBean Notifications") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -21,7 +19,7 @@ limitations under the License. <a id="topic_czt_hq2_vk"></a> -Apache Geode MBeans emit notifications when specific events occur or if an alert is raised in the Geode system. Using standard JMX APIs, users can add notification handlers to listen for these events. +<%=vars.product_name_long%> MBeans emit notifications when specific events occur or if an alert is raised in the <%=vars.product_name%> system. Using standard JMX APIs, users can add notification handlers to listen for these events. - **[Notification Federation](notification_federation_and_alerts.html)** @@ -29,6 +27,6 @@ Apache Geode MBeans emit notifications when specific events occur or if an alert - **[List of JMX MBean Notifications](list_of_mbean_notifications.html)** - This topic lists all available JMX notifications emitted by Geode MBeans. + This topic lists all available JMX notifications emitted by <%=vars.product_name%> MBeans. http://git-wip-us.apache.org/repos/asf/geode/blob/1b84ecbe/geode-docs/managing/management/mbeans_jconsole.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/managing/management/mbeans_jconsole.html.md.erb b/geode-docs/managing/management/mbeans_jconsole.html.md.erb index 88dde64..2e607fa 100644 --- a/geode-docs/managing/management/mbeans_jconsole.html.md.erb +++ b/geode-docs/managing/management/mbeans_jconsole.html.md.erb @@ -1,6 +1,4 @@ ---- -title: Browsing Geode MBeans through JConsole ---- +<% set_title("Browsing", product_name, "MBeans through JConsole") %> <!-- Licensed to the Apache Software Foundation (ASF) under one or more @@ -19,9 +17,9 @@ See the License for the specific language governing permissions and limitations under the License. --> -You can browse all the Geode MBeans in your distributed system by using JConsole. +You can browse all the <%=vars.product_name%> MBeans in your distributed system by using JConsole. -To view Geode MBeans through JConsole, perform the following steps: +To view <%=vars.product_name%> MBeans through JConsole, perform the following steps: 1. Start a `gfsh` prompt. 2. Connect to a running distributed system by either connecting to a locator with an embedded JMX Manager or connect directly to a JMX Manager. For example: @@ -46,7 +44,7 @@ To view Geode MBeans through JConsole, perform the following steps: 4. On the JConsole screen, click on the MBeans tab. Expand **GemFire**. Then expand each MBean to browse individual MBean attributes, operations and notifications. - The following is an example screenshot of the MBean hierarchy in a Geode distributed system: + The following is an example screenshot of the MBean hierarchy in a <%=vars.product_name%> distributed system: <img src="../../images/jconsole_mbeans.png" id="concept_492532E145834248997BD23BCAC7AD45__image_7A45BE69B67A44A7A8AD40343A2B0AEB" class="image" />
