A JobTech Project

Check Connectivity

This is a small node module that helps you monitor the health of your web service.

• Versions
• Interface Diagram
• Getting Started
  • Step 1: Acquire this package
  • Step 2: Configure and start embedded server
  • Step 3: Install middleware
  • Step 4: Graceful shutdown of embedded server
• Routes
  • /health
    • Input parameters
    • Example HTTP request
    • Example HTTP response
  • /checkCompatability
    • Input parameters
    • Example HTTP request
    • Example HTTP response
• Contributing
• License
• Acknowledgments

Versions

1.0.1-beta

Interface diagram

Getting started

Step 1: Acquire this package

This module has not yet been published to NPM, therefore we suggest you install it directly from this GitHub repository.

npm install git+https://[email protected]/MagnumOpuses/check-connectivity

Step 2: Configure and start embedded server

// Start up the health server
const healthServer = new require("check-connectivity")({
  port: 9801, // Optional configuration property, default 9800.
  compatibleWith: {
    "other-service": "^1.0.0", // <service name>: "<service version>"
    "another-service": "^2.0.0" // <service name>: "<service version>"
  }
}).listen();

⚠️ A general recommendation is to not publically expose the operational port of the health server (default port: 9800).

Step 3: Install middleware

The health middleware serves an endpoint (/checkCompatability) that allows other external services to call and verify version compatability.

Install the check-connectivity middleware into your own Express server.

// Your Express app
const app = require("express")(); // A sample Express app.

// Install middleware into your main express app.
// This enables the route "/checkCompatability"
app.use(health.middleware());

Step 4: Graceful shutdown of embedded server

// Graceful shutdown of embedded server
healthServer.shutdown();

---

Routes

Route	Method	Location	Description
/health	GET	Embedded server	This endpoint presents the current health state of this application. In general, this endpoint is not intended to be served to be public.
/checkCompatability	GET	Your Express server(as middleware)	This endpoint will return a positive response if the provided query parameters (name and version) satisfies the compatible semver range defined in options upon instantiation of this module.

/health

Input parameters

None

Example HTTP request

$ curl http://localhost:3000/health

Example HTTP response

{
  "name": "af-connect-demo",
  "version": "1.0.0-beta",
  "status": "UP",
  "uptime": 29.517,
  "compatibleWith": {
    "af-connect": "^1.0.0-beta",
    "af-portability": "^1.0.0-beta",
    "error": []
  },
  "dependencies": {
    "log": [
      "check-dependencies: installed: 1.1.0, expected: ^1.1.0",
      "dotenv: installed: 8.1.0, expected: ^8.1.0",
      "ejs: installed: 2.7.1, expected: ^2.7.1",
      "express: installed: 4.17.1, expected: ^4.17.1",
      "request: installed: 2.88.0, expected: ^2.88.0",
      "request-promise: installed: 4.2.4, expected: ^4.2.4",
      "semver: installed: 7.1.3, expected: ^7.1.3",
      "nodemon: installed: 1.19.2, expected: ^1.19.2"
    ],
    "error": [],
    "depsWereOk": true,
    "status": 0
  }
}

/checkCompatability

Input parameters

Parameter name	Parameter type	Usage description
name	Query	Name of the calling service (e.g. sample-web-service)
version	Query	Version of the calling service (e.g. 3.11.5-beta)

Example HTTP request

$ curl http://localhost:3000/checkCompatability?name=foo&version=1.2.3

Example HTTP response

{
  "result": true
}

Contributing

We would love if you'd like to help us build and improve this product for the benefit of everyone. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

Any contributions, feedback and suggestions are more than welcome.

Please read our guidelines for contribution here.

License

Apache License 2.0

Acknowledgments

No acknowledgments yet.