Promex

Prometheus client initialization package for express

Usage

Promex is a utility to initialize the Promster library. Install the package and see the example below

import * as promex from '@bpinternal/promex';
import express from 'express';

const backend = express();
const admin = express();

[...]

promex.init(backend); // Adds a recording middleware on the express app
promex.init(admin); // Adds a recording middleware on the express app

[...]

promex.start() // Starts a metrics server on port 9090

Promex can also be used with an handler on an express app

import * as promex from '@bpinternal/promex';
import express from 'express';

const app = express()

app.get('/metrics', promex.handler()) // Adds a '/metrics' endpoint that returns the Prometheus metrics

promex.init(app) // Adds a recording middleware on the express app

[...]

app.listen()

Disclaimer ⚠️

This package is published under the @bpinternal organization. All packages of this organization are meant to be used by the Botpress team internally and are not meant for our community. Since the packages are catered to our own use-cases, they might have less stable APIs, receive breaking changes without much warning, have minimal documentation and lack community-focused support. However, these packages were still left intentionally public for an important reason : We Love Open-Source. Therefore, if you wish to install or fork this package feel absolutly free to do it. We strongly recommend that you tag your versions properly.

The Botpress Engineering team.