From e708679d7706829a56d4d1e68ce442691ef2c876 Mon Sep 17 00:00:00 2001
From: Govindarajan Nagarajan <govindarajan.nagarajan@zalando.de>
Date: Tue, 8 Dec 2020 14:13:09 +0100
Subject: [PATCH] `refreshAllLocations` uses a child logger with meta. Refs
 #3602

When there are a large number of location, `refreshAllLocations` can
emit a lot of logs that are noisy and can make debugging hard.

To solve this problem, create a child logger with a meta : `component` =
`refreshAllLocations`. That can be used to filter out logs if needed
---
 .changeset/flat-flowers-learn.md              |  5 +++++
 .../src/ingestion/HigherOrderOperations.ts    | 22 ++++++++++++-------
 2 files changed, 19 insertions(+), 8 deletions(-)
 create mode 100644 .changeset/flat-flowers-learn.md

diff --git a/.changeset/flat-flowers-learn.md b/.changeset/flat-flowers-learn.md
new file mode 100644
index 0000000000..cf93da57cf
--- /dev/null
+++ b/.changeset/flat-flowers-learn.md
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-backend': patch
+---
+
+refreshAllLocations uses a child logger of the HigherOrderOperation with a meta `component` : `catalog-all-locations-refresh`
diff --git a/plugins/catalog-backend/src/ingestion/HigherOrderOperations.ts b/plugins/catalog-backend/src/ingestion/HigherOrderOperations.ts
index ca19a1d1c5..565c3671ee 100644
--- a/plugins/catalog-backend/src/ingestion/HigherOrderOperations.ts
+++ b/plugins/catalog-backend/src/ingestion/HigherOrderOperations.ts
@@ -116,28 +116,34 @@ export class HigherOrderOperations implements HigherOrderOperation {
    */
   async refreshAllLocations(): Promise<void> {
     const startTimestamp = process.hrtime();
-    this.logger.info('Beginning locations refresh');
+    const logger = this.logger.child({
+      component: 'catalog-all-locations-refresh',
+    });
+
+    logger.info('Locations Refresh: Beginning locations refresh');
 
     const locations = await this.locationsCatalog.locations();
-    this.logger.info(`Visiting ${locations.length} locations`);
+    logger.info(`Locations Refresh: Visiting ${locations.length} locations`);
 
     for (const { data: location } of locations) {
-      this.logger.info(
-        `Refreshing location ${location.type}:${location.target}`,
+      logger.info(
+        `Locations Refresh: Refreshing location ${location.type}:${location.target}`,
       );
       try {
         await this.refreshSingleLocation(location);
         await this.locationsCatalog.logUpdateSuccess(location.id, undefined);
       } catch (e) {
-        this.logger.warn(
-          `Failed to refresh location ${location.type}:${location.target}, ${e.stack}`,
+        logger.warn(
+          `Locations Refresh: Failed to refresh location ${location.type}:${location.target}, ${e.stack}`,
         );
         await this.locationsCatalog.logUpdateFailure(location.id, e);
       }
     }
 
-    this.logger.info(
-      `Completed locations refresh in ${durationText(startTimestamp)}`,
+    logger.info(
+      `Locations Refresh: Completed locations refresh in ${durationText(
+        startTimestamp,
+      )}`,
     );
   }