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

[bd...@apache.org]

Author: bdelacretaz
Date: Tue Aug 13 13:44:42 2013
New Revision: 1513486

URL: http://svn.apache.org/r1513486
Log:
SLING-2987 - health check docs tweaks

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=1513486&r1=1513485&r2=1513486&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 Aug 13 13:44:42 2013
@@ -4,8 +4,8 @@ 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, or
-by implementing your own services.  
+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.  
 
 The source code of the hc modules is at [http://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/healthcheck](http://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/healthcheck).
 
@@ -15,7 +15,10 @@ A `HealthCheck` is just an OSGi service 
 
     public interface HealthCheck {
         
-        /** Execute this health check and return a {@link Result} */
+        /** Execute this health check and return a {@link Result} 
+         *  This is meant to execute quickly, access to external
+         *  systems, for example, should be managed asynchronously.
+         */
         public Result execute();
         
         /** Additional (static) information about
@@ -25,10 +28,9 @@ A `HealthCheck` is just an OSGi service 
         public Map<String, String> getInfo();
     }
 
-
 The Result provides a _Status_ (OK, WARN, CRITICAL etc.) and a human-readable log which provides additional info, including optional DEBUG messages
 that help troubleshooting. The Result log is not stricly tied to a logging model, so `HealthCheck`s are free to invent their own types of logging messages
-if needed. See the `org.apache.sling.hc.api.Result` class for more details. 
+if needed. See the `org.apache.sling.hc.api.Result` class and its tests for more details. 
 
 `HealthCheck` services can be selected for execution based on their `hc.tags` multi-value service property. 
 
@@ -60,7 +62,8 @@ The `org.apache.sling.hc.samples` bundle
  * `CompositeHealthCheck` executes a set of `HealthCheck` selected by tags, useful for creating higher-level checks.
 
 ## Configuring health checks
-`HealthCheck` services are created via OSGi configurations.
+`HealthCheck` services are created via OSGi configurations, the details of which are defined by each
+service implementation.
 
 Here's a `ScriptableHealthCheck` example configuration provided by the `org.apache.sling.hc.samples` bundle:
 
@@ -78,7 +81,7 @@ The service properties starting with the
 ## Webconsole plugin
 If the `org.apache.sling.hc.webconsole` bundle is active, a webconsole plugin 
 at `/system/console/healthcheck` allows for executing health checks, optionally selected
-based on their tags (positive and negative selection, see `HealthCheckFilter` mention above).
+based on their tags (positive and negative selection, see the `HealthCheckFilter` mention above).
 
 The DEBUG logs of health checks can optionally be displayed, and an option allows for showing only health
 checks that have a non-OK status.