clustering.js 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105
  1. const debug = require('debug')('log4js:clustering');
  2. const LoggingEvent = require('./LoggingEvent');
  3. const configuration = require('./configuration');
  4. let disabled = false;
  5. let cluster = null;
  6. try {
  7. // eslint-disable-next-line global-require
  8. cluster = require('cluster');
  9. } catch (e) {
  10. debug('cluster module not present');
  11. disabled = true;
  12. }
  13. const listeners = [];
  14. let pm2 = false;
  15. let pm2InstanceVar = 'NODE_APP_INSTANCE';
  16. const isPM2Master = () => pm2 && process.env[pm2InstanceVar] === '0';
  17. const isMaster = () =>
  18. disabled || (cluster && cluster.isMaster) || isPM2Master();
  19. const sendToListeners = (logEvent) => {
  20. listeners.forEach((l) => l(logEvent));
  21. };
  22. // in a multi-process node environment, worker loggers will use
  23. // process.send
  24. const receiver = (worker, message) => {
  25. // prior to node v6, the worker parameter was not passed (args were message, handle)
  26. debug('cluster message received from worker ', worker, ': ', message);
  27. if (worker.topic && worker.data) {
  28. message = worker;
  29. worker = undefined;
  30. }
  31. if (message && message.topic && message.topic === 'log4js:message') {
  32. debug('received message: ', message.data);
  33. const logEvent = LoggingEvent.deserialise(message.data);
  34. sendToListeners(logEvent);
  35. }
  36. };
  37. if (!disabled) {
  38. configuration.addListener((config) => {
  39. // clear out the listeners, because configure has been called.
  40. listeners.length = 0;
  41. ({
  42. pm2,
  43. disableClustering: disabled,
  44. pm2InstanceVar = 'NODE_APP_INSTANCE',
  45. } = config);
  46. debug(`clustering disabled ? ${disabled}`);
  47. debug(`cluster.isMaster ? ${cluster && cluster.isMaster}`);
  48. debug(`pm2 enabled ? ${pm2}`);
  49. debug(`pm2InstanceVar = ${pm2InstanceVar}`);
  50. debug(`process.env[${pm2InstanceVar}] = ${process.env[pm2InstanceVar]}`);
  51. // just in case configure is called after shutdown
  52. if (pm2) {
  53. process.removeListener('message', receiver);
  54. }
  55. if (cluster && cluster.removeListener) {
  56. cluster.removeListener('message', receiver);
  57. }
  58. if (disabled || config.disableClustering) {
  59. debug('Not listening for cluster messages, because clustering disabled.');
  60. } else if (isPM2Master()) {
  61. // PM2 cluster support
  62. // PM2 runs everything as workers - install pm2-intercom for this to work.
  63. // we only want one of the app instances to write logs
  64. debug('listening for PM2 broadcast messages');
  65. process.on('message', receiver);
  66. } else if (cluster && cluster.isMaster) {
  67. debug('listening for cluster messages');
  68. cluster.on('message', receiver);
  69. } else {
  70. debug('not listening for messages, because we are not a master process');
  71. }
  72. });
  73. }
  74. module.exports = {
  75. onlyOnMaster: (fn, notMaster) => (isMaster() ? fn() : notMaster),
  76. isMaster,
  77. send: (msg) => {
  78. if (isMaster()) {
  79. sendToListeners(msg);
  80. } else {
  81. if (!pm2) {
  82. msg.cluster = {
  83. workerId: cluster.worker.id,
  84. worker: process.pid,
  85. };
  86. }
  87. process.send({ topic: 'log4js:message', data: msg.serialise() });
  88. }
  89. },
  90. onMessage: (listener) => {
  91. listeners.push(listener);
  92. },
  93. };