[jira] [Commented] (JAMES-2576) Aggregation healthcheck should have a body

["Benoit Tellier (Jira)" <se...@james.apache.org>]

    [ https://issues.apache.org/jira/browse/JAMES-2576?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16991058#comment-16991058 ] 

Benoit Tellier commented on JAMES-2576:
---------------------------------------

https://github.com/linagora/james-project/pull/2957 contributed some changes regarding health check status code:
 - 503 instead of 500 for unhealthy status.
 - 200 instead of 500 for degraded status.


> Aggregation healthcheck should have a body
> ------------------------------------------
>
>                 Key: JAMES-2576
>                 URL: https://issues.apache.org/jira/browse/JAMES-2576
>             Project: James Server
>          Issue Type: New Feature
>          Components: webadmin
>    Affects Versions: master
>            Reporter: Benoit Tellier
>            Priority: Major
>              Labels: feature
>             Fix For: 3.3.0
>
>
> Currently, JAMES-2563 proposes additional healthchecks. The current aggregation healthcheck only exposes a status code.
> Thus we will need, it to return a useful body, to help diagnose what is hapening.
> Here is the corresponding user story:
> {code:java}
> As an admin,
> Using the webadmin protocol
> When calling the aggregation health check (current `/healthcheck`)
> I can read a detailed report in the answer payload
> (allow to diagnose the answer)
> {code}
> Here is the route we proposes to add to the current endpoints:
> {code:java}
> GET /healthcheck
> {code}
> Will return 
> {code:java}
> {
>   "status": "Healthy",
>   "checks": [
>     {
>       "componentName": "Cassandra Backend",
>       "escapedComponentName": "Cassandra%40Backend",
>       "status": "Healthy",
>       "cause": null
>     },
>     ...
>   ]
> }
> {code}
> Here is a few implementation details. In webadmin-core maven project:
>  - Create a HeathCheckAggregationExecutionResultDTO including above fields
>  - Modify the HealthCheckRoutes::validateHealthchecks method
>  - Document in with swagger annotations and in src/site/markdown/server/manage-webadmin.md
> If you do have any questions, reach us on gitter: https://gitter.im/apache/james-project



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: server-dev-unsubscribe@james.apache.org
For additional commands, e-mail: server-dev-help@james.apache.org