index.js 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107
  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. const appenders = new Map();
  19. const tryLoading = (modulePath, config) => {
  20. debug('Loading module from ', modulePath);
  21. try {
  22. return require(modulePath); //eslint-disable-line
  23. } catch (e) {
  24. // if the module was found, and we still got an error, then raise it
  25. configuration.throwExceptionIf(
  26. config,
  27. e.code !== 'MODULE_NOT_FOUND',
  28. `appender "${modulePath}" could not be loaded (error was: ${e})`
  29. );
  30. return undefined;
  31. }
  32. };
  33. const loadAppenderModule = (type, config) => coreAppenders.get(type)
  34. || tryLoading(`./${type}`, config)
  35. || tryLoading(type, config)
  36. || (require.main && tryLoading(path.join(path.dirname(require.main.filename), type), config))
  37. || tryLoading(path.join(process.cwd(), type), config);
  38. const createAppender = (name, config) => {
  39. const appenderConfig = config.appenders[name];
  40. const appenderModule = appenderConfig.type.configure
  41. ? appenderConfig.type : loadAppenderModule(appenderConfig.type, config);
  42. configuration.throwExceptionIf(
  43. config,
  44. configuration.not(appenderModule),
  45. `appender "${name}" is not valid (type "${appenderConfig.type}" could not be found)`
  46. );
  47. if (appenderModule.appender) {
  48. debug(`DEPRECATION: Appender ${appenderConfig.type} exports an appender function.`);
  49. }
  50. if (appenderModule.shutdown) {
  51. debug(`DEPRECATION: Appender ${appenderConfig.type} exports a shutdown function.`);
  52. }
  53. debug(`${name}: clustering.isMaster ? ${clustering.isMaster()}`);
  54. debug(`${name}: appenderModule is ${require('util').inspect(appenderModule)}`); // eslint-disable-line
  55. return clustering.onlyOnMaster(() => {
  56. debug(`calling appenderModule.configure for ${name} / ${appenderConfig.type}`);
  57. return appenderModule.configure(
  58. adapters.modifyConfig(appenderConfig),
  59. layouts,
  60. appender => appenders.get(appender),
  61. levels
  62. );
  63. }, () => {});
  64. };
  65. const setup = (config) => {
  66. appenders.clear();
  67. Object.keys(config.appenders).forEach((name) => {
  68. debug(`Creating appender ${name}`);
  69. appenders.set(name, createAppender(name, config));
  70. });
  71. };
  72. setup({ appenders: { out: { type: 'stdout' } } });
  73. configuration.addListener((config) => {
  74. configuration.throwExceptionIf(
  75. config,
  76. configuration.not(configuration.anObject(config.appenders)),
  77. 'must have a property "appenders" of type object.'
  78. );
  79. const appenderNames = Object.keys(config.appenders);
  80. configuration.throwExceptionIf(
  81. config,
  82. configuration.not(appenderNames.length),
  83. 'must define at least one appender.'
  84. );
  85. appenderNames.forEach((name) => {
  86. configuration.throwExceptionIf(
  87. config,
  88. configuration.not(config.appenders[name].type),
  89. `appender "${name}" is not valid (must be an object with property "type")`
  90. );
  91. });
  92. });
  93. configuration.addListener(setup);
  94. module.exports = appenders;