Migrate src/observability console statements to structured logger (#61078)

Author: Ebonsignori

eslint.config.ts

@@ -185,7 +185,7 @@ export default [
       'src/languages/**/*.{ts,js}',
       'src/links/**/*.{ts,js}',
       'src/metrics/**/*.{ts,js}',
-      'src/observability/**/*.{ts,js}',
+      'src/observability/lib/handle-package-not-found.ts',
       'src/rest/**/*.{ts,js}',
       'src/search/**/*.{ts,js}',
       'src/shielding/**/*.{ts,js}',

src/observability/lib/tracing.ts

@@ -26,6 +26,10 @@ import { ExpressInstrumentation } from '@opentelemetry/instrumentation-express'
 import { HttpInstrumentation } from '@opentelemetry/instrumentation-http'
 import { UndiciInstrumentation } from '@opentelemetry/instrumentation-undici'
 import { NodeSDK } from '@opentelemetry/sdk-node'
+import { createLogger } from '@/observability/logger'
+import { toError } from '@/observability/lib/to-error'
+
+const logger = createLogger(import.meta.url)
 
 if (process.env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT) {
   const sdk = new NodeSDK({
@@ -44,7 +48,9 @@ if (process.env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT) {
   try {
     sdk.start()
   } catch (error) {
-    console.error('[tracing] failed to start:', error instanceof Error ? error.message : error)
+    logger.error('[tracing] failed to start', {
+      error: toError(error),
+    })
   }
 
   // Gracefully shut down the SDK on process exit.
@@ -54,7 +60,7 @@ if (process.env.OTEL_EXPORTER_OTLP_TRACES_ENDPOINT) {
       await sdk.shutdown()
     } catch (error) {
       if (error instanceof Error) {
-        console.error(`[tracing] shutdown error: ${error.message}`)
+        logger.error('[tracing] shutdown error', { error })
       }
     }
   })

src/observability/middleware/handle-errors.ts

@@ -6,6 +6,7 @@ import { minimumNotFoundHtml } from '@/frame/lib/constants'
 import { setFastlySurrogateKey, SURROGATE_ENUMS } from '@/frame/middleware/set-fastly-surrogate-key'
 import { errorCacheControl } from '@/frame/middleware/cache-control'
 import statsd from '@/observability/lib/statsd'
+import { toError } from '@/observability/lib/to-error'
 import { ExtendedRequest } from '@/types'
 import { createLogger } from '@/observability/logger'
 
@@ -86,7 +87,7 @@ async function handleError(
       setFastlySurrogateKey(res, SURROGATE_ENUMS.DEFAULT)
     }
   } else if (DEBUG_MIDDLEWARE_TESTS) {
-    console.warn('An error occurred in some middleware handler', error)
+    logger.warn('An error occurred in some middleware handler', { error })
   }
 
   try {
@@ -147,7 +148,9 @@ async function handleError(
       await logException(error, req)
     }
   } catch (handlingError) {
-    console.error('An error occurred in the error handling middleware!', handlingError)
+    logger.error('An error occurred in the error handling middleware', {
+      error: toError(handlingError),
+    })
     next(handlingError)
     return
   }