Carsten Ziegeler created SLING-10976:
----------------------------------------
Summary: Add options to disable usage of request parameters
Key: SLING-10976
URL: https://issues.apache.org/jira/browse/SLING-10976
Project: Sling
Issue Type: Improvement
Components: Health Check
Reporter: Carsten Ziegeler
Fix For: Health Check Core 1.2.12
Currently the execution of the health check servlet can be controlled via
request parameters. While this is nice, there are scenarios where this is not
wanted and the endpoint should exactly report as configured.
For this an OSGi configuration like 'disableRequestConfiguration' could be set
to true and then most request parameters are ignored. Currently we have the
param list [1] in the html rendering, At least the output format should still
be controllable via parameters
[1]
Supported URL parameters
tags:Comma-separated list of health checks tags to select - can also be
specified via path, e.g. /system/health/tag1,tag2.json. Exclusions can be done
by prepending '-' to the tag name
names:Comma-separated list of health check names to select. Exclusions can be
done by prepending '-' to the health check name
format:Output format, html|json|jsonp|txt - an extension in the URL overrides
this
httpStatus:Specify HTTP result code, for example CRITICAL:503 (status 503 if
result >= CRITICAL) or CRITICAL:503,HEALTH_CHECK_ERROR:500,OK:418 for more
specific HTTP status
combineTagsWithOr:Combine tags with OR, active by default. Set to false to
combine with AND
forceInstantExecution:If true, forces instant execution by executing async
health checks directly, circumventing the cache (2sec by default) of the
HealthCheckExecutor
timeout:(msec) a timeout status is returned for any health check still running
after this period. Overrides the default HealthCheckExecutor timeout
hcDebug:Include the DEBUG output of the Health Checks
callback:name of the JSONP callback function to use, defaults to
processHealthCheckResults
[2]
https://github.com/apache/felix-dev/blob/master/healthcheck/core/src/main/java/org/apache/felix/hc/core/impl/servlet/HealthCheckExecutorServletConfiguration.java
--
This message was sent by Atlassian Jira
(v8.20.1#820001)
