Check out the related section in the new documentation

Process Metrics

Process Metrics

By plugging process metrics onto your code, you will be able to monitor in-code values, in realtime.

First make sure you added the pmx library to your code:

npm install pmx --save

Then in your code:

var Probe = require('pmx').probe();

var counter = 0;

var metric = Probe.metric({
  name    : 'Counter',
  value   : function() {
    return counter;

setInterval(function() {
}, 100);

Start the application with PM2. To consult the process metrics, use the command:

pm2 show <application-name>

process metrics

Metrics helper available

Then you can program your very own metrics to track important informations. 4 differents probes are available:

  • Simple metrics: Values that can be read instantly
    • eg. Monitor variable value
  • Counter: Things that increment or decrement
    • eg. Downloads being processed, user connected
  • Meter: Things that are measured as events / interval
    • eg. Request per minute for a http server
  • Histogram: Keeps a resevoir of statistically relevant values biased towards the last 5 minutes to explore their distribution
    • eg. Monitor the mean of execution of a query into database

Simple Metric: Simple value reporting

This allows to expose values that can be read instantly.

var probe = pmx.probe();

// Here the value function will be called each second to get the value
var metric = probe.metric({
  name    : 'Realtime user',
  value   : function() {
    return Object.keys(users).length;

// Here we are going to call valvar.set() to set the new value
var valvar = probe.metric({
  name    : 'Realtime Value'


Counter: Sequential value change

Values that increment or decrement.

var probe = pmx.probe();

// The counter will start at 0
var counter = probe.counter({
  name : 'Current req processed'

http.createServer(function(req, res) {
  // Increment the counter, counter will eq 1;
  req.on('end', function() {
    // Decrement the counter, counter will eq 0

Meter: Average calculated values

Values that are measured as events / interval.

var probe = pmx.probe();

var meter = probe.meter({
  name      : 'req/min',
  samples   : 1,
  timeframe : 60

http.createServer(function(req, res) {


samples option is the rate unit. Defaults to 1 sec. timeframe option is the timeframe over which events will be analyzed. Defaults to 60 sec.


Keeps a resevoir of statistically relevant values biased towards the last 5 minutes to explore their distribution.

var probe = pmx.probe();

var histogram = probe.histogram({
  name        : 'latency',
  measurement : 'mean'

var latency = 0;

setInterval(function() {
  latency = Math.round(Math.random() * 100);
}, 100);

Common Custom Metrics options

  • name : The probe name as is will be displayed on the Keymetrics dashboard
  • agg_type : This param is optionnal, it can be sum, max, min, avg (default) or none. It will impact the way the probe data are aggregated within the Keymetrics backend. Use none if this is irrelevant (eg: constant or string value).
  • alert : For Meter and Counter probes. This param is optionnal. Creates an alert object (see below).

Notification System

A notification system allows you to trigger (email, slack, webhook…) alerts when a monitored value crosses a threshold. When setting a threshold value, the color on the dashboard changes from green to red depending on the alert level!

You can either programmatically parameter this limit or do it via the dashboard by clicking on the button “Alert”.

Example for a cpu_usage var:

var metric = probe.metric({
  name  : 'CPU usage',
  value : function() {
    return cpu_usage;
  alert : {
    mode  : 'threshold',
    value : 95,
    msg   : 'Detected over 95% CPU usage', // optional
    action: function() { //optional
      console.error('Detected over 95% CPU usage');
    cmp   : function(value, threshold) { //optional
      return (parseFloat(value) > threshold); // default check


  • mode : threshold, threshold-avg, smart.
  • value : Value that will be used for the exception check.
  • msg : String used for the exception.
  • action : optional. Function triggered when exception reached.
  • cmp : optional. Function used for exception check taking 2 arguments.
  • interval : optional, threshold-avg mode. Sample length for monitored value (180 seconds default).
  • timeout : optional, threshold-avg mode. Time after which mean comparison starts (30 000 milliseconds default).

Builtin custom Metrics

When initializing pmx, you can set to true some options:

  • network option will display inbound and outbound traffic
  • ports will display ports your application is using
var pmx = require('pmx').init({
  network       : true,  // Network monitoring at the application level
  ports         : true,  // Shows which ports your app is listening on (default: false)

Read more

Exposing Node.js process metrics using PM2 and PMX.