Telemetry: ensure the ClientComponentLoad metric is only reported whe…

…n available (vercel#62459)
NOUIY · Feb 23, 2024 · 00f300a · 00f300a
1 parent dcf8f04
commit 00f300a
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 24 deletions.
diff --git a/packages/next/src/server/app-render/app-render.tsx b/packages/next/src/server/app-render/app-render.tsx
@@ -634,16 +634,20 @@ async function renderToHTMLOrFlightImpl(
     req.on('end', () => {
       if ('performance' in globalThis) {
         const metrics = getClientComponentLoaderMetrics({ reset: true })
-        getTracer()
-          .startSpan(NextNodeServerSpan.clientComponentLoading, {
-            startTime: metrics.clientComponentLoadStart,
-            attributes: {
-              'next.clientComponentLoadCount': metrics.clientComponentLoadCount,
-            },
-          })
-          .end(
-            metrics.clientComponentLoadStart + metrics.clientComponentLoadTimes
-          )
+        if (metrics) {
+          getTracer()
+            .startSpan(NextNodeServerSpan.clientComponentLoading, {
+              startTime: metrics.clientComponentLoadStart,
+              attributes: {
+                'next.clientComponentLoadCount':
+                  metrics.clientComponentLoadCount,
+              },
+            })
+            .end(
+              metrics.clientComponentLoadStart +
+                metrics.clientComponentLoadTimes
+            )
+        }
       }
     })
   }

diff --git a/packages/next/src/server/client-component-renderer-logger.ts b/packages/next/src/server/client-component-renderer-logger.ts
@@ -37,11 +37,14 @@ export function wrapClientComponentLoader(ComponentMod: any) {
 export function getClientComponentLoaderMetrics(
   options: { reset?: boolean } = {}
 ) {
-  const metrics = {
-    clientComponentLoadStart,
-    clientComponentLoadTimes,
-    clientComponentLoadCount,
-  }
+  const metrics =
+    clientComponentLoadStart === 0
+      ? undefined
+      : {
+          clientComponentLoadStart,
+          clientComponentLoadTimes,
+          clientComponentLoadCount,
+        }
 
   if (options.reset) {
     clientComponentLoadStart = 0

diff --git a/packages/next/src/server/pipe-readable.ts b/packages/next/src/server/pipe-readable.ts
@@ -55,15 +55,17 @@ function createWriterFromResponse(
           process.env.NEXT_OTEL_PERFORMANCE_PREFIX
         ) {
           const metrics = getClientComponentLoaderMetrics()
-          performance.measure(
-            `${process.env.NEXT_OTEL_PERFORMANCE_PREFIX}:next-client-component-loading`,
-            {
-              start: metrics.clientComponentLoadStart,
-              end:
-                metrics.clientComponentLoadStart +
-                metrics.clientComponentLoadTimes,
-            }
-          )
+          if (metrics) {
+            performance.measure(
+              `${process.env.NEXT_OTEL_PERFORMANCE_PREFIX}:next-client-component-loading`,
+              {
+                start: metrics.clientComponentLoadStart,
+                end:
+                  metrics.clientComponentLoadStart +
+                  metrics.clientComponentLoadTimes,
+              }
+            )
+          }
         }
 
         res.flushHeaders()