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): add layer type to request hook context #1226

Merged
merged 3 commits into from
Oct 18, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4284f87
feat(koa): add layer type to request hook context
unflxw Oct 11, 2022
06e8290
Merge branch 'main' into add-layer-type-to-koa-request-hook-context
Oct 17, 2022
ad7604f
Merge branch 'main' into add-layer-type-to-koa-request-hook-context
Oct 18, 2022
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
6 changes: 5 additions & 1 deletion 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 @@ -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);
Expand Down
1 change: 1 addition & 0 deletions plugins/node/opentelemetry-instrumentation-koa/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ export type KoaContext = ParameterizedContext<DefaultState, RouterParamContext>;
export type KoaRequestInfo = {
context: KoaContext;
middlewareLayer: KoaMiddleware;
layerType: KoaLayerType;
};

/**
Expand Down
5 changes: 5 additions & 0 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 @@ -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({
Expand Down Expand Up @@ -634,6 +635,10 @@ describe('Koa Instrumentation', () => {
requestHandlerSpan?.attributes['app.env'],
'development'
);
assert.strictEqual(
requestHandlerSpan?.attributes['koa.layer'],
'router'
);
}
);
});
Expand Down