index.js 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. const path = require('path');
  2. const debug = require('debug')('log4js:appenders');
  3. const configuration = require('../configuration');
  4. const clustering = require('../clustering');
  5. const levels = require('../levels');
  6. const layouts = require('../layouts');
  7. const adapters = require('./adapters');
  8. // pre-load the core appenders so that webpack can find them
  9. const coreAppenders = new Map();
  10. coreAppenders.set('console', require('./console'));
  11. coreAppenders.set('stdout', require('./stdout'));
  12. coreAppenders.set('stderr', require('./stderr'));
  13. coreAppenders.set('logLevelFilter', require('./logLevelFilter'));
  14. coreAppenders.set('categoryFilter', require('./categoryFilter'));
  15. coreAppenders.set('noLogFilter', require('./noLogFilter'));
  16. coreAppenders.set('file', require('./file'));
  17. coreAppenders.set('dateFile', require('./dateFile'));
  18. coreAppenders.set('fileSync', require('./fileSync'));
  19. coreAppenders.set('tcp', require('./tcp'));
  20. const appenders = new Map();
  21. const tryLoading = (modulePath, config) => {
  22. debug('Loading module from ', modulePath);
  23. try {
  24. return require(modulePath); //eslint-disable-line
  25. } catch (e) {
  26. // if the module was found, and we still got an error, then raise it
  27. configuration.throwExceptionIf(
  28. config,
  29. e.code !== 'MODULE_NOT_FOUND',
  30. `appender "${modulePath}" could not be loaded (error was: ${e})`
  31. );
  32. return undefined;
  33. }
  34. };
  35. const loadAppenderModule = (type, config) => coreAppenders.get(type)
  36. || tryLoading(`./${type}`, config)
  37. || tryLoading(type, config)
  38. || (require.main && tryLoading(path.join(path.dirname(require.main.filename), type), config))
  39. || tryLoading(path.join(process.cwd(), type), config);
  40. const appendersLoading = new Set();
  41. const getAppender = (name, config) => {
  42. if (appenders.has(name)) return appenders.get(name);
  43. if (!config.appenders[name]) return false;
  44. if (appendersLoading.has(name)) throw new Error(`Dependency loop detected for appender ${name}.`);
  45. appendersLoading.add(name);
  46. debug(`Creating appender ${name}`);
  47. // eslint-disable-next-line no-use-before-define
  48. const appender = createAppender(name, config);
  49. appendersLoading.delete(name);
  50. appenders.set(name, appender);
  51. return appender;
  52. };
  53. const createAppender = (name, config) => {
  54. const appenderConfig = config.appenders[name];
  55. const appenderModule = appenderConfig.type.configure
  56. ? appenderConfig.type : loadAppenderModule(appenderConfig.type, config);
  57. configuration.throwExceptionIf(
  58. config,
  59. configuration.not(appenderModule),
  60. `appender "${name}" is not valid (type "${appenderConfig.type}" could not be found)`
  61. );
  62. if (appenderModule.appender) {
  63. process.emitWarning(
  64. `Appender ${appenderConfig.type} exports an appender function.`,
  65. "DeprecationWarning", "log4js-node-DEP0001"
  66. );
  67. debug(`DEPRECATION: Appender ${appenderConfig.type} exports an appender function.`);
  68. }
  69. if (appenderModule.shutdown) {
  70. process.emitWarning(
  71. `Appender ${appenderConfig.type} exports a shutdown function.`,
  72. "DeprecationWarning", "log4js-node-DEP0002"
  73. );
  74. debug(`DEPRECATION: Appender ${appenderConfig.type} exports a shutdown function.`);
  75. }
  76. debug(`${name}: clustering.isMaster ? ${clustering.isMaster()}`);
  77. debug(`${name}: appenderModule is ${require('util').inspect(appenderModule)}`); // eslint-disable-line
  78. return clustering.onlyOnMaster(() => {
  79. debug(`calling appenderModule.configure for ${name} / ${appenderConfig.type}`);
  80. return appenderModule.configure(
  81. adapters.modifyConfig(appenderConfig),
  82. layouts,
  83. appender => getAppender(appender, config),
  84. levels
  85. );
  86. }, () => { });
  87. };
  88. const setup = (config) => {
  89. appenders.clear();
  90. appendersLoading.clear();
  91. const usedAppenders = [];
  92. Object.values(config.categories).forEach(category => {
  93. usedAppenders.push(...category.appenders);
  94. });
  95. Object.keys(config.appenders).forEach((name) => {
  96. // dodgy hard-coding of special case for tcp-server and multiprocess which may not have
  97. // any categories associated with it, but needs to be started up anyway
  98. if (usedAppenders.includes(name) || config.appenders[name].type === 'tcp-server'
  99. || config.appenders[name].type === 'multiprocess') {
  100. getAppender(name, config);
  101. }
  102. });
  103. };
  104. const init = () => {
  105. setup({ appenders: { out: { type: 'stdout' } }, categories: { default: { appenders: ['out'], level: 'trace' } } });
  106. };
  107. init();
  108. configuration.addListener((config) => {
  109. configuration.throwExceptionIf(
  110. config,
  111. configuration.not(configuration.anObject(config.appenders)),
  112. 'must have a property "appenders" of type object.'
  113. );
  114. const appenderNames = Object.keys(config.appenders);
  115. configuration.throwExceptionIf(
  116. config,
  117. configuration.not(appenderNames.length),
  118. 'must define at least one appender.'
  119. );
  120. appenderNames.forEach((name) => {
  121. configuration.throwExceptionIf(
  122. config,
  123. configuration.not(config.appenders[name].type),
  124. `appender "${name}" is not valid (must be an object with property "type")`
  125. );
  126. });
  127. });
  128. configuration.addListener(setup);
  129. module.exports = appenders;
  130. module.exports.init = init;