Author: buildbot
Date: Tue Aug 13 13:44:49 2013
New Revision: 874469
Log:
Staging update by buildbot for sling
Modified:
websites/staging/sling/trunk/content/ (props changed)
websites/staging/sling/trunk/content/documentation/bundles/sling-health-check-tool.html
Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Aug 13 13:44:49 2013
@@ -1 +1 @@
-1513478
+1513486
Modified:
websites/staging/sling/trunk/content/documentation/bundles/sling-health-check-tool.html
==============================================================================
---
websites/staging/sling/trunk/content/documentation/bundles/sling-health-check-tool.html
(original)
+++
websites/staging/sling/trunk/content/documentation/bundles/sling-health-check-tool.html
Tue Aug 13 13:44:49 2013
@@ -88,14 +88,17 @@
<p>Based on simple <code>HealthCheck</code> OSGi services, the Sling
Health Check Tool ("hc" in short form) is used to
check the health of live Sling systems, based on inputs like JMX MBean
attribute values, OSGi framework
information, Sling requests status, etc.</p>
-<p>Health checks are easily extensible either by configuring the supplied
default <code>HealthCheck</code> services, or
-by implementing your own services. </p>
+<p>Health checks are easily extensible either by configuring the supplied
default <code>HealthCheck</code> services, by
+supplying MBeans that expose the required attributes, or by implementing your
own <code>HealthCheck</code> services. </p>
<p>The source code of the hc modules is at <a
href="http://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/healthcheck";>http://svn.apache.org/repos/asf/sling/trunk/contrib/extensions/healthcheck</a>.</p>
<h2 id="whats-a-healthcheck">What's a <code>HealthCheck</code> ?</h2>
<p>A <code>HealthCheck</code> is just an OSGi service that returns a
<code>Result</code>.</p>
<div class="codehilite"><pre><span class="n">public</span> <span
class="n">interface</span> <span class="n">HealthCheck</span> <span
class="p">{</span>
- <span class="o">/**</span> <span class="n">Execute</span> <span
class="n">this</span> <span class="n">health</span> <span
class="n">check</span> <span class="n">and</span> <span class="k">return</span>
<span class="n">a</span> <span class="p">{@</span><span class="n">link</span>
<span class="n">Result</span><span class="p">}</span> <span class="o">*/</span>
+ <span class="o">/**</span> <span class="n">Execute</span> <span
class="n">this</span> <span class="n">health</span> <span
class="n">check</span> <span class="n">and</span> <span class="k">return</span>
<span class="n">a</span> <span class="p">{@</span><span class="n">link</span>
<span class="n">Result</span><span class="p">}</span>
+ <span class="o">*</span> <span class="n">This</span> <span
class="n">is</span> <span class="n">meant</span> <span class="n">to</span>
<span class="n">execute</span> <span class="n">quickly</span><span
class="p">,</span> <span class="n">access</span> <span class="n">to</span>
<span class="n">external</span>
+ <span class="o">*</span> <span class="n">systems</span><span
class="p">,</span> <span class="k">for</span> <span
class="n">example</span><span class="p">,</span> <span class="n">should</span>
<span class="n">be</span> <span class="n">managed</span> <span
class="n">asynchronously</span><span class="p">.</span>
+ <span class="o">*/</span>
<span class="n">public</span> <span class="n">Result</span> <span
class="n">execute</span><span class="p">();</span>
<span class="o">/**</span> <span class="n">Additional</span> <span
class="p">(</span><span class="n">static</span><span class="p">)</span> <span
class="n">information</span> <span class="n">about</span>
@@ -109,7 +112,7 @@ by implementing your own services. </p>
<p>The Result provides a <em>Status</em> (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 <code>HealthCheck</code>s are free to invent their own types of
logging messages
-if needed. See the <code>org.apache.sling.hc.api.Result</code> class for more
details. </p>
+if needed. See the <code>org.apache.sling.hc.api.Result</code> class and its
tests for more details. </p>
<p><code>HealthCheck</code> services can be selected for execution based on
their <code>hc.tags</code> multi-value service property. </p>
<p>The <code>HealthCheckFilter</code> utility accepts positive and negative
tag parameters, so that <code>-security,sling</code>
selects all <code>HealthCheck</code> having the <code>sling</code> tag but not
the <code>security</code> tag, for example.</p>
@@ -135,7 +138,8 @@ as described below.</p>
<li><code>CompositeHealthCheck</code> executes a set of
<code>HealthCheck</code> selected by tags, useful for creating higher-level
checks.</li>
</ul>
<h2 id="configuring-health-checks">Configuring health checks</h2>
-<p><code>HealthCheck</code> services are created via OSGi configurations.</p>
+<p><code>HealthCheck</code> services are created via OSGi configurations, the
details of which are defined by each
+service implementation.</p>
<p>Here's a <code>ScriptableHealthCheck</code> example configuration provided
by the <code>org.apache.sling.hc.samples</code> bundle:</p>
<div class="codehilite"><pre><span class="n">Factory</span> <span
class="n">PID</span> <span class="p">=</span> <span class="n">org</span><span
class="p">.</span><span class="n">apache</span><span class="p">.</span><span
class="n">sling</span><span class="p">.</span><span class="n">hc</span><span
class="p">.</span><span class="n">ScriptableHealthCheck</span>
<span class="n">PID</span> <span class="p">=</span> <span
class="n">org</span><span class="p">.</span><span class="n">apache</span><span
class="p">.</span><span class="n">sling</span><span class="p">.</span><span
class="n">hc</span><span class="p">.</span><span
class="n">ScriptableHealthCheck</span><span class="p">.</span>1523<span
class="n">a6db</span><span class="o">-</span>12324
@@ -152,7 +156,7 @@ as described below.</p>
<h2 id="webconsole-plugin">Webconsole plugin</h2>
<p>If the <code>org.apache.sling.hc.webconsole</code> bundle is active, a
webconsole plugin
at <code>/system/console/healthcheck</code> allows for executing health
checks, optionally selected
-based on their tags (positive and negative selection, see
<code>HealthCheckFilter</code> mention above).</p>
+based on their tags (positive and negative selection, see the
<code>HealthCheckFilter</code> mention above).</p>
<p>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.</p>
<p>The screenshot below shows an example, as of svn revision 1513462.</p>
@@ -167,7 +171,7 @@ which by default is <em>HealthCheck</em>
<p>See the example configurations of the
<code>org.apache.sling.hc.samples</code> for more details.</p>
<p><img alt="" src="jconsole-hc.jpg" /></p>
<div class="timestamp" style="margin-top: 30px; font-size: 80%;
text-align: right;">
- Rev. 1513478 by bdelacretaz on Tue, 13 Aug 2013 13:31:42 +0000
+ Rev. 1513486 by bdelacretaz on Tue, 13 Aug 2013 13:44:42 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache
Sling project
