pm2-cluster-prometheus-next v2.0.5

pm2-cluster-prometheus-next

PM2 module to aggregate node.js workers' metrics when use pm2 cluster mode

fixes for last version

Install

$ pm2 install pm2-cluster-prometheus-next

Configuration

Default settings:

  "config": {
        "auth_token": "",         // request token, disabled if empty string
        "app_name": "api,data",        // Name of the APP(s) to pull monitoring data from, multiple can be specified separated by commas
        "host": '127.0.0.1',           // Default HTTP service host, provides /metrics and /online interfaces
        "port": 4000,                  // Default HTTP service port, provides /metrics and /online interfaces
        "reigster_disabled": false,    // Whether to disable service registration to consul
        "consul_host": "127.0.0.1",
        "consul_port": "8500",
        "register_mode": "cluster"     // default: cluster   other: worker
        "limit": 100000                // info limit
    }

To modify the config values you can use the following commands:

pm2 set pm2-cluster-prometheus-next:app_name hello
pm2 set pm2-cluster-prometheus-next:port 4000

Mode

"register_mode": "cluster" get metrics from http://localhost:3000/metrics

"register_mode": "worker" get each worker metrics from http://localhost:3000/metrics?pm_id=1

Node.js APP

// prom-client version require >= 11.0.0
const promClient = require('prom-client')

process.on('message', function (message) {
    if (message.type === 'prom:getMetricsReq') {
        process.send({
            type: 'prom:getMetricsRes',
            data: {
                requestId: message.data.requestId,
                metrics: promClient.register.getMetricsAsJSON()
            }
        })
    }
})

Uninstall

$ pm2 uninstall pm2-cluster-prometheus-next

License

MIT