From bb5ab706d7e6d8413bf74d7243e5de70a5331e47 Mon Sep 17 00:00:00 2001
From: Mike Bryant <mike@mikebryant.me.uk>
Date: Thu, 18 May 2023 21:24:50 +0100
Subject: [PATCH] feat: Add spans for read steps

Signed-off-by: Mike Bryant <mike@mikebryant.me.uk>
---
 .../DefaultCatalogProcessingOrchestrator.ts   | 122 ++++++++++--------
 1 file changed, 69 insertions(+), 53 deletions(-)

diff --git a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts
index 6fa44db1a6..91a1c2f9a6 100644
--- a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts
+++ b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts
@@ -344,65 +344,81 @@ export class DefaultCatalogProcessingOrchestrator
     entity: LocationEntity,
     context: Context,
   ): Promise<void> {
-    const { type = context.location.type, presence = 'required' } = entity.spec;
-    const targets = new Array<string>();
-    if (entity.spec.target) {
-      targets.push(entity.spec.target);
-    }
-    if (entity.spec.targets) {
-      targets.push(...entity.spec.targets);
-    }
-
-    for (const maybeRelativeTarget of targets) {
-      if (type === 'file' && maybeRelativeTarget.endsWith(path.sep)) {
-        context.collector.generic()(
-          processingResult.inputError(
-            context.location,
-            `LocationEntityProcessor cannot handle ${type} type location with target ${context.location.target} that ends with a path separator`,
-          ),
-        );
-        continue;
-      }
-      const target = toAbsoluteUrl(
-        this.options.integrations,
-        context.location,
-        type,
-        maybeRelativeTarget,
+    return await withActiveSpan(tracer, 'ProcessingStage', async stageSpan => {
+      addEntityAttributes(stageSpan, context.entityRef);
+      stageSpan.setAttribute(
+        'backstage.catalog.processor.stage',
+        'readLocationEntity',
       );
+      const { type = context.location.type, presence = 'required' } =
+        entity.spec;
+      const targets = new Array<string>();
+      if (entity.spec.target) {
+        targets.push(entity.spec.target);
+      }
+      if (entity.spec.targets) {
+        targets.push(...entity.spec.targets);
+      }
 
-      let didRead = false;
-      for (const processor of this.options.processors) {
-        if (processor.readLocation) {
-          try {
-            const read = await processor.readLocation(
-              {
-                type,
-                target,
-                presence,
-              },
-              presence === 'optional',
-              context.collector.forProcessor(processor),
-              this.options.parser,
-              context.cache.forProcessor(processor, target),
-            );
-            if (read) {
-              didRead = true;
-              break;
+      for (const maybeRelativeTarget of targets) {
+        if (type === 'file' && maybeRelativeTarget.endsWith(path.sep)) {
+          context.collector.generic()(
+            processingResult.inputError(
+              context.location,
+              `LocationEntityProcessor cannot handle ${type} type location with target ${context.location.target} that ends with a path separator`,
+            ),
+          );
+          continue;
+        }
+        const target = toAbsoluteUrl(
+          this.options.integrations,
+          context.location,
+          type,
+          maybeRelativeTarget,
+        );
+
+        let didRead = false;
+        for (const processor of this.options.processors) {
+          if (processor.readLocation) {
+            try {
+              const read = await withActiveSpan(
+                tracer,
+                'ProcessingStep',
+                async span => {
+                  addEntityAttributes(span, context.entityRef);
+                  addProcessorAttributes(span, 'readLocationEntity', processor);
+                  return await processor.readLocation(
+                    {
+                      type,
+                      target,
+                      presence,
+                    },
+                    presence === 'optional',
+                    context.collector.forProcessor(processor),
+                    this.options.parser,
+                    context.cache.forProcessor(processor, target),
+                  );
+                },
+              );
+              if (read) {
+                didRead = true;
+                break;
+              }
+            } catch (e) {
+              throw new InputError(
+                `Processor ${processor.constructor.name} threw an error while reading ${type}:${target}`,
+                e,
+              );
             }
-          } catch (e) {
-            throw new InputError(
-              `Processor ${processor.constructor.name} threw an error while reading ${type}:${target}`,
-              e,
-            );
           }
         }
+        if (!didRead) {
+          throw new InputError(
+            `No processor was able to handle reading of ${type}:${target}`,
+          );
+        }
       }
-      if (!didRead) {
-        throw new InputError(
-          `No processor was able to handle reading of ${type}:${target}`,
-        );
-      }
-    }
+    });
   }
 
   /**