Author: cziegeler
Date: Mon Aug 19 10:51:20 2013
New Revision: 1515353
URL: http://svn.apache.org/r1515353
Log:
Update jmx docs
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=1515353&r1=1515352&r2=1515353&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
Mon Aug 19 10:51:20 2013
@@ -20,12 +20,6 @@ A `HealthCheck` is just an OSGi service
* systems, for example, should be managed asynchronously.
*/
public Result execute();
-
- /** Additional (static) information about
- * this check. {@link Constants} defines
- * some well-known property names.
- */
- 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
@@ -91,15 +85,10 @@ The screenshot below shows an example, a

## JMX access to health checks
-If the `org.apache.sling.hc.jmx` bundle is active, a JMX MBean is created for
each `HealthCheck`.
+If the `org.apache.sling.hc.jmx` bundle is active, a JMX MBean is created for
each `HealthCheck` which has the service property 'hc.mbean.name' service
property set. All health check MBeans are registered in the domain
'org.apache.sling.healthcheck' with a type of 'HealthCheck'
The MBean gives access to the `Result` and the log, as shown on the screenshot
below.
-The MBean name defaults to the `hc.name` service property of the
_`HealthCheck`_, but if an
-`hc.mbean.name` property is provided it is used instead. That property can
include a a slash
-(like `CompositeHealthCheck/script` in the screenshot) to define the MBean
service name,
-which by default is _HealthCheck_.
-
See the example configurations of the `org.apache.sling.hc.samples` for more
details.

\ No newline at end of file