feat(koa): add layer type to request hook context (#1226)

Co-authored-by: Amir Blum <[email protected]>
open-telemetry · Oct 18, 2022 · 6300733 · 6300733
1 parent d291d3d
commit 6300733
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/plugins/node/opentelemetry-instrumentation-koa/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-koa/src/instrumentation.ts
@@ -196,7 +196,11 @@ export class KoaInstrumentation extends InstrumentationBase<typeof koa> {
       if (this.getConfig().requestHook) {
         safeExecuteInTheMiddle(
           () =>
-            this.getConfig().requestHook!(span, { context, middlewareLayer }),
+            this.getConfig().requestHook!(span, {
+              context,
+              middlewareLayer,
+              layerType,
+            }),
           e => {
             if (e) {
               api.diag.error('koa instrumentation: request hook failed', e);

diff --git a/plugins/node/opentelemetry-instrumentation-koa/src/types.ts b/plugins/node/opentelemetry-instrumentation-koa/src/types.ts
@@ -35,6 +35,7 @@ export type KoaContext = ParameterizedContext<DefaultState, RouterParamContext>;
 export type KoaRequestInfo = {
   context: KoaContext;
   middlewareLayer: KoaMiddleware;
+  layerType: KoaLayerType;
 };
 
 /**

diff --git a/plugins/node/opentelemetry-instrumentation-koa/test/koa.test.ts b/plugins/node/opentelemetry-instrumentation-koa/test/koa.test.ts
@@ -601,6 +601,7 @@ describe('Koa Instrumentation', () => {
       const requestHook = sinon.spy((span: Span, info: KoaRequestInfo) => {
         span.setAttribute('http.method', info.context.request.method);
         span.setAttribute('app.env', info.context.app.env);
+        span.setAttribute('koa.layer', info.layerType);
       });
 
       plugin.setConfig({
@@ -634,6 +635,10 @@ describe('Koa Instrumentation', () => {
             requestHandlerSpan?.attributes['app.env'],
             'development'
           );
+          assert.strictEqual(
+            requestHandlerSpan?.attributes['koa.layer'],
+            'router'
+          );
         }
       );
     });