Author: bdelacretaz
Date: Thu Sep 26 09:29:49 2013
New Revision: 1526427
URL: http://svn.apache.org/r1526427
Log:
use cases and slideshare links added
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=1526427&r1=1526426&r2=1526427&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
Thu Sep 26 09:29:49 2013
@@ -7,7 +7,22 @@ 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.
-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).
+See also:
+
+ * Source code at
[http://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/healthcheck](http://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/healthcheck).
+ * adaptTo 2013 slides about Health Checks at
[http://www.slideshare.net/bdelacretaz/slinghc-bdelacretazadaptto2013](http://www.slideshare.net/bdelacretaz/slinghc-bdelacretazadaptto2013)
+
+## Use cases
+Health checks can be used for various purposes, for example:
+
+ * Verify that performance counters are in range.
+ * Run smoke tests at system startup and emit warnings or disable the
instance if they fail.
+ * Check that all OSGi bundles are up and running
+ * Check that demo content has been removed from a production system
+ * Check that demo accounts are disabled
+ * Ping external systems and raise alarms if they are down
+
+The health check subsystem uses tags to execute groups of health checks for
specific purposes.
## What's a `HealthCheck` ?
@@ -115,4 +130,4 @@ The MBean gives access to the `Result` a
See the example configurations of the `org.apache.sling.hc.samples` for more
details.
-<img src="jconsole-hc.jpg" style="max-width:700px" alt="JConsole showing Sling
Health Check MBeans"/>
+<img src="jconsole-hc.jpg" style="max-width:700px" alt="JConsole showing Sling
Health Check MBeans"/>
\ No newline at end of file
