clustering.js 3.1 KB

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