From 1732a18a7ac251c523fc9713979c5690a1fd32dd Mon Sep 17 00:00:00 2001 From: Diego Bardari Date: Tue, 19 Jul 2022 10:35:21 +0200 Subject: [PATCH 1/4] feat(logging): export redactLogLine function Signed-off-by: Diego Bardari --- .changeset/mean-ants-hang.md | 5 +++++ packages/backend-common/api-report.md | 5 +++++ packages/backend-common/src/logging/index.ts | 7 ++++++- packages/backend-common/src/logging/rootLogger.ts | 4 +++- 4 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 .changeset/mean-ants-hang.md diff --git a/.changeset/mean-ants-hang.md b/.changeset/mean-ants-hang.md new file mode 100644 index 0000000000..1dbbc63de0 --- /dev/null +++ b/.changeset/mean-ants-hang.md @@ -0,0 +1,5 @@ +--- +'@backstage/backend-common': minor +--- + +Exported redactLogLine function to be able to use it in custom loggers. diff --git a/packages/backend-common/api-report.md b/packages/backend-common/api-report.md index 6059e68792..ff79e106e0 100644 --- a/packages/backend-common/api-report.md +++ b/packages/backend-common/api-report.md @@ -568,6 +568,11 @@ export type ReadUrlResponseFactoryFromStreamOptions = { etag?: string; }; +// @public +export function redactLogLine( + info: winston.Logform.TransformableInfo, +): winston.Logform.TransformableInfo; + // @public export function requestLoggingHandler(logger?: Logger): RequestHandler; diff --git a/packages/backend-common/src/logging/index.ts b/packages/backend-common/src/logging/index.ts index f50114a9ae..a3b87237ec 100644 --- a/packages/backend-common/src/logging/index.ts +++ b/packages/backend-common/src/logging/index.ts @@ -15,5 +15,10 @@ */ export * from './formats'; -export { createRootLogger, getRootLogger, setRootLogger } from './rootLogger'; +export { + createRootLogger, + getRootLogger, + setRootLogger, + redactLogLine, +} from './rootLogger'; export * from './voidLogger'; diff --git a/packages/backend-common/src/logging/rootLogger.ts b/packages/backend-common/src/logging/rootLogger.ts index 87180bde8f..a24dea3c00 100644 --- a/packages/backend-common/src/logging/rootLogger.ts +++ b/packages/backend-common/src/logging/rootLogger.ts @@ -69,8 +69,10 @@ export function setRootLoggerRedactionList(redactionList: string[]) { /** * A winston formatting function that finds occurrences of filteredKeys * and replaces them with the corresponding identifier. + * + * @public */ -function redactLogLine(info: winston.Logform.TransformableInfo) { +export function redactLogLine(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. From 130aaec10566a6d0f85da135bc0f9e576f87e425 Mon Sep 17 00:00:00 2001 From: Charge71 Date: Thu, 28 Jul 2022 11:26:58 +0200 Subject: [PATCH 2/4] Update .changeset/mean-ants-hang.md Co-authored-by: Ben Lambert Signed-off-by: Diego Bardari --- .changeset/mean-ants-hang.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/mean-ants-hang.md b/.changeset/mean-ants-hang.md index 1dbbc63de0..e3beca051e 100644 --- a/.changeset/mean-ants-hang.md +++ b/.changeset/mean-ants-hang.md @@ -1,5 +1,5 @@ --- -'@backstage/backend-common': minor +'@backstage/backend-common': patch --- Exported redactLogLine function to be able to use it in custom loggers. From a01168b4660fdf07d722d736cd457a178b83cfb6 Mon Sep 17 00:00:00 2001 From: Charge71 Date: Thu, 28 Jul 2022 11:27:05 +0200 Subject: [PATCH 3/4] Update .changeset/mean-ants-hang.md Co-authored-by: Ben Lambert Signed-off-by: Diego Bardari --- .changeset/mean-ants-hang.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.changeset/mean-ants-hang.md b/.changeset/mean-ants-hang.md index e3beca051e..6fe5c50420 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. From ef4fd4abd1a039b950b18dcb23c8e4d6e51885ff Mon Sep 17 00:00:00 2001 From: Diego Bardari Date: Thu, 28 Jul 2022 11:56:07 +0200 Subject: [PATCH 4/4] feat(logging): renamed redactLogLine function to redactWinstonLogLine Signed-off-by: Diego Bardari --- .changeset/mean-ants-hang.md | 2 +- packages/backend-common/api-report.md | 2 +- packages/backend-common/src/logging/index.ts | 2 +- packages/backend-common/src/logging/rootLogger.ts | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) 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: {