backend-app-api: move global loggers and winston helper back to backend-common

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-01-10 17:26:02 +01:00
parent 669d811da8
commit d54cd2b298
5 changed files with 31 additions and 39 deletions
@@ -20,36 +20,8 @@ import { LoggerOptions } from 'winston';
import { coloredFormat } from './formats';
import { escapeRegExp } from '../lib/escapeRegExp';
let rootLogger: winston.Logger;
let redactionRegExp: RegExp | undefined;
/**
* Gets the current root logger.
*
* @public
*/
export function getRootLogger(): winston.Logger {
return rootLogger;
}
/**
* Sets a completely custom default "root" logger.
*
* @remarks
*
* This is the logger instance that will be the foundation for all other logger
* instances passed to plugins etc, in a given backend.
*
* Only use this if you absolutely need to make a completely custom logger.
* Normally if you want to make light adaptations to the default logger
* behavior, you would instead call {@link createRootLogger}.
*
* @public
*/
export function setRootLogger(newLogger: winston.Logger) {
rootLogger = newLogger;
}
export function setRootLoggerRedactionList(redactionList: string[]) {
// Exclude secrets that are empty or just one character in length. These
// typically mean that you are running local dev or tests, or using the
@@ -127,5 +99,3 @@ export function createRootLogger(
return logger;
}
rootLogger = createRootLogger();
@@ -26,3 +26,32 @@ export function getVoidLogger(): winston.Logger {
transports: [new winston.transports.Console({ silent: true })],
});
}
let rootLogger: winston.Logger = createRootLogger();
/**
* Gets the current root logger.
*
* @public
*/
export function getRootLogger(): winston.Logger {
return rootLogger;
}
/**
* Sets a completely custom default "root" logger.
*
* @remarks
*
* This is the logger instance that will be the foundation for all other logger
* instances passed to plugins etc, in a given backend.
*
* Only use this if you absolutely need to make a completely custom logger.
* Normally if you want to make light adaptations to the default logger
* behavior, you would instead call {@link createRootLogger}.
*
* @public
*/
export function setRootLogger(newLogger: winston.Logger) {
rootLogger = newLogger;
}
@@ -14,12 +14,5 @@
* limitations under the License.
*/
export * from './formats';
export {
createRootLogger,
getRootLogger,
setRootLogger,
redactWinstonLogLine,
} from './rootLogger';
export * from './voidLogger';
export { getRootLogger, getVoidLogger, setRootLogger } from './globalLoggers';
export { loggerToWinstonLogger } from './loggerToWinstonLogger';
@@ -16,7 +16,7 @@
import { ConfigReader } from '@backstage/config';
import * as jose from 'jose';
import { getVoidLogger } from '../logging/voidLogger';
import { getVoidLogger } from '../logging';
import { ServerTokenManager } from './ServerTokenManager';
import { TokenManager } from './types';