svn commit: r1794499 - /sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext

[gh...@apache.org]

Author: ghenzler
Date: Tue May  9 06:00:18 2017
New Revision: 1794499

URL: http://svn.apache.org/viewvc?rev=1794499&view=rev
Log:
Fixed layout and further little improvements

Modified:
    sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext

Modified: sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext
URL: http://svn.apache.org/viewvc/sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext?rev=1794499&r1=1794498&r2=1794499&view=diff
==============================================================================
--- sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext (original)
+++ sling/site/trunk/content/documentation/bundles/sling-health-check-tool.mdtext Tue May  9 06:00:18 2017
@@ -4,8 +4,11 @@ Based on simple `HealthCheck` OSGi servi
 check the health of live Sling systems, based on inputs like JMX MBean attribute values, OSGi framework 
 information, Sling requests status, etc.
 
-Health checks are easily extensible either by configuring the supplied default `HealthCheck` services, by
-supplying MBeans that expose the required attributes, or by implementing your own `HealthCheck` services.  
+Health checks are easily extensible either by configuring the supplied default `HealthCheck` services, or 
+by implementing your own `HealthCheck` services to cater for project specific requirements.
+
+However for simple setups, the out of the box health checks are often sufficient. [Executing Health Checks](#executing-health-checks)
+is a good starting point to run existing checks and to get familiar with how health checks work.
 
 See also:
 
@@ -14,6 +17,7 @@ See also:
 
 ## Use cases
 Generally health checks have two high level use cases:
+
 * Operations teams checking sling instances for their internal state manually
 * Load balancers can query the health of a sling instance and decide to take it out or back into the list of used backends automatically
 
@@ -66,15 +70,6 @@ can provide more info about what, if any
         ... details omitted
     } 
 
-## Executing Health Checks
-
-Health Checks can be executed via a [webconsole plugin](#webconsoleplugin), the [health check servlet](#healthcheckservlet) or via [JMX](#jmxaccesstohealthchecks). `HealthCheck` services can be selected for execution based on their `hc.tags` multi-value service property. 
-
-The `HealthCheckFilter` utility accepts positive and negative tag parameters, so that `-security,sling` 
-selects all `HealthCheck` having the `sling` tag but not the `security` tag, for example.
-
-For advanced use cases it is also possible to use the API directly by using the interface `org.apache.sling.hc.api.execution.HealthCheckExecutor`.
-
 ### SlingHealthCheck annotation
 The `SlingHealthCheck` annotation makes it easier to specify the required `HealthCheck` service properties.
 
@@ -94,6 +89,15 @@ Here's an example from the `samples` mod
         }
     }
 
+## Executing Health Checks
+
+Health Checks can be executed via a [webconsole plugin](#webconsole-plugin), the [health check servlet](#health-check-servlet) or via [JMX](#jmx-access-to-health-checks). `HealthCheck` services can be selected for execution based on their `hc.tags` multi-value service property. 
+
+The `HealthCheckFilter` utility accepts positive and negative tag parameters, so that `-security,sling` 
+selects all `HealthCheck` having the `sling` tag but not the `security` tag, for example.
+
+For advanced use cases it is also possible to use the API directly by using the interface `org.apache.sling.hc.api.execution.HealthCheckExecutor`.
+
 ## Health Check bundles
 The Health Check subsystem consists of the following bundles: