From 3d48c1c13adbe046643a952b1ddfce30c6cc0a97 Mon Sep 17 00:00:00 2001 From: =?utf8?q?J=C3=A9r=C3=B4me=20Benoit?= Date: Sun, 11 Jun 2023 17:37:43 +0200 Subject: [PATCH] feat: move logging configuration into its own section MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Close #348 Signed-off-by: Jérôme Benoit --- README.md | 27 +-- docker/config.json | 13 +- src/assets/config-template.json | 12 +- src/performance/PerformanceStatistics.ts | 6 +- src/types/ConfigurationData.ts | 26 ++- src/types/index.ts | 1 + src/utils/Configuration.ts | 240 +++++++++++++---------- src/utils/Logger.ts | 28 +-- 8 files changed, 205 insertions(+), 148 deletions(-) diff --git a/README.md b/README.md index 04771de2..feafefac 100644 --- a/README.md +++ b/README.md @@ -98,24 +98,15 @@ But the modifications to test have to be done to the files in the build target d **src/assets/config.json**: -| Key | Value(s) | Default Value | Value type | Description | -| -------------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| supervisionUrls | | [] | string \| string[] | string or array of global connection URIs to OCPP-J servers | -| supervisionUrlDistribution | round-robin/random/charging-station-affinity | charging-station-affinity | boolean | supervision urls distribution policy to simulated charging stations | -| logStatisticsInterval | | 60 | integer | seconds between charging stations statistics output in the logs | -| logEnabled | true/false | true | boolean | enable logging | -| logConsole | true/false | false | boolean | output logs on the console | -| logFormat | | simple | string | [winston](https://github.com/winstonjs/winston) log format | -| logRotate | true/false | true | boolean | enable daily log files rotation | -| logMaxFiles | x/"xd" where x is an integer | undefined | integer \| string | maximum number of log files: https://github.com/winstonjs/winston-daily-rotate-file#options | -| logMaxSize | x/"xk"/"xm"/"xg" where x is a number | undefined | number \| string | maximum size of log files in bytes, or units of kb, mb, and gb: https://github.com/winstonjs/winston-daily-rotate-file#options | -| logLevel | emerg/alert/crit/error/warning/notice/info/debug | info | string | [winston](https://github.com/winstonjs/winston) logging level | -| logFile | | combined.log | string | log file relative path | -| logErrorFile | | error.log | string | error log file relative path | -| worker | | {
"processType": "workerSet",
"startDelay": 500,
"elementStartDelay": 0,
"elementsPerWorker": 1,
"poolMinSize": 4,
"poolMaxSize": 16,
"poolStrategy": "ROUND_ROBIN"
} | {
processType: WorkerProcessType;
startDelay: number;
elementStartDelay: number;
elementsPerWorker: number;
poolMinSize: number;
poolMaxSize: number;
poolStrategy: WorkerChoiceStrategy;
} | Worker configuration section:
- processType: worker threads process type (workerSet/staticPool/dynamicPool)
- startDelay: milliseconds to wait at worker threads startup (only for workerSet threads process type)
- elementStartDelay: milliseconds to wait at charging station startup
- elementsPerWorker: number of charging stations per worker threads for the `workerSet` process type
- poolMinSize: worker threads pool minimum number of threads
- poolMaxSize: worker threads pool maximum number of threads
- poolStrategy: worker threads pool [poolifier](https://github.com/poolifier/poolifier) worker choice strategy | -| uiServer | | {
"enabled": false,
"type": "ws",
"options": {
"host": "localhost",
"port": 8080
}
} | {
enabled: boolean;
type: ApplicationProtocol;
options: ServerOptions;
authentication: {
enabled: boolean;
type: AuthenticationType;
username: string;
password: string;
}
} | UI server configuration section | -| performanceStorage | | {
"enabled": false,
"type": "jsonfile",
"file:///performanceRecords.json"
} | {
enabled: boolean;
type: string;
URI: string;
}
where type can be 'jsonfile' or 'mongodb' | performance storage configuration section | -| stationTemplateUrls | | {}[] | {
file: string;
numberOfStations: number;
}[] | array of charging station configuration templates URIs configuration section (charging station configuration template file name and number of stations) | +| Key | Value(s) | Default Value | Value type | Description | +| -------------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| supervisionUrls | | [] | string \| string[] | string or array of global connection URIs to OCPP-J servers | +| supervisionUrlDistribution | round-robin/random/charging-station-affinity | charging-station-affinity | string | supervision urls distribution policy to simulated charging stations | +| log | | {
"enabled": true,
"file": "logs/combined.log",
"errorFile": "logs/error.log",
"statisticsInterval": 60,
"level": "info",
"console": false,
"format": "simple",
"rotate": true
} | {
enabled: boolean;
file: string;
errorFile: string;
statisticsInterval: number;
level: string;
console: boolean;
format: string;
rotate: boolean;
maxFiles: string \| number;
maxSize: string \| number;
} | Log configuration section:
- enabled: enable logging
- file: log file relative path
- errorFile: error log file relative path
- statisticsInterval: seconds between charging stations statistics output in the logs
- level: emerg/alert/crit/error/warning/notice/info/debug [winston](https://github.com/winstonjs/winston) logging level
- console: output logs on the console
- format: [winston](https://github.com/winstonjs/winston) log format
- rotate: enable daily log files rotation
- maxFiles: maximum number of log files: https://github.com/winstonjs/winston-daily-rotate-file#options
- maxSize: maximum size of log files in bytes, or units of kb, mb, and gb: https://github.com/winstonjs/winston-daily-rotate-file#options | +| worker | | {
"processType": "workerSet",
"startDelay": 500,
"elementStartDelay": 0,
"elementsPerWorker": 1,
"poolMinSize": 4,
"poolMaxSize": 16,
"poolStrategy": "ROUND_ROBIN"
} | {
processType: WorkerProcessType;
startDelay: number;
elementStartDelay: number;
elementsPerWorker: number;
poolMinSize: number;
poolMaxSize: number;
poolStrategy: WorkerChoiceStrategy;
} | Worker configuration section:
- processType: worker threads process type (workerSet/staticPool/dynamicPool)
- startDelay: milliseconds to wait at worker threads startup (only for workerSet threads process type)
- elementStartDelay: milliseconds to wait at charging station startup
- elementsPerWorker: number of charging stations per worker threads for the `workerSet` process type
- poolMinSize: worker threads pool minimum number of threads
- poolMaxSize: worker threads pool maximum number of threads
- poolStrategy: worker threads pool [poolifier](https://github.com/poolifier/poolifier) worker choice strategy | +| uiServer | | {
"enabled": false,
"type": "ws",
"options": {
"host": "localhost",
"port": 8080
}
} | {
enabled: boolean;
type: ApplicationProtocol;
options: ServerOptions;
authentication: {
enabled: boolean;
type: AuthenticationType;
username: string;
password: string;
}
} | UI server configuration section | +| performanceStorage | | {
"enabled": false,
"type": "jsonfile",
"file:///performanceRecords.json"
} | {
enabled: boolean;
type: string;
URI: string;
}
where type can be 'jsonfile' or 'mongodb' | performance storage configuration section | +| stationTemplateUrls | | {}[] | {
file: string;
numberOfStations: number;
}[] | array of charging station configuration templates URIs configuration section (charging station configuration template file name and number of stations) | #### Worker process model diff --git a/docker/config.json b/docker/config.json index 003ee3e1..7808b07c 100644 --- a/docker/config.json +++ b/docker/config.json @@ -1,6 +1,12 @@ { "supervisionUrls": ["ws://server:8010/OCPP16/5c866e81a2d9593de43efdb4"], "supervisionUrlDistribution": "round-robin", + "log": { + "file": "/dev/stdout", + "errorFile": "/dev/stderr", + "console": false, + "rotate": false + }, "worker": { "processType": "workerSet", "elementsPerWorker": 1, @@ -35,10 +41,5 @@ "file": "virtual-simple-atg.station-template.json", "numberOfStations": 10 } - ], - "logRotate": false, - "logConsole": false, - "logFile": "/dev/stdout", - "logErrorFile": "/dev/stderr", - "logStatisticsInterval": 60 + ] } diff --git a/src/assets/config-template.json b/src/assets/config-template.json index e1620aa7..a875173f 100644 --- a/src/assets/config-template.json +++ b/src/assets/config-template.json @@ -1,6 +1,12 @@ { "supervisionUrls": ["ws://localhost:8010/OCPP16/5be7fb271014d90008992f06"], "supervisionUrlDistribution": "round-robin", + "log": { + "file": "logs/combined.log", + "errorFile": "logs/error.log", + "maxFiles": 7, + "statisticsInterval": 0 + }, "worker": { "processType": "workerSet", "elementsPerWorker": 1, @@ -42,9 +48,5 @@ "file": "schneider.station-template.json", "numberOfStations": 1 } - ], - "logStatisticsInterval": 0, - "logMaxFiles": 7, - "logFile": "combined.log", - "logErrorFile": "error.log" + ] } diff --git a/src/performance/PerformanceStatistics.ts b/src/performance/PerformanceStatistics.ts index 565ef6e7..a111eb45 100644 --- a/src/performance/PerformanceStatistics.ts +++ b/src/performance/PerformanceStatistics.ts @@ -165,7 +165,9 @@ export class PerformanceStatistics { } private startLogStatisticsInterval(): void { - const logStatisticsInterval = Configuration.getLogStatisticsInterval(); + const logStatisticsInterval = Configuration.getLog().enabled + ? Configuration.getLog().statisticsInterval + : 0; if (logStatisticsInterval > 0 && !this.displayInterval) { this.displayInterval = setInterval(() => { this.logStatistics(); @@ -179,7 +181,7 @@ export class PerformanceStatistics { logStatisticsInterval )}` ); - } else { + } else if (Configuration.getLog().enabled) { logger.info( `${this.logPrefix()} log interval is set to ${logStatisticsInterval?.toString()}. Not logging statistics` ); diff --git a/src/types/ConfigurationData.ts b/src/types/ConfigurationData.ts index a23940cf..a244aa45 100644 --- a/src/types/ConfigurationData.ts +++ b/src/types/ConfigurationData.ts @@ -19,6 +19,19 @@ export type StationTemplateUrl = { numberOfStations: number; }; +export type LogConfiguration = { + enabled?: boolean; + file?: string; + errorFile?: string; + statisticsInterval?: number; + level?: string; + console?: boolean; + format?: string; + rotate?: boolean; + maxFiles?: string | number; + maxSize?: string | number; +}; + export type UIServerConfiguration = { enabled?: boolean; type?: ApplicationProtocol; @@ -51,9 +64,10 @@ export type ConfigurationData = { supervisionUrls?: string | string[]; supervisionUrlDistribution?: SupervisionUrlDistribution; stationTemplateUrls: StationTemplateUrl[]; + log?: LogConfiguration; + worker?: WorkerConfiguration; uiServer?: UIServerConfiguration; performanceStorage?: StorageConfiguration; - worker?: WorkerConfiguration; autoReconnectMaxRetries?: number; /** @deprecated Moved to worker configuration section. */ workerProcess?: WorkerProcessType; @@ -69,14 +83,24 @@ export type ConfigurationData = { workerPoolStrategy?: WorkerChoiceStrategy; /** @deprecated Moved to worker configuration section. */ chargingStationsPerWorker?: number; + /** @deprecated Moved to log configuration section. */ logStatisticsInterval?: number; + /** @deprecated Moved to log configuration section. */ logEnabled?: boolean; + /** @deprecated Moved to log configuration section. */ logConsole?: boolean; + /** @deprecated Moved to log configuration section. */ logFormat?: string; + /** @deprecated Moved to log configuration section. */ logLevel?: string; + /** @deprecated Moved to log configuration section. */ logRotate?: boolean; + /** @deprecated Moved to log configuration section. */ logMaxFiles?: number | string; + /** @deprecated Moved to log configuration section. */ logMaxSize?: number | string; + /** @deprecated Moved to log configuration section. */ logFile?: string; + /** @deprecated Moved to log configuration section. */ logErrorFile?: string; }; diff --git a/src/types/index.ts b/src/types/index.ts index 2b833800..f9a42d4a 100644 --- a/src/types/index.ts +++ b/src/types/index.ts @@ -167,6 +167,7 @@ export { } from './ChargingStationTemplate'; export { type ConfigurationData, + type LogConfiguration, type StationTemplateUrl, type StorageConfiguration, SupervisionUrlDistribution, diff --git a/src/utils/Configuration.ts b/src/utils/Configuration.ts index b67afd44..4f5e1ef1 100644 --- a/src/utils/Configuration.ts +++ b/src/utils/Configuration.ts @@ -12,6 +12,7 @@ import { ApplicationProtocol, type ConfigurationData, FileType, + type LogConfiguration, type StationTemplateUrl, type StorageConfiguration, StorageType, @@ -40,18 +41,6 @@ export class Configuration { Configuration.configurationChangeCallback = cb; } - public static getLogStatisticsInterval(): number | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'statisticsDisplayInterval', - undefined, - "Use 'logStatisticsInterval' instead" - ); - // Read conf - return Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') - ? Configuration.getConfig()?.logStatisticsInterval - : Constants.DEFAULT_LOG_STATISTICS_INTERVAL; - } - public static getUIServer(): UIServerConfiguration { if (Utils.hasOwnProp(Configuration.getConfig(), 'uiWebSocketServer')) { console.error( @@ -150,6 +139,106 @@ export class Configuration { return Configuration.getConfig()?.stationTemplateUrls; } + public static getLog(): LogConfiguration { + Configuration.warnDeprecatedConfigurationKey( + 'logEnabled', + undefined, + "Use 'log' section to define the logging enablement instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logFile', + undefined, + "Use 'log' section to define the log file instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logErrorFile', + undefined, + "Use 'log' section to define the log error file instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logConsole', + undefined, + "Use 'log' section to define the console logging enablement instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logStatisticsInterval', + undefined, + "Use 'log' section to define the log statistics interval instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logLevel', + undefined, + "Use 'log' section to define the log level instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logFormat', + undefined, + "Use 'log' section to define the log format instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logRotate', + undefined, + "Use 'log' section to define the log rotation instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logMaxFiles', + undefined, + "Use 'log' section to define the log maximum files instead" + ); + Configuration.warnDeprecatedConfigurationKey( + 'logMaxSize', + undefined, + "Use 'log' section to define the log maximum size instead" + ); + const defaultLogConfiguration: LogConfiguration = { + enabled: true, + file: 'logs/combined.log', + errorFile: 'logs/error.log', + statisticsInterval: Constants.DEFAULT_LOG_STATISTICS_INTERVAL, + level: 'info', + format: 'simple', + rotate: true, + }; + const deprecatedLogConfiguration: LogConfiguration = { + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logEnabled') && { + enabled: Configuration.getConfig()?.logEnabled, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logFile') && { + file: Configuration.getConfig()?.logFile, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logErrorFile') && { + errorFile: Configuration.getConfig()?.logErrorFile, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logStatisticsInterval') && { + statisticsInterval: Configuration.getConfig()?.logStatisticsInterval, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logLevel') && { + level: Configuration.getConfig()?.logLevel, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logConsole') && { + console: Configuration.getConfig()?.logConsole, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logFormat') && { + format: Configuration.getConfig()?.logFormat, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logRotate') && { + rotate: Configuration.getConfig()?.logRotate, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && { + maxFiles: Configuration.getConfig()?.logMaxFiles, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'logMaxSize') && { + maxSize: Configuration.getConfig()?.logMaxSize, + }), + }; + const logConfiguration: LogConfiguration = { + ...defaultLogConfiguration, + ...deprecatedLogConfiguration, + ...Configuration.getConfig()?.log, + }; + return logConfiguration; + } + public static getWorker(): WorkerConfiguration { Configuration.warnDeprecatedConfigurationKey( 'useWorkerPool', @@ -196,31 +285,44 @@ export class Configuration { undefined, "Use 'worker' section to define the worker pool strategy instead" ); - let workerConfiguration: WorkerConfiguration = { - processType: Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess') - ? Configuration.getConfig()?.workerProcess - : WorkerProcessType.workerSet, - startDelay: Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay') - ? Configuration.getConfig()?.workerStartDelay - : WorkerConstants.DEFAULT_WORKER_START_DELAY, - elementsPerWorker: Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') - ? Configuration.getConfig()?.chargingStationsPerWorker - : WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER, - elementStartDelay: Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay') - ? Configuration.getConfig()?.elementStartDelay - : WorkerConstants.DEFAULT_ELEMENT_START_DELAY, - poolMinSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') - ? Configuration.getConfig()?.workerPoolMinSize - : WorkerConstants.DEFAULT_POOL_MIN_SIZE, - poolMaxSize: Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize') - ? Configuration.getConfig()?.workerPoolMaxSize - : WorkerConstants.DEFAULT_POOL_MAX_SIZE, - poolStrategy: - Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN, + const defaultWorkerConfiguration: WorkerConfiguration = { + processType: WorkerProcessType.workerSet, + startDelay: WorkerConstants.DEFAULT_WORKER_START_DELAY, + elementsPerWorker: WorkerConstants.DEFAULT_ELEMENTS_PER_WORKER, + elementStartDelay: WorkerConstants.DEFAULT_ELEMENT_START_DELAY, + poolMinSize: WorkerConstants.DEFAULT_POOL_MIN_SIZE, + poolMaxSize: WorkerConstants.DEFAULT_POOL_MAX_SIZE, + poolStrategy: WorkerChoiceStrategies.ROUND_ROBIN, + }; + const deprecatedWorkerConfiguration: WorkerConfiguration = { + ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerProcess') && { + processType: Configuration.getConfig()?.workerProcess, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerStartDelay') && { + startDelay: Configuration.getConfig()?.workerStartDelay, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'chargingStationsPerWorker') && { + elementsPerWorker: Configuration.getConfig()?.chargingStationsPerWorker, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'elementStartDelay') && { + elementStartDelay: Configuration.getConfig()?.elementStartDelay, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMinSize') && { + poolMinSize: Configuration.getConfig()?.workerPoolMinSize, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolMaxSize') && { + poolMaxSize: Configuration.getConfig()?.workerPoolMaxSize, + }), + ...(Utils.hasOwnProp(Configuration.getConfig(), 'workerPoolStrategy') && { + poolStrategy: + Configuration.getConfig()?.workerPoolStrategy ?? WorkerChoiceStrategies.ROUND_ROBIN, + }), + }; + const workerConfiguration: WorkerConfiguration = { + ...defaultWorkerConfiguration, + ...deprecatedWorkerConfiguration, + ...Configuration.getConfig()?.worker, }; - if (Utils.hasOwnProp(Configuration.getConfig(), 'worker')) { - workerConfiguration = { ...workerConfiguration, ...Configuration.getConfig()?.worker }; - } return workerConfiguration; } @@ -234,72 +336,6 @@ export class Configuration { return Configuration.getWorker().processType === WorkerProcessType.dynamicPool; } - public static getLogEnabled(): boolean | undefined { - return Utils.hasOwnProp(Configuration.getConfig(), 'logEnabled') - ? Configuration.getConfig()?.logEnabled - : true; - } - - public static getLogConsole(): boolean | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'consoleLog', - undefined, - "Use 'logConsole' instead" - ); - return Utils.hasOwnProp(Configuration.getConfig(), 'logConsole') - ? Configuration.getConfig()?.logConsole - : false; - } - - public static getLogFormat(): string | undefined { - return Utils.hasOwnProp(Configuration.getConfig(), 'logFormat') - ? Configuration.getConfig()?.logFormat - : 'simple'; - } - - public static getLogRotate(): boolean | undefined { - return Utils.hasOwnProp(Configuration.getConfig(), 'logRotate') - ? Configuration.getConfig()?.logRotate - : true; - } - - public static getLogMaxFiles(): number | string | false | undefined { - return ( - Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && - Configuration.getConfig()?.logMaxFiles - ); - } - - public static getLogMaxSize(): number | string | false | undefined { - return ( - Utils.hasOwnProp(Configuration.getConfig(), 'logMaxFiles') && - Configuration.getConfig()?.logMaxSize - ); - } - - public static getLogLevel(): string | undefined { - return Utils.hasOwnProp(Configuration.getConfig(), 'logLevel') - ? Configuration.getConfig()?.logLevel?.toLowerCase() - : 'info'; - } - - public static getLogFile(): string | undefined { - return Utils.hasOwnProp(Configuration.getConfig(), 'logFile') - ? Configuration.getConfig()?.logFile - : 'combined.log'; - } - - public static getLogErrorFile(): string | undefined { - Configuration.warnDeprecatedConfigurationKey( - 'errorFile', - undefined, - "Use 'logErrorFile' instead" - ); - return Utils.hasOwnProp(Configuration.getConfig(), 'logErrorFile') - ? Configuration.getConfig()?.logErrorFile - : 'error.log'; - } - public static getSupervisionUrls(): string | string[] | undefined { Configuration.warnDeprecatedConfigurationKey( 'supervisionURLs', diff --git a/src/utils/Logger.ts b/src/utils/Logger.ts index 637beb5b..92fe6909 100644 --- a/src/utils/Logger.ts +++ b/src/utils/Logger.ts @@ -7,15 +7,15 @@ import { Configuration } from './Configuration'; import { Utils } from './Utils'; let transports: transport[]; -if (Configuration.getLogRotate() === true) { - const logMaxFiles = Configuration.getLogMaxFiles(); - const logMaxSize = Configuration.getLogMaxSize(); +if (Configuration.getLog().rotate === true) { + const logMaxFiles = Configuration.getLog().maxFiles; + const logMaxSize = Configuration.getLog().maxSize; transports = [ new DailyRotateFile({ filename: Utils.insertAt( - Configuration.getLogErrorFile(), + Configuration.getLog().errorFile, '-%DATE%', - Configuration.getLogErrorFile()?.indexOf('.log') + Configuration.getLog().errorFile?.indexOf('.log') ), level: 'error', ...(logMaxFiles && { maxFiles: logMaxFiles }), @@ -23,9 +23,9 @@ if (Configuration.getLogRotate() === true) { }), new DailyRotateFile({ filename: Utils.insertAt( - Configuration.getLogFile(), + Configuration.getLog().file, '-%DATE%', - Configuration.getLogFile()?.indexOf('.log') + Configuration.getLog().file?.indexOf('.log') ), ...(logMaxFiles && { maxFiles: logMaxFiles }), ...(logMaxSize && { maxSize: logMaxSize }), @@ -33,15 +33,15 @@ if (Configuration.getLogRotate() === true) { ]; } else { transports = [ - new TransportType.File({ filename: Configuration.getLogErrorFile(), level: 'error' }), - new TransportType.File({ filename: Configuration.getLogFile() }), + new TransportType.File({ filename: Configuration.getLog().errorFile, level: 'error' }), + new TransportType.File({ filename: Configuration.getLog().file }), ]; } export const logger = createLogger({ - silent: !Configuration.getLogEnabled(), - level: Configuration.getLogLevel(), - format: format.combine(format.splat(), (format[Configuration.getLogFormat()] as FormatWrap)()), + silent: !Configuration.getLog().enabled, + level: Configuration.getLog().level, + format: format.combine(format.splat(), (format[Configuration.getLog().format] as FormatWrap)()), transports, }); @@ -49,12 +49,12 @@ export const logger = createLogger({ // If enabled, log to the `console` with the format: // `${info.level}: ${info.message} JSON.stringify({ ...rest }) ` // -if (Configuration.getLogConsole()) { +if (Configuration.getLog().console) { logger.add( new TransportType.Console({ format: format.combine( format.splat(), - (format[Configuration.getLogFormat()] as FormatWrap)() + (format[Configuration.getLog().format] as FormatWrap)() ), }) ); -- 2.34.1