From dae8956754cad162bf20f49c50a62b65be87e4ac Mon Sep 17 00:00:00 2001
From: Mike Bryant <mike@mikebryant.me.uk>
Date: Thu, 18 May 2023 21:15:41 +0100
Subject: [PATCH] feat: Add tracing to validate stage

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

diff --git a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts
index 8b4f4127f3..aabe703806 100644
--- a/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts
+++ b/plugins/catalog-backend/src/processing/DefaultCatalogProcessingOrchestrator.ts
@@ -269,50 +269,65 @@ export class DefaultCatalogProcessingOrchestrator
     entity: Entity,
     context: Context,
   ): Promise<void> {
-    // Double check that none of the previous steps tried to change something
-    // related to the entity ref, which would break downstream
-    if (stringifyEntityRef(entity) !== context.entityRef) {
-      throw new ConflictError(
-        'Fatal: The entity kind, namespace, or name changed during processing',
+    return await withActiveSpan(tracer, 'ProcessingStage', async stageSpan => {
+      addEntityAttributes(stageSpan, context.entityRef);
+      stageSpan.setAttribute(
+        'backstage.catalog.processor.stage',
+        'validateEntity',
       );
-    }
+      // Double check that none of the previous steps tried to change something
+      // related to the entity ref, which would break downstream
+      if (stringifyEntityRef(entity) !== context.entityRef) {
+        throw new ConflictError(
+          'Fatal: The entity kind, namespace, or name changed during processing',
+        );
+      }
 
-    // Validate that the end result is a valid Entity at all
-    try {
-      validateEntity(entity);
-    } catch (e) {
-      throw new ConflictError(
-        `Entity envelope for ${context.entityRef} failed validation after preprocessing`,
-        e,
-      );
-    }
+      // Validate that the end result is a valid Entity at all
+      try {
+        validateEntity(entity);
+      } catch (e) {
+        throw new ConflictError(
+          `Entity envelope for ${context.entityRef} failed validation after preprocessing`,
+          e,
+        );
+      }
 
-    let valid = false;
+      let valid = false;
 
-    for (const processor of this.options.processors) {
-      if (processor.validateEntityKind) {
-        try {
-          const thisValid = await processor.validateEntityKind(entity);
-          if (thisValid) {
-            valid = true;
-            if (this.options.legacySingleProcessorValidation) {
-              break;
+      for (const processor of this.options.processors) {
+        if (processor.validateEntityKind) {
+          try {
+            const thisValid = await withActiveSpan(
+              tracer,
+              'ProcessingStep',
+              async span => {
+                addEntityAttributes(span, context.entityRef);
+                addProcessorAttributes(span, 'postProcessEntity', processor);
+                return await processor.validateEntityKind(entity);
+              },
+            );
+            if (thisValid) {
+              valid = true;
+              if (this.options.legacySingleProcessorValidation) {
+                break;
+              }
             }
+          } catch (e) {
+            throw new InputError(
+              `Processor ${processor.constructor.name} threw an error while validating the entity ${context.entityRef}`,
+              e,
+            );
           }
-        } catch (e) {
-          throw new InputError(
-            `Processor ${processor.constructor.name} threw an error while validating the entity ${context.entityRef}`,
-            e,
-          );
         }
       }
-    }
 
-    if (!valid) {
-      throw new InputError(
-        `No processor recognized the entity ${context.entityRef} as valid, possibly caused by a foreign kind or apiVersion`,
-      );
-    }
+      if (!valid) {
+        throw new InputError(
+          `No processor recognized the entity ${context.entityRef} as valid, possibly caused by a foreign kind or apiVersion`,
+        );
+      }
+    });
   }
 
   /**