diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/.eslintignore b/plugins/node/opentelemetry-instrumentation-aws-lambda/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/.eslintignore @@ -0,0 +1 @@ +build diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/.eslintrc.js b/plugins/node/opentelemetry-instrumentation-aws-lambda/.eslintrc.js new file mode 100644 index 0000000000..f756f4488b --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/.eslintrc.js @@ -0,0 +1,7 @@ +module.exports = { + "env": { + "mocha": true, + "node": true + }, + ...require('../../../eslint.config.js') +} diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/.npmignore b/plugins/node/opentelemetry-instrumentation-aws-lambda/.npmignore new file mode 100644 index 0000000000..9505ba9450 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/.npmignore @@ -0,0 +1,4 @@ +/bin +/coverage +/doc +/test diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/LICENSE b/plugins/node/opentelemetry-instrumentation-aws-lambda/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/README.md b/plugins/node/opentelemetry-instrumentation-aws-lambda/README.md new file mode 100644 index 0000000000..5f81212ddc --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/README.md @@ -0,0 +1,59 @@ +# OpenTelemetry AWS Lambda Instrumentation for Node.js + +[![NPM Published Version][npm-img]][npm-url] +[![dependencies][dependencies-image]][dependencies-url] +[![devDependencies][devDependencies-image]][devDependencies-url] +[![Apache License][license-image]][license-image] + +This module provides automatic instrumentation for [`AWS Lambda`](https://docs.aws.amazon.com/lambda/latest/dg/nodejs-handler.html). + +This module is currently under active development and not ready for general use. + +## Installation + +```bash +npm install --save @opentelemetry/instrumentation-aws-lambda +``` + +## Usage + +Create a file to initialize the instrumentation, such as `lambda-wrapper.js`. +```js +const { NodeTracerProvider } = require('@opentelemetry/node'); +const { AwsLambdaInstrumentation } = require('@opentelemetry/instrumentation-aws-lambda'); +const { registerInstrumentations } = require('@opentelemetry/instrumentation'); + +const provider = new NodeTracerProvider(); +provider.register(); + +registerInstrumentations({ + instrumentations: [ + new AwsLambdaInstrumentation() + ], + tracerProvider: provider, +}); +``` + +In your Lambda function configuration, add or update the `NODE_OPTIONS` environment variable to require the wrapper, e.g., + +`NODE_OPTIONS=--require lambda-wrapper` + +## Useful links + +- For more information on OpenTelemetry, visit: +- For more about OpenTelemetry JavaScript: +- For help or feedback on this project, join us in [GitHub Discussions][discussions-url] + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions +[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE +[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat +[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-aws-lambda +[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-aws-lambda +[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fnode%2Fopentelemetry-instrumentation-aws-lambda&type=dev +[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fnode%2Fopentelemetry-instrumentation-aws-lambda&type=dev +[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-aws-lambda +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-aws-lambda.svg diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/package.json b/plugins/node/opentelemetry-instrumentation-aws-lambda/package.json new file mode 100644 index 0000000000..10b0cab5b2 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/package.json @@ -0,0 +1,72 @@ +{ + "name": "@opentelemetry/instrumentation-aws-lambda", + "version": "0.15.0", + "description": "OpenTelemetry AWS Lambda automatic instrumentation package.", + "main": "build/src/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "test": "nyc ts-mocha -p tsconfig.json 'test/**/*.test.ts'", + "tdd": "npm run test -- --watch-extensions ts --watch", + "clean": "rimraf build/*", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "codecov": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../", + "precompile": "tsc --version", + "prepare": "npm run compile", + "version:update": "node ../../../scripts/version-update.js", + "compile": "npm run version:update && tsc -p ." + }, + "keywords": [ + "opentelemetry", + "aws-lambda", + "nodejs", + "tracing", + "profiling", + "instrumentation" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=8.5.0" + }, + "files": [ + "build/src/**/*.js", + "build/src/**/*.d.ts", + "doc", + "LICENSE", + "README.md" + ], + "publishConfig": { + "access": "public" + }, + "devDependencies": { + "@opentelemetry/core": "0.18.2", + "@opentelemetry/node": "0.18.2", + "@types/aws-lambda": "8.10.73", + "@types/mocha": "7.0.2", + "@types/node": "14.0.27", + "@types/semver": "7.3.1", + "@types/shimmer": "1.0.1", + "@types/sinon": "9.0.4", + "codecov": "3.7.2", + "copyfiles": "2.4.1", + "gts": "2.0.2", + "mocha": "7.2.0", + "nyc": "15.1.0", + "rimraf": "3.0.2", + "sinon": "9.0.2", + "ts-mocha": "8.0.0", + "ts-node": "9.0.0", + "tslint-consistent-codestyle": "1.16.0", + "tslint-microsoft-contrib": "6.2.0", + "typescript": "3.9.7" + }, + "dependencies": { + "@opentelemetry/api": "^0.18.0", + "@opentelemetry/instrumentation": "^0.18.0", + "@opentelemetry/resources": "^0.18.0", + "@opentelemetry/semantic-conventions": "^0.18.0", + "@opentelemetry/tracing": "^0.18.0" + } +} diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/src/aws-lambda.ts b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/aws-lambda.ts new file mode 100644 index 0000000000..2c25347e54 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/aws-lambda.ts @@ -0,0 +1,219 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import * as path from 'path'; + +import { + InstrumentationBase, + InstrumentationNodeModuleDefinition, + InstrumentationNodeModuleFile, + isWrapped, + safeExecuteInTheMiddle, +} from '@opentelemetry/instrumentation'; +import { + diag, + Span, + SpanKind, + SpanStatusCode, + TracerProvider, +} from '@opentelemetry/api'; +import { CLOUD_RESOURCE } from '@opentelemetry/resources'; +import { FaasAttribute } from '@opentelemetry/semantic-conventions'; + +import { Callback, Context, Handler } from 'aws-lambda'; + +import { LambdaModule } from './types'; +import { VERSION } from './version'; +import { BasicTracerProvider } from '@opentelemetry/tracing'; + +export class AwsLambdaInstrumentation extends InstrumentationBase { + private _tracerProvider: TracerProvider | undefined; + + constructor() { + super('@opentelemetry/instrumentation-aws-lambda', VERSION); + } + + init() { + const taskRoot = process.env.LAMBDA_TASK_ROOT; + const handlerDef = process.env._HANDLER; + + // _HANDLER and LAMBDA_TASK_ROOT are always defined in Lambda but guard bail out if in the future this changes. + if (!taskRoot || !handlerDef) { + return []; + } + + const handler = path.basename(handlerDef); + const moduleRoot = handlerDef.substr(0, handlerDef.length - handler.length); + + const [module, functionName] = handler.split('.', 2); + + // Lambda loads user function using an absolute path. + let filename = path.resolve(taskRoot, moduleRoot, module); + if (!filename.endsWith('.js')) { + // Patching infrastructure currently requires a filename when requiring with an absolute path. + filename += '.js'; + } + + return [ + new InstrumentationNodeModuleDefinition( + // NB: The patching infrastructure seems to match names backwards, this must be the filename, while + // InstrumentationNodeModuleFile must be the module name. + filename, + ['*'], + undefined, + undefined, + [ + new InstrumentationNodeModuleFile( + module, + ['*'], + (moduleExports: LambdaModule) => { + diag.debug('Applying patch for lambda handler'); + if (isWrapped(moduleExports[functionName])) { + this._unwrap(moduleExports, functionName); + } + this._wrap(moduleExports, functionName, this._getHandler()); + return moduleExports; + }, + (moduleExports?: LambdaModule) => { + if (moduleExports == undefined) return; + diag.debug('Removing patch for lambda handler'); + this._unwrap(moduleExports, functionName); + } + ), + ] + ), + ]; + } + + private _getHandler() { + return (original: Handler) => { + return this._getPatchHandler(original); + }; + } + + private _getPatchHandler(original: Handler) { + diag.debug('patch handler function'); + const plugin = this; + + return function patchedHandler( + this: never, + event: {}, + context: Context, + callback: Callback + ) { + const name = context.functionName; + const span = plugin.tracer.startSpan(name, { + kind: SpanKind.SERVER, + attributes: { + [FaasAttribute.FAAS_EXECUTION]: context.awsRequestId, + [FaasAttribute.FAAS_ID]: context.invokedFunctionArn, + [CLOUD_RESOURCE.ACCOUNT_ID]: AwsLambdaInstrumentation._extractAccountId( + context.invokedFunctionArn + ), + }, + }); + + // Lambda seems to pass a callback even if handler is of Promise form, so we wrap all the time before calling + // the handler and see if the result is a Promise or not. In such a case, the callback is usually ignored. If + // the handler happened to both call the callback and complete a returned Promise, whichever happens first will + // win and the latter will be ignored. + const wrappedCallback = plugin._wrapCallback(callback, span); + const maybePromise = safeExecuteInTheMiddle( + () => original.apply(this, [event, context, wrappedCallback]), + error => { + if (error != null) { + // Exception thrown synchronously before resolving callback / promise. + plugin._endSpan(span, error, () => {}); + } + } + ) as Promise<{}> | undefined; + if (typeof maybePromise?.then === 'function') { + return maybePromise.then( + value => + new Promise(resolve => + plugin._endSpan(span, undefined, () => resolve(value)) + ), + (err: Error | string) => + new Promise((resolve, reject) => + plugin._endSpan(span, err, () => reject(err)) + ) + ); + } + return maybePromise; + }; + } + + setTracerProvider(tracerProvider: TracerProvider) { + super.setTracerProvider(tracerProvider); + this._tracerProvider = tracerProvider; + } + + private _wrapCallback(original: Callback, span: Span): Callback { + const plugin = this; + return function wrappedCallback(this: never, err, res) { + diag.debug('executing wrapped lookup callback function'); + + plugin._endSpan(span, err, () => { + diag.debug('executing original lookup callback function'); + return original.apply(this, [err, res]); + }); + }; + } + + private _endSpan( + span: Span, + err: string | Error | null | undefined, + callback: () => void + ) { + if (err) { + span.recordException(err); + } + + let errMessage; + if (typeof err === 'string') { + errMessage = err; + } else if (err) { + errMessage = err.message; + } + if (errMessage) { + span.setStatus({ + code: SpanStatusCode.ERROR, + message: errMessage, + }); + } + + span.end(); + if (this._tracerProvider instanceof BasicTracerProvider) { + this._tracerProvider + .getActiveSpanProcessor() + .forceFlush() + .then( + () => callback(), + () => callback() + ); + } else { + callback(); + } + } + + private static _extractAccountId(arn: string): string | undefined { + const parts = arn.split(':'); + if (parts.length >= 5) { + return parts[4]; + } + return undefined; + } +} diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/src/index.ts b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/index.ts new file mode 100644 index 0000000000..ae16464e8e --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/index.ts @@ -0,0 +1,17 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +export * from './aws-lambda'; diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/src/types.ts b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/types.ts new file mode 100644 index 0000000000..2e6c44af47 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/types.ts @@ -0,0 +1,19 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +import { Handler } from 'aws-lambda'; + +export type LambdaModule = Record; diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/src/version.ts b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/version.ts new file mode 100644 index 0000000000..1e4172026f --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/src/version.ts @@ -0,0 +1,18 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// this is autogenerated file, see scripts/version-update.js +export const VERSION = '0.15.0'; diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/test/integrations/lambda-handler.test.ts b/plugins/node/opentelemetry-instrumentation-aws-lambda/test/integrations/lambda-handler.test.ts new file mode 100644 index 0000000000..5767be9b31 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/test/integrations/lambda-handler.test.ts @@ -0,0 +1,270 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// We access through node_modules to allow it to be patched. +/* eslint-disable node/no-extraneous-require */ + +import * as path from 'path'; + +import { AwsLambdaInstrumentation } from '../../src/index'; +import { + BatchSpanProcessor, + InMemorySpanExporter, + ReadableSpan, +} from '@opentelemetry/tracing'; +import { NodeTracerProvider } from '@opentelemetry/node'; +import { Context } from 'aws-lambda'; +import * as assert from 'assert'; +import { SpanKind, SpanStatusCode } from '@opentelemetry/api'; +import { + ExceptionAttribute, + FaasAttribute, +} from '@opentelemetry/semantic-conventions'; + +const memoryExporter = new InMemorySpanExporter(); +const provider = new NodeTracerProvider(); +provider.addSpanProcessor(new BatchSpanProcessor(memoryExporter)); + +const assertSpanSuccess = (span: ReadableSpan) => { + assert.strictEqual(span.kind, SpanKind.SERVER); + assert.strictEqual(span.name, 'my_function'); + assert.strictEqual( + span.attributes[FaasAttribute.FAAS_EXECUTION], + 'aws_request_id' + ); + assert.strictEqual(span.attributes[FaasAttribute.FAAS_ID], 'my_arn'); + assert.strictEqual(span.status.code, SpanStatusCode.UNSET); + assert.strictEqual(span.status.message, undefined); +}; + +const assertSpanFailure = (span: ReadableSpan) => { + assert.strictEqual(span.kind, SpanKind.SERVER); + assert.strictEqual(span.name, 'my_function'); + assert.strictEqual( + span.attributes[FaasAttribute.FAAS_EXECUTION], + 'aws_request_id' + ); + assert.strictEqual(span.attributes[FaasAttribute.FAAS_ID], 'my_arn'); + assert.strictEqual(span.status.code, SpanStatusCode.ERROR); + assert.strictEqual(span.status.message, 'handler error'); + assert.strictEqual(span.events.length, 1); + assert.strictEqual( + span.events[0].attributes![ExceptionAttribute.MESSAGE], + 'handler error' + ); +}; + +describe('lambda handler', () => { + let instrumentation: AwsLambdaInstrumentation; + + let oldEnv: NodeJS.ProcessEnv; + + const ctx = { + functionName: 'my_function', + invokedFunctionArn: 'my_arn', + awsRequestId: 'aws_request_id', + } as Context; + + const initializeHandler = (handler: string) => { + process.env._HANDLER = handler; + + instrumentation = new AwsLambdaInstrumentation(); + instrumentation.setTracerProvider(provider); + }; + + const lambdaRequire = (module: string) => + require(path.resolve(__dirname, '..', module)); + + beforeEach(() => { + oldEnv = { ...process.env }; + process.env.LAMBDA_TASK_ROOT = path.resolve(__dirname, '..'); + }); + + afterEach(() => { + process.env = oldEnv; + instrumentation.disable(); + + memoryExporter.reset(); + }); + + describe('async success handler', () => { + it('should export a valid span', async () => { + initializeHandler('lambda-test/async.handler'); + + const result = await lambdaRequire('lambda-test/async').handler( + 'arg', + ctx + ); + assert.strictEqual(result, 'ok'); + const spans = memoryExporter.getFinishedSpans(); + const [span] = spans; + assert.strictEqual(spans.length, 1); + assertSpanSuccess(span); + }); + + it('should record error', async () => { + initializeHandler('lambda-test/async.error'); + + let err: Error; + try { + await lambdaRequire('lambda-test/async').error('arg', ctx); + } catch (e) { + err = e; + } + assert.strictEqual(err!.message, 'handler error'); + const spans = memoryExporter.getFinishedSpans(); + const [span] = spans; + assert.strictEqual(spans.length, 1); + assertSpanFailure(span); + }); + + it('should record string error', async () => { + initializeHandler('lambda-test/async.stringerror'); + + let err: string; + try { + await lambdaRequire('lambda-test/async').stringerror('arg', ctx); + } catch (e) { + err = e; + } + assert.strictEqual(err!, 'handler error'); + const spans = memoryExporter.getFinishedSpans(); + const [span] = spans; + assertSpanFailure(span); + }); + }); + + describe('sync success handler', () => { + it('should export a valid span', async () => { + initializeHandler('lambda-test/sync.handler'); + + const result = await new Promise((resolve, reject) => { + lambdaRequire('lambda-test/sync').handler( + 'arg', + ctx, + (err: Error, res: any) => { + if (err) { + reject(err); + } else { + resolve(res); + } + } + ); + }); + assert.strictEqual(result, 'ok'); + const spans = memoryExporter.getFinishedSpans(); + const [span] = spans; + assert.strictEqual(spans.length, 1); + assertSpanSuccess(span); + }); + + it('should record error', async () => { + initializeHandler('lambda-test/sync.error'); + + let err: Error; + try { + lambdaRequire('lambda-test/sync').error( + 'arg', + ctx, + (err: Error, res: any) => {} + ); + } catch (e) { + err = e; + } + assert.strictEqual(err!.message, 'handler error'); + const spans = memoryExporter.getFinishedSpans(); + const [span] = spans; + assert.strictEqual(spans.length, 1); + assertSpanFailure(span); + }); + + it('should record error in callback', async () => { + initializeHandler('lambda-test/sync.callbackerror'); + + let err: Error; + try { + await new Promise((resolve, reject) => { + lambdaRequire('lambda-test/sync').callbackerror( + 'arg', + ctx, + (err: Error, res: any) => { + if (err) { + reject(err); + } else { + resolve(res); + } + } + ); + }); + } catch (e) { + err = e; + } + assert.strictEqual(err!.message, 'handler error'); + const spans = memoryExporter.getFinishedSpans(); + const [span] = spans; + assert.strictEqual(spans.length, 1); + assertSpanFailure(span); + }); + + it('should record string error', async () => { + initializeHandler('lambda-test/sync.stringerror'); + + let err: string; + try { + lambdaRequire('lambda-test/sync').stringerror( + 'arg', + ctx, + (err: Error, res: any) => {} + ); + } catch (e) { + err = e; + } + assert.strictEqual(err!, 'handler error'); + const spans = memoryExporter.getFinishedSpans(); + const [span] = spans; + assert.strictEqual(spans.length, 1); + assertSpanFailure(span); + }); + }); + + it('should record string error in callback', async () => { + initializeHandler('lambda-test/sync.callbackstringerror'); + + let err: string; + try { + await new Promise((resolve, reject) => { + lambdaRequire('lambda-test/sync').callbackstringerror( + 'arg', + ctx, + (err: Error, res: any) => { + if (err) { + reject(err); + } else { + resolve(res); + } + } + ); + }); + } catch (e) { + err = e; + } + assert.strictEqual(err!, 'handler error'); + const spans = memoryExporter.getFinishedSpans(); + const [span] = spans; + assert.strictEqual(spans.length, 1); + assertSpanFailure(span); + }); +}); diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/test/lambda-test/async.js b/plugins/node/opentelemetry-instrumentation-aws-lambda/test/lambda-test/async.js new file mode 100644 index 0000000000..e352c8d608 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/test/lambda-test/async.js @@ -0,0 +1,27 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +exports.handler = async function (event, context) { + return 'ok'; +}; + +exports.error = async function (event, context) { + throw new Error('handler error'); +} + +exports.stringerror = async function (event, context) { + throw 'handler error'; +} diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/test/lambda-test/package.json b/plugins/node/opentelemetry-instrumentation-aws-lambda/test/lambda-test/package.json new file mode 100644 index 0000000000..d9f2e528c3 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/test/lambda-test/package.json @@ -0,0 +1,5 @@ +{ + "name": "lambda-test", + "version": "0.0.0", + "description": "Lambda handlers used in unit tests." +} diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/test/lambda-test/sync.js b/plugins/node/opentelemetry-instrumentation-aws-lambda/test/lambda-test/sync.js new file mode 100644 index 0000000000..0f65dce0ee --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/test/lambda-test/sync.js @@ -0,0 +1,35 @@ +/* + * Copyright The OpenTelemetry Authors + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +exports.handler = function (event, context, callback) { + callback(null, 'ok'); +}; + +exports.error = function (event, context, callback) { + throw new Error('handler error'); +} + +exports.callbackerror = function (event, context, callback) { + callback(new Error('handler error')); +} + +exports.stringerror = function (event, context, callback) { + throw 'handler error'; +} + +exports.callbackstringerror = function (event, context, callback) { + callback('handler error'); +} diff --git a/plugins/node/opentelemetry-instrumentation-aws-lambda/tsconfig.json b/plugins/node/opentelemetry-instrumentation-aws-lambda/tsconfig.json new file mode 100644 index 0000000000..28be80d266 --- /dev/null +++ b/plugins/node/opentelemetry-instrumentation-aws-lambda/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +}