Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(koa): Adds support to ignore a span by its layer name
Browse files Browse the repository at this point in the history
MrFabio committed May 24, 2024
1 parent 96eb7dc commit 1dce93d
Showing 6 changed files with 76 additions and 2 deletions.
1 change: 1 addition & 0 deletions plugins/node/opentelemetry-instrumentation-koa/README.md
Original file line number Diff line number Diff line change
@@ -52,6 +52,7 @@ Note that generator-based middleware are deprecated and won't be instrumented.
| Options | Type | Example | Description |
| ------------------ | ----------------------------------- | -------------------- | -------------------------------------------------------------------------------------------------------- |
| `ignoreLayersType` | `KoaLayerType[]` | `['middleware']` | Ignore layers of specified type. |
| `ignoreLayersName` | `string[]` | `['logger']` | Ignore layers with specified names. |
| `requestHook` | `KoaRequestCustomAttributeFunction` | `(span, info) => {}` | Function for adding custom attributes to Koa middleware layers. Receives params: `Span, KoaRequestInfo`. |

`ignoreLayersType` accepts an array of `KoaLayerType` which can take the following string values:
Original file line number Diff line number Diff line change
@@ -25,7 +25,11 @@ import {
import type * as koa from 'koa';
import { KoaContext, KoaLayerType, KoaInstrumentationConfig } from './types';
import { PACKAGE_NAME, PACKAGE_VERSION } from './version';
import { getMiddlewareMetadata, isLayerIgnored } from './utils';
import {
getMiddlewareMetadata,
isLayerIgnored,
isLayerNameIgnored,
} from './utils';
import { getRPCMetadata, RPCType } from '@opentelemetry/core';
import {
kLayerPatched,
@@ -168,6 +172,11 @@ export class KoaInstrumentation extends InstrumentationBase {
isRouter,
layerPath
);

if (isLayerNameIgnored(metadata.layerName, this.getConfig())) {
return middlewareLayer(context, next);

Check warning on line 177 in plugins/node/opentelemetry-instrumentation-koa/src/instrumentation.ts

Codecov / codecov/patch

plugins/node/opentelemetry-instrumentation-koa/src/instrumentation.ts#L177

Added line #L177 was not covered by tests
}

const span = this.tracer.startSpan(metadata.name, {
attributes: metadata.attributes,
});
2 changes: 2 additions & 0 deletions plugins/node/opentelemetry-instrumentation-koa/src/types.ts
Original file line number Diff line number Diff line change
@@ -46,6 +46,8 @@ export interface KoaRequestCustomAttributeFunction {
export interface KoaInstrumentationConfig extends InstrumentationConfig {
/** Ignore specific layers based on their type */
ignoreLayersType?: KoaLayerType[];
/** Ignore specific layers based on their name */
ignoreLayersName?: string[];
/** Function for adding custom attributes to each middleware layer span */
requestHook?: KoaRequestCustomAttributeFunction;
}
19 changes: 19 additions & 0 deletions plugins/node/opentelemetry-instrumentation-koa/src/utils.ts
Original file line number Diff line number Diff line change
@@ -27,6 +27,7 @@ export const getMiddlewareMetadata = (
): {
attributes: Attributes;
name: string;
layerName: string;
} => {
if (isRouter) {
return {
@@ -36,6 +37,7 @@ export const getMiddlewareMetadata = (
[SEMATTRS_HTTP_ROUTE]: layerPath?.toString(),
},
name: context._matchedRouteName || `router - ${layerPath}`,
layerName: context._matchedRouteName || layerPath?.toString() || '',
};
} else {
return {
@@ -44,6 +46,7 @@ export const getMiddlewareMetadata = (
[AttributeNames.KOA_TYPE]: KoaLayerType.MIDDLEWARE,
},
name: `middleware - ${layer.name}`,
layerName: layer.name,
};
}
};
@@ -63,3 +66,19 @@ export const isLayerIgnored = (
config?.ignoreLayersType?.includes(type)
);
};

/**
* Check whether the given request name is ignored by configuration
* @param [list] List of ignore name patterns
* @param [onException] callback for doing something when an exception has
* occurred
*/
export const isLayerNameIgnored = (
layerName: string,
config?: KoaInstrumentationConfig
): boolean => {
return !!(
Array.isArray(config?.ignoreLayersName) &&
config?.ignoreLayersName?.includes(layerName)
);
};
Original file line number Diff line number Diff line change
@@ -721,7 +721,7 @@ describe('Koa Instrumentation', () => {
'--experimental-loader=@opentelemetry/instrumentation/hook.mjs',
NODE_NO_WARNINGS: '1',
},
checkResult: (err, stdout, stderr) => {
checkResult: (err: any, stdout: any, stderr: any) => {
assert.ifError(err);
},
checkCollector: (collector: testUtils.TestCollector) => {
43 changes: 43 additions & 0 deletions plugins/node/opentelemetry-instrumentation-koa/test/utils.test.ts
Original file line number Diff line number Diff line change
@@ -58,4 +58,47 @@ describe('Utils', () => {
);
});
});
describe('isLayerNameIgnored()', () => {
it('should not fail with invalid config', () => {
assert.strictEqual(utils.isLayerNameIgnored(''), false);
assert.strictEqual(
utils.isLayerNameIgnored('', {} as KoaInstrumentationConfig),
false
);
assert.strictEqual(
utils.isLayerNameIgnored('', {
ignoreLayersName: {},
} as KoaInstrumentationConfig),
false
);
assert.strictEqual(
utils.isLayerNameIgnored('logger', {
ignoreLayersName: {},
} as KoaInstrumentationConfig),
false
);
assert.strictEqual(utils.isLayerNameIgnored('logger'), false);
assert.strictEqual(
utils.isLayerNameIgnored('', {
ignoreLayersName: [],
} as KoaInstrumentationConfig),
false
);
});

it('should ignore based on type', () => {
assert.strictEqual(
utils.isLayerNameIgnored('logger', {
ignoreLayersName: ['logger'],
}),
true
);
assert.strictEqual(
utils.isLayerNameIgnored('', {
ignoreLayersName: ['logger'],
}),
false
);
});
});
});

0 comments on commit 1dce93d

Please sign in to comment.