You want to monitor your Spring Boot (or other ones implementing the /health
endpoint) applications in a React web application? Then, you are at the right place.
A straightforward plugin for checking the status of a Spring Boot web service.
This is a package that is intended to be used with React, so React needs to be installed.
Type declarations are provided in the package and no other dependencies are needed.
Using npm
: npm i @qanary/spring-boot-health-check
Using yarn
: yarn add @qanary/spring-boot-health-check
Health Check for type="admin"
Health Check for type="basic"
Use the following React component parameters to monitoring a Webservice being deployed to http://localhost:8000:
<SpringBootHealthCheck
// The host of the spring boot application
springBootAppUrl="http://localhost:8000"
// The interval in milliseconds for checking the health status
checkInterval={10000}
// The HTML class property of the component
className={"health-check"}
// Enable to use the default styling, disable and add custom classes for custom styling
shouldUseDefaultStyling
// The kind of health check that will be performed
// Default is "actuator" for regular spring boot actuator health endpoints
// "admin" is for HTTP Basic password-protected Stardog endpoints
// "basic" is for a dumb request to the provided URL verifying the response is ok
type={"basic"}
/>
Example for overwriting the colours:
:root {
--ok-color: rgb(122, 123, 0) !important;
--problem-color: blue !important;
--offline-color: rgb(11, 11, 11) !important;
}
Working examples can be found in the examples directory:
We will collect and answer frequently asked questions here:
-
How to deal with CORS issues? > Use a package like [https://www.npmjs.com/package/local-cors-proxy](https://www.npmjs.com/package/local-cors-proxy). > We’ve tested and reviewed version 1.1.0 and it seems to be a relatively minimal solution to this issue. > Simply set the
springBootAppUrl
property to the proxy URL and use thetitle
property to easily see which instance monitors which service.