Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
[gateway] [management-api] Healthcheck #543
As soon as an API consumer is meeting a problem, they tend to say first that the problem come from the api management solution (as the response is delivered from the gateways).
Plus as "Product Owner" of the gravitee solution, i'll be in charge to monitor and also debug sometimes the solution, if a component (the repository for example) fails, how can i found the issue quickly?
In order to be able to do a quick diagnostic of the gateway and/or the management api, we advise that these components implements a healthcheck endpoint.
For example for the api management, when i call the healthcheck endpoint, it will return something like :
If everything is ok, the status code is 200, but as soon as at least one component is unhealthy, then the status code will be 500.
For example :
The healthcheck endpoint will require an authentication header (that must be checked too, as the Authentication Server is part of the management api components)
You can have a look to http://metrics.dropwizard.io/, they provide some components health check implementations.