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

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

Tellier Benoit created JAMES-2576:
-------------------------------------

             Summary: 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: Tellier Benoit


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/checks/Cassandra%40Backend
{code}

Will return 


{code:java}
{
  "componentName": "Cassandra Backend",
  "escapedComponentName": "Cassandra%40Backend",
  "status": "Healthy"
  "cause": null
}
{code}

or


{code:java}
{
  "componentName": "Cassandra Backend",
  "escapedComponentName": "Cassandra%40Backend",
  "status": "Unhealthy"
  "cause": "Can not execute a Cassandra sample query over the application driver session"
}
{code}

Here is a few implementation details. In webadmin-core maven project:

 - Create a HeathCheckExecutionResultDTO including above fields
 - Implement the route in HealthCheckRoutes
 - 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
(v7.6.3#76005)

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