Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(koa): Skip update HTTP's span name and update RpcMetadata's route instead #1567

Merged
merged 12 commits into from
Aug 13, 2023
Merged

feat(koa): Skip update HTTP's span name and update RpcMetadata's route instead #1567

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
eeac11f
feat(koa): Skip update HTTP's span name and update RpcMetadata's rout…
chigia001 Jul 11, 2023
2d0a81d
Merge branch 'main' into fix-1381-koa
chigia001 Jul 13, 2023
bf86395
Merge branch 'main' into fix-1381-koa
chigia001 Jul 15, 2023
acb99f8
Merge branch 'main' into fix-1381-koa
haddasbronfman Jul 16, 2023
047ed4f
Merge branch 'main' into fix-1381-koa
chigia001 Jul 21, 2023
4a31bec
make the logic of rpcMetadata.route the same as previously
chigia001 Aug 3, 2023
ca018b1
Merge branch 'main' into fix-1381-koa
chigia001 Aug 3, 2023
0fdcf8f
Merge branch 'main' into fix-1381-koa
chigia001 Aug 3, 2023
31f1904
Merge branch 'main' into fix-1381-koa
blumamir Aug 12, 2023
c002f96
Remove unused variable
chigia001 Aug 13, 2023
9256caf
Merge branch 'main' into fix-1381-koa
chigia001 Aug 13, 2023
ef8a835
Merge branch 'main' into fix-1381-koa
blumamir Aug 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 5 additions & 13 deletions plugins/node/opentelemetry-instrumentation-koa/src/instrumentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import {
import { AttributeNames } from './enums/AttributeNames';
import { VERSION } from './version';
import { getMiddlewareMetadata, isLayerIgnored } from './utils';
import { getRPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';
import { getRPCMetadata, RPCType } from '@opentelemetry/core';
import { kLayerPatched, KoaPatchedMiddleware } from './internal-types';

/** Koa instrumentation for OpenTelemetry */
Expand Down Expand Up @@ -176,19 +176,10 @@ export class KoaInstrumentation extends InstrumentationBase<typeof koa> {

if (
metadata.attributes[AttributeNames.KOA_TYPE] === KoaLayerType.ROUTER &&
rpcMetadata?.type === RPCType.HTTP
rpcMetadata?.type === RPCType.HTTP &&
context._matchedRoute
) {
rpcMetadata.span.updateName(
`${context.method} ${context._matchedRoute}`
);
}

let newContext = api.trace.setSpan(api.context.active(), span);
if (rpcMetadata?.type === RPCType.HTTP) {
newContext = setRPCMetadata(
newContext,
Object.assign(rpcMetadata, { route: context._matchedRoute })
);
rpcMetadata.route = context._matchedRoute.toString();
}

if (this.getConfig().requestHook) {
Expand All @@ -208,6 +199,7 @@ export class KoaInstrumentation extends InstrumentationBase<typeof koa> {
);
}

const newContext = api.trace.setSpan(api.context.active(), span);
return api.context.with(newContext, async () => {
try {
return await middlewareLayer(context, next);
Expand Down
34 changes: 12 additions & 22 deletions plugins/node/opentelemetry-instrumentation-koa/test/koa.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ import * as sinon from 'sinon';
import { AddressInfo } from 'net';
import { KoaLayerType, KoaRequestInfo } from '../src/types';
import { AttributeNames } from '../src/enums/AttributeNames';
import { RPCType, setRPCMetadata } from '@opentelemetry/core';
import { RPCMetadata, RPCType, setRPCMetadata } from '@opentelemetry/core';

const httpRequest = {
get: (options: http.ClientRequestArgs | string) => {
Expand Down Expand Up @@ -134,7 +134,7 @@ describe('Koa Instrumentation', () => {
describe('Instrumenting @koa/router calls', () => {
it('should create a child span for middlewares', async () => {
const rootSpan = tracer.startSpan('rootSpan');
const rpcMetadata = { type: RPCType.HTTP, span: rootSpan };
const rpcMetadata: RPCMetadata = { type: RPCType.HTTP, span: rootSpan };
app.use((ctx, next) =>
context.with(
setRPCMetadata(
Expand Down Expand Up @@ -174,17 +174,14 @@ describe('Koa Instrumentation', () => {
'/post/:id'
);

const exportedRootSpan = memoryExporter
.getFinishedSpans()
.find(span => span.name === 'GET /post/:id');
assert.notStrictEqual(exportedRootSpan, undefined);
assert.strictEqual(rpcMetadata.route, '/post/:id');
}
);
});

it('should create a named child span for middlewares', async () => {
const rootSpan = tracer.startSpan('rootSpan');
const rpcMetadata = { type: RPCType.HTTP, span: rootSpan };
const rpcMetadata: RPCMetadata = { type: RPCType.HTTP, span: rootSpan };
app.use((ctx, next) =>
context.with(
setRPCMetadata(
Expand Down Expand Up @@ -224,17 +221,14 @@ describe('Koa Instrumentation', () => {
'/post/:id'
);

const exportedRootSpan = memoryExporter
.getFinishedSpans()
.find(span => span.name === 'GET /post/:id');
assert.notStrictEqual(exportedRootSpan, undefined);
assert.strictEqual(rpcMetadata.route, '/post/:id');
}
);
});

it('should correctly instrument nested routers', async () => {
const rootSpan = tracer.startSpan('rootSpan');
const rpcMetadata = { type: RPCType.HTTP, span: rootSpan };
const rpcMetadata: RPCMetadata = { type: RPCType.HTTP, span: rootSpan };
app.use((ctx, next) =>
context.with(
setRPCMetadata(
Expand Down Expand Up @@ -276,17 +270,14 @@ describe('Koa Instrumentation', () => {
'/:first/post/:id'
);

const exportedRootSpan = memoryExporter
.getFinishedSpans()
.find(span => span.name === 'GET /:first/post/:id');
assert.notStrictEqual(exportedRootSpan, undefined);
assert.strictEqual(rpcMetadata.route, '/:first/post/:id');
}
);
});

it('should correctly instrument prefixed routers', async () => {
const rootSpan = tracer.startSpan('rootSpan');
const rpcMetadata = { type: RPCType.HTTP, span: rootSpan };
const rpcMetadata: RPCMetadata = { type: RPCType.HTTP, span: rootSpan };
app.use((ctx, next) =>
context.with(
setRPCMetadata(
Expand Down Expand Up @@ -326,10 +317,7 @@ describe('Koa Instrumentation', () => {
'/:first/post/:id'
);

const exportedRootSpan = memoryExporter
.getFinishedSpans()
.find(span => span.name === 'GET /:first/post/:id');
assert.notStrictEqual(exportedRootSpan, undefined);
assert.strictEqual(rpcMetadata.route, '/:first/post/:id');
}
);
});
Expand Down Expand Up @@ -364,7 +352,9 @@ describe('Koa Instrumentation', () => {
.find(span => span.name.includes('spanCreateMiddleware'));
assert.notStrictEqual(fooParentSpan, undefined);

const fooSpan = memoryExporter.getFinishedSpans().find(span => 'foo');
const fooSpan = memoryExporter
.getFinishedSpans()
.find(span => span.name === 'foo');
assert.notStrictEqual(fooSpan, undefined);
assert.strictEqual(
fooSpan!.parentSpanId,
Expand Down