express-cloudfoundry-actuator-middleware

Express actuator middleware for Cloud Foundry Applications

Usage no npm install needed!

<script type="module">
  import expressCloudfoundryActuatorMiddleware from 'https://cdn.skypack.dev/express-cloudfoundry-actuator-middleware';
</script>

README

express-cloudfoundry-actuator-middleware

Build Status Dependency Status DevDependency Status Npm downloads Npm Version Git tag Github issues License

ExpressJS actuator middleware for NodeJS Cloud Foundry Applications.

Currently provides health and info endpoints for Cloud Foundry Apps Manager. These two and future Endpoints are restricted to users that

  • are currently logged into the Apps Manager and
  • have sufficient privileges to view sensitive information.

Use Cloud Foundry Actuator CLI to generate a build info file ahead of deployment time. This file is optional, but we can't show version infos without it.

Health status will be shown automatically and will be costumizable in the future.

See Express Cloud Foundry Actuator Middleware Example for an example application with full integration of Cloud Foundry Actuator CLI and Express Cloud Foundry Actuator Middleware.

Installation

npm install express-cloudfoundry-actuator-middleware --save

Example

'use strict'

const express = require('express')
const app = express()

const actuator = require('express-cloudfoundry-actuator-middleware')

// ...

app.use(actuator())

// ...

Screenshots

App overview

Cloud Foundry App overview with Health Check

Settings with app short info

Cloud Foundry App settings with short app info

Settings with app info popup

Cloud Foundry App settings with app info popup

License

This project is distributed under the MIT license.