From 1732a18a7ac251c523fc9713979c5690a1fd32dd Mon Sep 17 00:00:00 2001
From: Diego Bardari <diego.bardari@klarna.com>
Date: Tue, 19 Jul 2022 10:35:21 +0200
Subject: [PATCH] feat(logging): export redactLogLine function

Signed-off-by: Diego Bardari <diego.bardari@klarna.com>
---
 .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.