Merge remote-tracking branch 'origin/master' into feat/disableMemoFlag

Author: mairatma

CHANGELOG.md

@@ -10,6 +10,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 - Allow disabling memoization for all requests of a client
+## [6.45.23] - 2023-10-04
+
+### Fixed
+- Fix metrics being restricted by tracing restrictions
 
 ## [6.45.22] - 2023-09-20
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/api",
-  "version": "6.45.22",
+  "version": "6.45.23",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

src/service/metrics/requestMetricsMiddleware.ts

@@ -0,0 +1,70 @@
+import { finished as onStreamFinished } from 'stream'
+import { hrToMillisFloat } from '../../utils'
+import {
+  createConcurrentRequestsInstrument,
+  createRequestsResponseSizesInstrument,
+  createRequestsTimingsInstrument,
+  createTotalAbortedRequestsInstrument,
+  createTotalRequestsInstrument,
+  RequestsMetricLabels,
+} from '../tracing/metrics/instruments'
+import { ServiceContext } from '../worker/runtime/typings'
+
+
+export const addRequestMetricsMiddleware = () => {
+  const concurrentRequests = createConcurrentRequestsInstrument()
+  const requestTimings = createRequestsTimingsInstrument()
+  const totalRequests = createTotalRequestsInstrument()
+  const responseSizes = createRequestsResponseSizesInstrument()
+  const abortedRequests = createTotalAbortedRequestsInstrument()
+
+  return async function addRequestMetrics(ctx: ServiceContext, next: () => Promise<void>) {
+    const start = process.hrtime()
+    concurrentRequests.inc(1)
+
+    ctx.req.once('aborted', () =>
+      abortedRequests.inc({ [RequestsMetricLabels.REQUEST_HANDLER]: ctx.requestHandlerName }, 1)
+    )
+
+    let responseClosed = false
+    ctx.res.once('close', () => (responseClosed = true))
+
+    try {
+      await next()
+    } finally {
+      const responseLength = ctx.response.length
+      if (responseLength) {
+        responseSizes.observe(
+          { [RequestsMetricLabels.REQUEST_HANDLER]: ctx.requestHandlerName },
+          responseLength
+        )
+      }
+
+      totalRequests.inc(
+        {
+          [RequestsMetricLabels.REQUEST_HANDLER]: ctx.requestHandlerName,
+          [RequestsMetricLabels.STATUS_CODE]: ctx.response.status,
+        },
+        1
+      )
+
+      const onResFinished = () => {
+        requestTimings.observe(
+          {
+            [RequestsMetricLabels.REQUEST_HANDLER]: ctx.requestHandlerName,
+          },
+          hrToMillisFloat(process.hrtime(start))
+        )
+
+        concurrentRequests.dec(1)
+      }
+
+      if (responseClosed) {
+        onResFinished()
+      } else {
+        onStreamFinished(ctx.res, onResFinished)
+      }
+    }
+  }
+}
+

src/service/tracing/tracingMiddlewares.ts

@@ -7,35 +7,19 @@ import { RuntimeLogFields } from '../../tracing/LogFields'
 import { CustomHttpTags, OpentracingTags, VTEXIncomingRequestTags } from '../../tracing/Tags'
 import { UserLandTracer } from '../../tracing/UserLandTracer'
 import { cloneAndSanitizeHeaders } from '../../tracing/utils'
-import { hrToMillis, hrToMillisFloat } from '../../utils'
+import { hrToMillis } from '../../utils'
 import { ServiceContext } from '../worker/runtime/typings'
-import {
-  createConcurrentRequestsInstrument,
-  createRequestsResponseSizesInstrument,
-  createRequestsTimingsInstrument,
-  createTotalAbortedRequestsInstrument,
-  createTotalRequestsInstrument,
-  RequestsMetricLabels,
-} from './metrics/instruments'
 
 const PATHS_BLACKLISTED_FOR_TRACING = ['/_status', '/healthcheck']
 
 export const addTracingMiddleware = (tracer: Tracer) => {
-  const concurrentRequests = createConcurrentRequestsInstrument()
-  const requestTimings = createRequestsTimingsInstrument()
-  const totalRequests = createTotalRequestsInstrument()
-  const responseSizes = createRequestsResponseSizesInstrument()
-  const abortedRequests = createTotalAbortedRequestsInstrument()
 
   return async function addTracing(ctx: ServiceContext, next: () => Promise<void>) {
-    const start = process.hrtime()
-    concurrentRequests.inc(1)
     const rootSpan = tracer.extract(FORMAT_HTTP_HEADERS, ctx.request.headers) as undefined | SpanContext
     ctx.tracing = { tracer, currentSpan: undefined}
 
     if (!shouldTrace(ctx, rootSpan)) {
       await next()
-      concurrentRequests.dec(1)
       return
     }
 
@@ -47,9 +31,6 @@ export const addTracingMiddleware = (tracer: Tracer) => {
     const initialSamplingDecision = getTraceInfo(currentSpan).isSampled
 
     ctx.tracing = { currentSpan, tracer }
-    ctx.req.once('aborted', () =>
-      abortedRequests.inc({ [RequestsMetricLabels.REQUEST_HANDLER]: (currentSpan as any).operationName as string }, 1)
-    )
 
     let responseClosed = false
     ctx.res.once('close', () => (responseClosed = true))
@@ -60,22 +41,6 @@ export const addTracingMiddleware = (tracer: Tracer) => {
       ErrorReport.create({ originalError: err }).injectOnSpan(currentSpan, ctx.vtex?.logger)
       throw err
     } finally {
-      const responseLength = ctx.response.length
-      if (responseLength) {
-        responseSizes.observe(
-          { [RequestsMetricLabels.REQUEST_HANDLER]: (currentSpan as any).operationName as string },
-          responseLength
-        )
-      }
-
-      totalRequests.inc(
-        {
-          [RequestsMetricLabels.REQUEST_HANDLER]: (currentSpan as any).operationName as string,
-          [RequestsMetricLabels.STATUS_CODE]: ctx.response.status,
-        },
-        1
-      )
-
       const traceInfo = getTraceInfo(currentSpan)
       if (traceInfo?.isSampled) {
         if (!initialSamplingDecision) {
@@ -98,14 +63,6 @@ export const addTracingMiddleware = (tracer: Tracer) => {
       }
 
       const onResFinished = () => {
-        requestTimings.observe(
-          {
-            [RequestsMetricLabels.REQUEST_HANDLER]: (currentSpan as any).operationName as string,
-          },
-          hrToMillisFloat(process.hrtime(start))
-        )
-
-        concurrentRequests.dec(1)
         currentSpan?.finish()
       }
 
@@ -120,7 +77,8 @@ export const addTracingMiddleware = (tracer: Tracer) => {
 
 export const nameSpanOperationMiddleware = (operationType: string, operationName: string) => {
   return function nameSpanOperation(ctx: ServiceContext, next: () => Promise<void>) {
-    ctx.tracing?.currentSpan?.setOperationName(`${operationType}:${operationName}`)
+    ctx.requestHandlerName = `${operationType}:${operationName}`
+    ctx.tracing?.currentSpan?.setOperationName(ctx.requestHandlerName)
     return next()
   }
 }

src/service/worker/index.ts

@@ -12,6 +12,7 @@ import { MetricsAccumulator } from '../../metrics/MetricsAccumulator'
 import { getService } from '../loaders'
 import { logOnceToDevConsole } from '../logger/console'
 import { LogLevel } from '../logger/logger'
+import { addRequestMetricsMiddleware } from '../metrics/requestMetricsMiddleware'
 import { TracerSingleton } from '../tracing/TracerSingleton'
 import { addTracingMiddleware } from '../tracing/tracingMiddlewares'
 import { addProcessListeners, logger } from './listeners'
@@ -221,6 +222,7 @@ export const startWorker = (serviceJSON: ServiceJSON) => {
     .use(error)
     .use(prometheusLoggerMiddleware())
     .use(addTracingMiddleware(tracer))
+    .use(addRequestMetricsMiddleware())
     .use(addMetricsLoggerMiddleware())
     .use(concurrentRateLimiter(serviceJSON?.rateLimitPerReplica?.concurrent))
     .use(compress())

src/service/worker/runtime/typings.ts

@@ -37,6 +37,7 @@ export interface Context<T extends IOClients> {
   timings: Record<string, [number, number]>
   metrics: Record<string, [number, number]>
   previousTimerStart: [number, number]
+  requestHandlerName?: string
   serverTiming?: ServerTiming
   tracing?: TracingContext
 }