[ 
https://issues.apache.org/jira/browse/JAMES-2575?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Tellier Benoit closed JAMES-2575.
---------------------------------

> Perform a single healthcheck
> ----------------------------
>
>                 Key: JAMES-2575
>                 URL: https://issues.apache.org/jira/browse/JAMES-2575
>             Project: James Server
>          Issue Type: New Feature
>          Components: webadmin
>    Affects Versions: master
>            Reporter: Tellier Benoit
>            Priority: Major
>              Labels: feature
>
> Currently, JAMES-2563 proposes additional healthchecks.
> Thus we will need, using the webAdmin API to be able to execute single 
> healthchecks.
> Here is the corresponding user story:
> {code:java}
> As an admin,
> Using the webadmin protocol
> I can check a single health check (for instance Guice starting status)
> {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-unsubscr...@james.apache.org
For additional commands, e-mail: server-dev-h...@james.apache.org

Reply via email to