From 0829ff12692fb37c4c0ea974f14bf2988a0a50a1 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Mon, 28 Dec 2020 18:34:41 +0100
Subject: [PATCH] backend-common: include extra fields on dev log formatter

---
 .changeset/mighty-plums-wave.md                |  5 +++++
 packages/backend-common/src/logging/formats.ts | 10 +++++++---
 2 files changed, 12 insertions(+), 3 deletions(-)
 create mode 100644 .changeset/mighty-plums-wave.md

diff --git a/.changeset/mighty-plums-wave.md b/.changeset/mighty-plums-wave.md
new file mode 100644
index 0000000000..ac84b68e04
--- /dev/null
+++ b/.changeset/mighty-plums-wave.md
@@ -0,0 +1,5 @@
+---
+'@backstage/backend-common': patch
+---
+
+Tweaked development log formatter to include extra fields at the end of each log line
diff --git a/packages/backend-common/src/logging/formats.ts b/packages/backend-common/src/logging/formats.ts
index 5f00448744..4f7949f115 100644
--- a/packages/backend-common/src/logging/formats.ts
+++ b/packages/backend-common/src/logging/formats.ts
@@ -17,19 +17,23 @@ import * as winston from 'winston';
 import { TransformableInfo } from 'logform';
 
 const coloredTemplate = (info: TransformableInfo) => {
-  const { timestamp, level, message, plugin, service } = info;
+  const { timestamp, level, message, plugin, service, ...fields } = info;
   const colorizer = winston.format.colorize();
   const prefix = plugin || service;
   const timestampColor = colorizer.colorize('timestamp', timestamp);
   const prefixColor = colorizer.colorize('prefix', prefix);
 
-  return `${timestampColor} ${prefixColor} ${level} ${message}`;
+  const extraFields = Object.entries(fields)
+    .map(([key, value]) => `${colorizer.colorize('field', `${key}`)}=${value}`)
+    .join(' ');
+
+  return `${timestampColor} ${prefixColor} ${level} ${message} ${extraFields}`;
 };
 
 export const coloredFormat = winston.format.combine(
   winston.format.timestamp(),
   winston.format.colorize({
-    colors: { timestamp: 'dim', prefix: 'blue' },
+    colors: { timestamp: 'dim', prefix: 'blue', field: 'cyan' },
   }),
   winston.format.printf(coloredTemplate),
 );