diff --git a/.changeset/mean-ants-hang.md b/.changeset/mean-ants-hang.md index 6fe5c50420..e9c3bc4eaf 100644 --- a/.changeset/mean-ants-hang.md +++ b/.changeset/mean-ants-hang.md @@ -2,4 +2,4 @@ '@backstage/backend-common': patch --- -Exported `redactLogLine` function to be able to use it in custom loggers. +Exported `redactLogLine` function to be able to use it in custom loggers and renamed it to `redactWinstonLogLine`. diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index ff79e106e0..82263fba07 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -569,7 +569,7 @@ export type ReadUrlResponseFactoryFromStreamOptions = { }; // @public -export function redactLogLine( +export function redactWinstonLogLine( info: winston.Logform.TransformableInfo, ): winston.Logform.TransformableInfo; diff --git a/packages/backend-common/src/logging/index.ts b/packages/backend-common/src/logging/index.ts index a3b87237ec..4657dd4101 100644 --- a/packages/backend-common/src/logging/index.ts +++ b/packages/backend-common/src/logging/index.ts @@ -19,6 +19,6 @@ export { createRootLogger, getRootLogger, setRootLogger, - redactLogLine, + redactWinstonLogLine, } from './rootLogger'; export * from './voidLogger'; diff --git a/packages/backend-common/src/logging/rootLogger.ts b/packages/backend-common/src/logging/rootLogger.ts index a24dea3c00..6077662dcf 100644 --- a/packages/backend-common/src/logging/rootLogger.ts +++ b/packages/backend-common/src/logging/rootLogger.ts @@ -72,7 +72,7 @@ export function setRootLoggerRedactionList(redactionList: string[]) { * * @public */ -export function redactLogLine(info: winston.Logform.TransformableInfo) { +export function redactWinstonLogLine(info: winston.Logform.TransformableInfo) { // TODO(hhogg): The logger is created before the config is loaded, because the // logger is needed in the config loader. There is a risk of a secret being // logged out during the config loading stage. @@ -106,7 +106,7 @@ export function createRootLogger( { level: env.LOG_LEVEL || 'info', format: winston.format.combine( - winston.format(redactLogLine)(), + winston.format(redactWinstonLogLine)(), env.NODE_ENV === 'production' ? winston.format.json() : coloredFormat, ), defaultMeta: {