An open API service indexing awesome lists of open source software.

https://github.com/redhat-developer/devfile-sample

Devfile Example for OpenShift Console
https://github.com/redhat-developer/devfile-sample

Last synced: 6 months ago
JSON representation

Devfile Example for OpenShift Console

Awesome Lists containing this project

README

          

# nodejs-starter

This is a sample starter project that provides you with a basic Express app and a sample test in a `/src/test` sub directory. This sample project uses `Express v4.17.x` and enables health checking and application metrics out of the box. You can override or enhance the following endpoints by configuring your own health checks in your application.

## Health checking

Health-checking enables the cloud platform to determine the `readiness` and `liveness` of your application.

These endpoints will be available for you to use:

- Readiness endpoint: http://localhost:3000/ready
- Liveness endpoint: http://localhost:3000/live

## Application metrics

The [prom-client](https://www.npmjs.com/package/prom-client) module will collect a wide range of resource-centric (CPU, memory) and application-centric (HTTP request responsiveness) metrics from your application, and then expose them as multi-dimensional time-series data through an application endpoint for Prometheus to scrape and aggregate.

This endpoints will be available for you to use:

- Metrics endpoint: http://localhost:3000/metrics

## License

This stack is licensed under the [EPL 2.0](./LICENSE) license.