pmx/lib/pmx.js

PM2/Keymetrics advanced API

var Events      = require('./events.js');
var Actions     = require('./actions.js');
var Notify      = require('./notify.js');
var Transaction = require('./transaction.js');
var Network     = require('./network.js');
var Monitor     = require('./monitor.js');
var Profiling   = require('./probes/profiling.js');
var Inspector   = require('./probes/event-loop-inspector.js');
var Probe       = require('./Probe.js');
var Dependencies = require('./dependencies.js');
var DeepMetrics = require('./probes/deep_metrics')

var Configuration   = require('./configuration.js');

var util        = require('util');

var PMX      = {};

/**
 * Flatten API
 */
Object.assign(PMX, Events);
Object.assign(PMX, Actions);
Object.assign(PMX, Notify);
Object.assign(PMX, Monitor);
Object.assign(PMX, Configuration);
Object.assign(PMX, Probe);
Object.assign(PMX, Network);
Object.assign(PMX, Profiling);
Object.assign(PMX, Inspector);
Object.assign(PMX, Transaction);
Object.assign(PMX, DeepMetrics)

// Grab defaut configuration
PMX._pmx_conf = Configuration.init({}, true);

PMX.init = function(opts) {
  if (!opts) opts = {};

  opts = Object.assign({
    default_actions : true,
    transactions  : false,
    http          : true,
    http_latency  : 200,
    http_code     : 500,
    ignore_routes : [],
    profiling     : true,
    errors        : true,
    // By default if you add alert subfield in custom
    // it's going to be enabled
    alert_enabled : true,
    custom_probes : true,
    network       : false,
    ports         : false,
    collectDependencies : false,

    // VXX options
    // ignoreFilter.url is aliased to ignore_routes
    ignoreFilter: {
      'url': [],
      'method': ['OPTIONS']
    },
    // 'express', 'hapi', 'http', 'restify'
    excludedHooks: []
  }, opts);

  opts = Configuration.init(opts);
  this._pmx_conf = opts;

  if (opts.ports)
    PMX.catchPorts();
  if (opts.network)
    PMX.catchTraffic();

  if (opts.transactions)
    PMX.tracing(PMX, opts);
  if (opts.http)
    PMX.http(opts);

  if (opts.collectDependencies) {
    var __td = setTimeout(function() {
      Dependencies.collect();
    }, 2000);

    __td.unref();
  }

  PMX.catchAll(opts);

  if (opts.profiling) {
    Profiling.v8Profiling(PMX);
  }

  if (opts.event_loop_dump) {
    Inspector.eventLoopDump(PMX);
  }

  if (opts.v8) {
    require('./probes/v8.js')(PMX);
  }

  if (opts.custom_probes === true) {
    // Event loop monitoring
    require('./probes/loop_delay.js')(PMX)
    require('./probes/handles_requests.js')(PMX)
  }

  if (opts.deep_metrics === true) {
    // deep metrics
    DeepMetrics.enable(PMX)
  }

  if (opts.default_actions == true) {
    //require('./actions/default.js')(PMX);
  }

  opts.isModule = false;
  return this;
};

PMX.initModule = function(opts, cb) {
  if (!opts) opts = {};

  opts = Object.assign({
    alert_enabled    : true,
    widget           : {}
  }, opts);

  opts.widget = Object.assign({
    type : 'generic',
    logo : 'https://app.keymetrics.io/img/logo/keymetrics-300.png',
    theme            : ['#111111', '#1B2228', '#807C7C', '#807C7C']
  }, opts.widget);

  opts.isModule = true;
  opts = Configuration.init(opts);

  // Force error catching
  PMX.catchAll();

  this._pmx_conf = opts;

  if (cb && typeof(cb) == 'function')
    return cb(null, opts);

  return opts;
};

PMX.getConf = function() {
  return this._pmx_conf;
};

PMX.getEnv = function() {
  return process.env;
};

/**
 * Export
 */
module.exports = PMX;