@instana/collector/src/tracing/instrumentation/process/edgemicro.js

The Instana Node.js metrics and trace data collector

/*
 * (c) Copyright IBM Corp. 2021
 * (c) Copyright Instana Inc. and contributors 2020
 */

'use strict';

const cluster = require('cluster');

const hook = require('@instana/core').util.hook;
const selfPath = require('./selfPath');

/** @type {import('@instana/core/src/core').GenericLogger} */
let logger;

/**
 * @param {import('@instana/core/src/util/normalizeConfig').InstanaConfig} config
 */
exports.init = function (config) {
  logger = config.logger;

  hook.onFileLoad(/\/edgemicro\/cli\/lib\/reload-cluster.js/, instrumentReloadCluster);
};

/**
 * This instruments the code that is responsible for starting the cluster of edgemicro workers that handle HTTP
 * requests, when edgemicro is started via `edgemicro start`. It adds --require /path/to/@instana/collecor/src/immediate
 * to the arguments, effectively adding Instana instrumentation to the worker processes at the earliest possible moment.
 *
 * There is also ./childProcess.js, which is responsible for instrumenting the code path that is used with
 * `edgemicro forever -a start`.
 *
 * @param {*} reloadClusterModule
 * @returns {*}
 */
function instrumentReloadCluster(reloadClusterModule) {
  return function () {
    if (!selfPath.immediate) {
      logger.warn(
        // eslint-disable-next-line max-len
        "Detected a call to 'edgemicro/cli/lib/reload-cluster', but the path to @instana/collector is not available, so the edgemicro workers will not be instrumented."
      );
      return reloadClusterModule.apply(this, arguments);
    }

    // Deliberately not using the isActive pattern here because the edgemicro workers are started immediately by the
    // edgemicro CLI, before the connection to the Instana agent is established (and thus isActive becoming true).
    const clusterManager = reloadClusterModule.apply(this, arguments);

    // See https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/59229
    // https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/node/cluster.d.ts
    // @ts-expect-error :-/
    cluster.settings.execArgv = cluster.settings.execArgv || [];

    // @ts-expect-error :-/
    for (let i = 0; i < cluster.settings.execArgv.length; i++) {
      // @ts-expect-error :-/
      if (cluster.settings.execArgv[i].indexOf('--require') >= 0) {
        return clusterManager;
      }
    }

    logger.debug(
      // eslint-disable-next-line max-len
      `Detected a call to 'edgemicro/cli/lib/reload-cluster', instrumenting edgemicro workers by adding --require ${selfPath.immediate} to cluster.settings.execArgv.`
    );

    // @ts-expect-error :-/
    cluster.settings.execArgv.push('--require');

    // @ts-expect-error :-/
    cluster.settings.execArgv.push(selfPath.immediate);

    return clusterManager;
  };
}

exports.activate = function () {
  // no-op
};

exports.deactivate = function () {
  // no-op
};