Merge f46705474f into bebdfa2a88

packages/otel/CHANGELOG.md

@@ -1,11 +1,5 @@
 # @hono/otel
 
-## 0.1.1
-
-### Patch Changes
-
-- [#1113](https://github.com/honojs/middleware/pull/1113) [`362b6701a6ee2843a51c1dfd5877a6164b7474fb`](https://github.com/honojs/middleware/commit/362b6701a6ee2843a51c1dfd5877a6164b7474fb) Thanks [@milohansen](https://github.com/milohansen)! - Use `req.routePath` to augment spans with the path that handled the request.
-
 ## 0.1.0
 
 ### Minor Changes

packages/otel/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hono/otel",
-  "version": "0.1.1",
+  "version": "0.1.0",
   "description": "OpenTelemetry middleware for Hono",
   "type": "module",
   "module": "dist/index.js",

packages/otel/src/index.test.ts

@@ -26,13 +26,6 @@ describe('OpenTelemetry middleware', () => {
     throw new Error('error message')
   })
 
-  const subapp = new Hono()
-  subapp.get('/hello', (c) => c.text('Hello from subapp!'))
-  subapp.get('*', (c) => c.text('Fallthrough'))
-
-  // mount subapp
-  app.route('/subapp', subapp)
-
   it('Should make a span', async () => {
     memoryExporter.reset()
     const response = await app.request('http://localhost/foo')
@@ -78,13 +71,4 @@ describe('OpenTelemetry middleware', () => {
     expect(span.name).toBe('GET /foo')
     expect(span.attributes[ATTR_HTTP_ROUTE]).toBe('/foo')
   })
-
-  // Issue #1112
-  it('Should set the correct span name for subapp', async () => {
-    memoryExporter.reset()
-    await app.request('http://localhost/subapp/hello')
-    const spans = memoryExporter.getFinishedSpans()
-    const [span] = spans
-    expect(span.name).toBe('GET /subapp/hello')
-  })
 })

packages/otel/src/index.ts

@@ -1,5 +1,5 @@
 import type { TracerProvider } from '@opentelemetry/api'
-import { SpanKind, SpanStatusCode, trace } from '@opentelemetry/api'
+import { SpanKind, SpanStatusCode,  trace } from '@opentelemetry/api'
 import {
   ATTR_HTTP_REQUEST_HEADER,
   ATTR_HTTP_REQUEST_METHOD,
@@ -10,19 +10,17 @@ import {
 } from '@opentelemetry/semantic-conventions'
 import type { Env, Input } from 'hono'
 import { createMiddleware } from 'hono/factory'
-import metadata from '../package.json' with { type: 'json' }
+import metadata from '../package.json' with { type: 'json'}
 
 const PACKAGE_NAME = metadata.name
 const PACKAGE_VERSION = metadata.version
 
-export type OtelOptions =
+export type OtelOptions = {
-  | {
+  augmentSpan?: false;
-      augmentSpan?: false
+  tracerProvider?: TracerProvider
-      tracerProvider?: TracerProvider
+} | {
-    }
+  augmentSpan: true;
-  | {
+}
-      augmentSpan: true
-    }
 
 export const otel = <E extends Env = any, P extends string = any, I extends Input = {}>(
   options: OtelOptions = {}
@@ -32,9 +30,9 @@ export const otel = <E extends Env = any, P extends string = any, I extends Inpu
       const result = await next()
       const span = trace.getActiveSpan()
       if (span != null) {
-        const routePath = c.req.routePath
+        const route = c.req.matchedRoutes[c.req.matchedRoutes.length - 1]
-        span.setAttribute(ATTR_HTTP_ROUTE, routePath)
+        span.setAttribute(ATTR_HTTP_ROUTE, route.path)
-        span.updateName(`${c.req.method} ${routePath}`)
+        span.updateName(`${c.req.method} ${route.path}`)
       }
       return result
     })
@@ -42,15 +40,15 @@ export const otel = <E extends Env = any, P extends string = any, I extends Inpu
   const tracerProvider = options.tracerProvider ?? trace.getTracerProvider()
   const tracer = tracerProvider.getTracer(PACKAGE_NAME, PACKAGE_VERSION)
   return createMiddleware<E, P, I>(async (c, next) => {
-    const routePath = c.req.routePath
+    const route = c.req.matchedRoutes[c.req.matchedRoutes.length - 1]
     await tracer.startActiveSpan(
-      `${c.req.method} ${c.req.routePath}`,
+      `${c.req.method} ${route.path}`,
       {
         kind: SpanKind.SERVER,
         attributes: {
           [ATTR_HTTP_REQUEST_METHOD]: c.req.method,
           [ATTR_URL_FULL]: c.req.url,
-          [ATTR_HTTP_ROUTE]: routePath,
+          [ATTR_HTTP_ROUTE]: route.path,
         },
       },
       async (span) => {
@@ -59,10 +57,6 @@ export const otel = <E extends Env = any, P extends string = any, I extends Inpu
         }
         try {
           await next()
-          // Update the span name and route path now that we have the response
-          // because the route path may have changed
-          span.updateName(`${c.req.method} ${c.req.routePath}`)
-          span.setAttribute(ATTR_HTTP_ROUTE, c.req.routePath)
           span.setAttribute(ATTR_HTTP_RESPONSE_STATUS_CODE, c.res.status)
           for (const [name, value] of c.res.headers.entries()) {
             span.setAttribute(ATTR_HTTP_RESPONSE_HEADER(name), value)