svn commit: r1856900 - /felix/trunk/healthcheck/README.md

[gh...@apache.org]

Author: ghenzler
Date: Wed Apr  3 19:26:29 2019
New Revision: 1856900

URL: http://svn.apache.org/viewvc?rev=1856900&view=rev
Log:
Added documentation for AdjustableStatusHealthCheck

Modified:
    felix/trunk/healthcheck/README.md

Modified: felix/trunk/healthcheck/README.md
URL: http://svn.apache.org/viewvc/felix/trunk/healthcheck/README.md?rev=1856900&r1=1856899&r2=1856900&view=diff
==============================================================================
--- felix/trunk/healthcheck/README.md (original)
+++ felix/trunk/healthcheck/README.md Wed Apr  3 19:26:29 2019
@@ -161,6 +161,9 @@ Thread Usage | org.apache.felix.hc.gener
 JMX Attribute Check | org.apache.felix.hc.generalchecks.JmxAttributeCheck | yes | Allows to check an arbitrary JMX attribute (using the configured mbean `mbean.name`'s attribute `attribute.name`) against a given constraint `attribute.value.constraint`. Can check multiple attributes by providing additional config properties with numbers:  `mbean2.name`' `attribute2.name` and `attribute2.value.constraint`.
 HttpRequestsCheck | org.apache.felix.hc.generalchecks.HttpRequestsCheck | yes | Allows to check a list of URLs against response code, response headers, timing, response content (plain content via RegEx or JSON via path expression).
 
+### Adjustable Status Health Check
+
+This is a health check that can be dynamically controlled via JMX bean `org.apache.felix.healthcheck:type=AdjustableStatusHealthCheck`. It allows to dynamically add a health check that returns `WARN` (operation `addWarnResultForTags(String)`), `CRITICAL` (operation `addCriticalResultForTags(String)`) or `TEMPORARILY_UNAVAILABLE` (operation `addTemporarilyUnavailableResultForTags(String)`) for certain tags. This is useful for testing purposes or go-live sequences. The operation `reset()` removes the dynamic result again.
 
 ## Executing Health Checks