set span status to Error when status code 500

Author: devjiwonchoi

packages/next/src/server/app-render/create-error-handler.tsx

@@ -91,6 +91,7 @@ export function createFlightReactServerErrorHandler(
     const span = getTracer().getActiveScopeSpan()
     if (span) {
       span.recordException(err)
+      span.setAttribute('error.type', err.message)
       span.setStatus({
         code: SpanStatusCode.ERROR,
         message: err.message,
@@ -164,6 +165,7 @@ export function createHTMLReactServerErrorHandler(
       const span = getTracer().getActiveScopeSpan()
       if (span) {
         span.recordException(err)
+        span.setAttribute('error.type', err.message)
         span.setStatus({
           code: SpanStatusCode.ERROR,
           message: err.message,
@@ -244,6 +246,7 @@ export function createHTMLErrorHandler(
       const span = getTracer().getActiveScopeSpan()
       if (span) {
         span.recordException(err)
+        span.setAttribute('error.type', err.message)
         span.setStatus({
           code: SpanStatusCode.ERROR,
           message: err.message,

packages/next/src/server/base-server.ts

@@ -96,7 +96,12 @@ import { AppRouteRouteMatcherProvider } from './route-matcher-providers/app-rout
 import { PagesAPIRouteMatcherProvider } from './route-matcher-providers/pages-api-route-matcher-provider'
 import { PagesRouteMatcherProvider } from './route-matcher-providers/pages-route-matcher-provider'
 import { ServerManifestLoader } from './route-matcher-providers/helpers/manifest-loaders/server-manifest-loader'
-import { getTracer, isBubbledError, SpanKind } from './lib/trace/tracer'
+import {
+  getTracer,
+  isBubbledError,
+  SpanKind,
+  SpanStatusCode,
+} from './lib/trace/tracer'
 import { BaseServerSpan } from './lib/trace/constants'
 import { I18NProvider } from './lib/i18n-provider'
 import { sendResponse } from './send-response'
@@ -896,6 +901,16 @@ export default abstract class Server<
               'next.rsc': isRSCRequest,
             })
 
+            if (res.statusCode && res.statusCode >= 500) {
+              // For 5xx status codes: SHOULD be set to 'Error' span status.
+              // x-ref: https://opentelemetry.io/docs/specs/semconv/http/http-spans/#status
+              span.setStatus({
+                code: SpanStatusCode.ERROR,
+              })
+              // For span status 'Error', SHOULD set 'error.type' attribute.
+              span.setAttribute('error.type', res.statusCode.toString())
+            }
+
             const rootSpanAttributes = tracer.getRootSpanAttributes()
             // We were unable to get attributes, probably OTEL is not enabled
             if (!rootSpanAttributes) return

packages/next/src/server/lib/trace/tracer.ts

@@ -56,6 +56,7 @@ const closeSpanWithError = (span: Span, error?: Error) => {
   } else {
     if (error) {
       span.recordException(error)
+      span.setAttribute('error.type', error.message)
     }
     span.setStatus({ code: SpanStatusCode.ERROR, message: error?.message })
   }

test/e2e/opentelemetry/instrumentation/app/app/[param]/rsc-fetch/error/page.tsx

@@ -1,3 +1,3 @@
-export default async function Page() {
-  throw new Error('Error')
+export default function Page() {
+  throw new Error('Error from Server Component')
 }

test/e2e/opentelemetry/instrumentation/opentelemetry.test.ts

@@ -545,6 +545,7 @@ describe('opentelemetry', () => {
                   'next.rsc': false,
                   'next.span_name': 'GET /app/[param]/rsc-fetch/error',
                   'next.span_type': 'BaseServer.handleRequest',
+                  'error.type': '500',
                 },
                 kind: 1,
                 status: { code: 2 },
@@ -560,7 +561,7 @@ describe('opentelemetry', () => {
                       'next.span_type': 'AppRender.getBodyResult',
                     },
                     kind: 0,
-                    status: { code: 2 },
+                    status: { code: 2, message: 'Error from Server Component' },
                     spans: [
                       {
                         name: 'build component tree',
@@ -620,7 +621,7 @@ describe('opentelemetry', () => {
                       },
                       {
                         attributes: {
-                          'next.clientComponentLoadCount': 8,
+                          'next.clientComponentLoadCount': isNextDev ? 9 : 8,
                           'next.span_type':
                             'NextNodeServer.clientComponentLoading',
                         },