You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@sling.apache.org by bd...@apache.org on 2015/08/12 16:15:07 UTC

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

Author: bdelacretaz
Date: Wed Aug 12 14:15:07 2015
New Revision: 1695530

URL: http://svn.apache.org/r1695530
Log:
SLING-4862 - Health Checks Servlet

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=1695530&r1=1695529&r2=1695530&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 Wed Aug 12 14:15:07 2015
@@ -163,6 +163,21 @@ See the example configurations of the `o
 
 ![JConsole showing Sling Health Check MBeans](jconsole-hc.jpg)
 
+## Health Checks Servlet
+Starting with version 1.2.4 of the `org.apache.sling.hc.core` bundle, a flexible Health Checks execution servlet is available. It provides
+similar features to the Web Console plugin described above, with output in HTML, JSON, JSONP and TXT formats.
+
+The Health Checks Servlet is disabled by default, to enable it create an OSGi configuration like
+
+  PID = org.apache.sling.hc.core.impl.servlet.HealthCheckExecutorServlet
+  servletPath = /system/health
+
+which specifies the servlet's base path. That URL then returns an HTML page, by default with the results of all active health checks and
+with instructions at the end of the page about which URL parameters can be used to select specific Health Checks and control their execution
+and output format.
+
+Note that *the Health Checks Servlet doesn't do any access control by itself*, so make sure the configured path is secure before enabling it.
+
 ## Health Checks as server-side JUnit tests
 The `org.apache.sling.hc.junit.bridge` bundle makes selected Health Checks available as server-side JUnit tests.