Skip to content

WSE-research/React-online-status-of-Spring-Boot-web-services

Repository files navigation

Service Health Status Check

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.

Installation

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

Usage Examples

Basic Example

Health Check for type="admin"

Admin Actuator

Health Check for type="basic"

Basic Actuator

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

Working examples can be found in the examples directory:

FAQ

We will collect and answer frequently asked questions here: