From 921862ec0fea0b1a8ba8e06b26f058d788df7cce Mon Sep 17 00:00:00 2001 From: Purvi Kanal Date: Wed, 5 Mar 2025 12:32:51 -0500 Subject: [PATCH 01/13] initial scaffolding --- package-lock.json | 218 ++++++++++++++++++ .../.eslintignore | 1 + .../.eslintrc.js | 9 + .../CHANGELOG.md | 2 + .../LICENSE | 201 ++++++++++++++++ .../package.json | 77 +++++++ .../src/index.ts | 17 ++ .../src/instrumentation.ts | 29 +++ .../test/instrumentation.test.ts | 32 +++ .../tsconfig.esm.json | 11 + .../tsconfig.esnext.json | 11 + .../tsconfig.json | 11 + .../web-test-runner.config.mjs | 35 +++ 13 files changed, 654 insertions(+) create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/.eslintignore create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/.eslintrc.js create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/CHANGELOG.md create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/LICENSE create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/package.json create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/src/index.ts create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.esm.json create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.esnext.json create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.json create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/web-test-runner.config.mjs diff --git a/package-lock.json b/package-lock.json index 0f23d64e6b..3045fab7d6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10142,6 +10142,10 @@ "resolved": "plugins/web/opentelemetry-instrumentation-user-interaction", "link": true }, + "node_modules/@opentelemetry/instrumentation-web-exception": { + "resolved": "plugins/web/opentelemetry-instrumentation-web-exception", + "link": true + }, "node_modules/@opentelemetry/instrumentation-winston": { "resolved": "plugins/node/opentelemetry-instrumentation-winston", "link": true @@ -38408,6 +38412,41 @@ "node": ">=4.2.0" } }, + "plugins/web/opentelemetry-instrumentation-browser-exception": { + "version": "0.0.1", + "extraneous": true, + "license": "Apache-2.0", + "dependencies": { + "@opentelemetry/core": "^1.8.0", + "@opentelemetry/instrumentation": "^0.57.2", + "@opentelemetry/sdk-trace-web": "^1.15.0", + "@opentelemetry/semantic-conventions": "^1.27.0" + }, + "devDependencies": { + "@babel/core": "7.22.17", + "@jsdevtools/coverage-istanbul-loader": "3.0.5", + "@opentelemetry/api": "^1.3.0", + "@opentelemetry/sdk-trace-base": "^1.0.0", + "@rollup/plugin-commonjs": "^26.0.0", + "@rollup/plugin-node-resolve": "^15.2.3", + "@types/chai": "^4.3.10", + "@types/mocha": "10.0.10", + "@types/node": "18.18.14", + "@types/sinon": "17.0.4", + "@web/dev-server-esbuild": "^1.0.1", + "@web/dev-server-rollup": "^0.6.1", + "@web/test-runner": "^0.18.0", + "chai": "^4.3.10", + "sinon": "15.2.0", + "typescript": "4.4.4" + }, + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.3.0" + } + }, "plugins/web/opentelemetry-instrumentation-document-load": { "name": "@opentelemetry/instrumentation-document-load", "version": "0.44.1", @@ -38684,6 +38723,108 @@ "node": ">=4.2.0" } }, + "plugins/web/opentelemetry-instrumentation-web-exception": { + "name": "@opentelemetry/instrumentation-web-exception", + "version": "0.0.1", + "license": "Apache-2.0", + "dependencies": { + "@opentelemetry/core": "^1.8.0", + "@opentelemetry/instrumentation": "^0.57.2", + "@opentelemetry/sdk-trace-web": "^1.15.0", + "@opentelemetry/semantic-conventions": "^1.27.0" + }, + "devDependencies": { + "@babel/core": "7.22.17", + "@jsdevtools/coverage-istanbul-loader": "3.0.5", + "@opentelemetry/api": "^1.3.0", + "@opentelemetry/sdk-trace-base": "^1.0.0", + "@rollup/plugin-commonjs": "^26.0.0", + "@rollup/plugin-node-resolve": "^15.2.3", + "@types/chai": "^4.3.10", + "@types/mocha": "10.0.10", + "@types/node": "18.18.14", + "@types/sinon": "17.0.4", + "@web/dev-server-esbuild": "^1.0.1", + "@web/dev-server-rollup": "^0.6.1", + "@web/test-runner": "^0.18.0", + "chai": "^4.3.10", + "sinon": "15.2.0", + "typescript": "4.4.4" + }, + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.3.0" + } + }, + "plugins/web/opentelemetry-instrumentation-web-exception/node_modules/@babel/core": { + "version": "7.22.17", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.22.17.tgz", + "integrity": "sha512-2EENLmhpwplDux5PSsZnSbnSkB3tZ6QTksgO25xwEL7pIDcNOMhF5v/s6RzwjMZzZzw9Ofc30gHv5ChCC8pifQ==", + "dev": true, + "dependencies": { + "@ampproject/remapping": "^2.2.0", + "@babel/code-frame": "^7.22.13", + "@babel/generator": "^7.22.15", + "@babel/helper-compilation-targets": "^7.22.15", + "@babel/helper-module-transforms": "^7.22.17", + "@babel/helpers": "^7.22.15", + "@babel/parser": "^7.22.16", + "@babel/template": "^7.22.15", + "@babel/traverse": "^7.22.17", + "@babel/types": "^7.22.17", + "convert-source-map": "^1.7.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.2", + "json5": "^2.2.3", + "semver": "^6.3.1" + }, + "engines": { + "node": ">=6.9.0" + }, + "funding": { + "type": "opencollective", + "url": "https://opencollective.com/babel" + } + }, + "plugins/web/opentelemetry-instrumentation-web-exception/node_modules/@types/node": { + "version": "18.18.14", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", + "integrity": "sha512-iSOeNeXYNYNLLOMDSVPvIFojclvMZ/HDY2dU17kUlcsOsSQETbWIslJbYLZgA+ox8g2XQwSHKTkght1a5X26lQ==", + "dev": true, + "dependencies": { + "undici-types": "~5.26.4" + } + }, + "plugins/web/opentelemetry-instrumentation-web-exception/node_modules/convert-source-map": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-1.9.0.tgz", + "integrity": "sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==", + "dev": true + }, + "plugins/web/opentelemetry-instrumentation-web-exception/node_modules/semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true, + "bin": { + "semver": "bin/semver.js" + } + }, + "plugins/web/opentelemetry-instrumentation-web-exception/node_modules/typescript": { + "version": "4.4.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz", + "integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=4.2.0" + } + }, "plugins/web/opentelemetry-plugin-react-load": { "name": "@opentelemetry/plugin-react-load", "version": "0.31.1", @@ -48561,6 +48702,83 @@ } } }, + "@opentelemetry/instrumentation-web-exception": { + "version": "file:plugins/web/opentelemetry-instrumentation-web-exception", + "requires": { + "@babel/core": "7.22.17", + "@jsdevtools/coverage-istanbul-loader": "3.0.5", + "@opentelemetry/api": "^1.3.0", + "@opentelemetry/core": "^1.8.0", + "@opentelemetry/instrumentation": "^0.57.2", + "@opentelemetry/sdk-trace-base": "^1.0.0", + "@opentelemetry/sdk-trace-web": "^1.15.0", + "@opentelemetry/semantic-conventions": "^1.27.0", + "@rollup/plugin-commonjs": "^26.0.0", + "@rollup/plugin-node-resolve": "^15.2.3", + "@types/chai": "^4.3.10", + "@types/mocha": "10.0.10", + "@types/node": "18.18.14", + "@types/sinon": "17.0.4", + "@web/dev-server-esbuild": "^1.0.1", + "@web/dev-server-rollup": "^0.6.1", + "@web/test-runner": "^0.18.0", + "chai": "^4.3.10", + "sinon": "15.2.0", + "typescript": "4.4.4" + }, + "dependencies": { + "@babel/core": { + "version": "7.22.17", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.22.17.tgz", + "integrity": "sha512-2EENLmhpwplDux5PSsZnSbnSkB3tZ6QTksgO25xwEL7pIDcNOMhF5v/s6RzwjMZzZzw9Ofc30gHv5ChCC8pifQ==", + "dev": true, + "requires": { + "@ampproject/remapping": "^2.2.0", + "@babel/code-frame": "^7.22.13", + "@babel/generator": "^7.22.15", + "@babel/helper-compilation-targets": "^7.22.15", + "@babel/helper-module-transforms": "^7.22.17", + "@babel/helpers": "^7.22.15", + "@babel/parser": "^7.22.16", + "@babel/template": "^7.22.15", + "@babel/traverse": "^7.22.17", + "@babel/types": "^7.22.17", + "convert-source-map": "^1.7.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.2", + "json5": "^2.2.3", + "semver": "^6.3.1" + } + }, + "@types/node": { + "version": "18.18.14", + "resolved": "https://registry.npmjs.org/@types/node/-/node-18.18.14.tgz", + "integrity": "sha512-iSOeNeXYNYNLLOMDSVPvIFojclvMZ/HDY2dU17kUlcsOsSQETbWIslJbYLZgA+ox8g2XQwSHKTkght1a5X26lQ==", + "dev": true, + "requires": { + "undici-types": "~5.26.4" + } + }, + "convert-source-map": { + "version": "1.9.0", + "resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-1.9.0.tgz", + "integrity": "sha512-ASFBup0Mz1uyiIjANan1jzLQami9z1PoYSZCiiYW2FczPbenXc45FZdBZLzOT+r6+iciuEModtmCti+hjaAk0A==", + "dev": true + }, + "semver": { + "version": "6.3.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.1.tgz", + "integrity": "sha512-BR7VvDCVHO+q2xBEWskxS6DJE1qRnb7DxzUrogb71CWoSficBxYsiAGd+Kl0mmq/MprG9yArRkyrQxTO6XjMzA==", + "dev": true + }, + "typescript": { + "version": "4.4.4", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz", + "integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==", + "dev": true + } + } + }, "@opentelemetry/instrumentation-winston": { "version": "file:plugins/node/opentelemetry-instrumentation-winston", "requires": { diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/.eslintignore b/plugins/web/opentelemetry-instrumentation-web-exception/.eslintignore new file mode 100644 index 0000000000..378eac25d3 --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/.eslintignore @@ -0,0 +1 @@ +build diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/.eslintrc.js b/plugins/web/opentelemetry-instrumentation-web-exception/.eslintrc.js new file mode 100644 index 0000000000..6efcc3621d --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/.eslintrc.js @@ -0,0 +1,9 @@ +module.exports = { + env: { + mocha: true, + commonjs: true, + browser: true, + jquery: true, + }, + ...require('../../../eslint.config.js'), +}; diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/CHANGELOG.md b/plugins/web/opentelemetry-instrumentation-web-exception/CHANGELOG.md new file mode 100644 index 0000000000..4dc68c6ff8 --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/CHANGELOG.md @@ -0,0 +1,2 @@ +# Changelog + diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/LICENSE b/plugins/web/opentelemetry-instrumentation-web-exception/LICENSE new file mode 100644 index 0000000000..261eeb9e9f --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/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/web/opentelemetry-instrumentation-web-exception/package.json b/plugins/web/opentelemetry-instrumentation-web-exception/package.json new file mode 100644 index 0000000000..915675d5ca --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/package.json @@ -0,0 +1,77 @@ +{ + "name": "@opentelemetry/instrumentation-web-exception", + "version": "0.0.1", + "description": "OpenTelemetry instrumentation for web exceptions", + "main": "build/src/index.js", + "module": "build/esm/index.js", + "esnext": "build/esnext/index.js", + "types": "build/src/index.d.ts", + "repository": "open-telemetry/opentelemetry-js-contrib", + "scripts": { + "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json tsconfig.esnext.json", + "lint": "eslint . --ext .ts", + "lint:fix": "eslint . --ext .ts --fix", + "lint:readme": "node ../../../scripts/lint-readme.js", + "prewatch": "npm run precompile", + "version:update": "node ../../../scripts/version-update.js", + "compile": "tsc --build tsconfig.json tsconfig.esm.json tsconfig.esnext.json", + "prepublishOnly": "npm run compile", + "tdd": "wtr --watch", + "test:browser": "wtr --coverage", + "watch": "tsc --build -watch tsconfig.json tsconfig.esm.json tsconfig.esnext.json" + }, + "keywords": [ + "opentelemetry", + "exception", + "web", + "tracing", + "plugin" + ], + "author": "OpenTelemetry Authors", + "license": "Apache-2.0", + "engines": { + "node": ">=14" + }, + "files": [ + "build/esm/**/*.js", + "build/esm/**/*.map", + "build/esm/**/*.d.ts", + "build/esnext/**/*.js", + "build/esnext/**/*.map", + "build/esnext/**/*.d.ts", + "build/src/**/*.js", + "build/src/**/*.map", + "build/src/**/*.d.ts" + ], + "publishConfig": { + "access": "public" + }, + "peerDependencies": { + "@opentelemetry/api": "^1.3.0" + }, + "devDependencies": { + "@babel/core": "7.22.17", + "@jsdevtools/coverage-istanbul-loader": "3.0.5", + "@opentelemetry/api": "^1.3.0", + "@opentelemetry/sdk-trace-base": "^1.0.0", + "@rollup/plugin-commonjs": "^26.0.0", + "@rollup/plugin-node-resolve": "^15.2.3", + "@types/chai": "^4.3.10", + "@types/mocha": "10.0.10", + "@types/node": "18.18.14", + "@types/sinon": "17.0.4", + "@web/dev-server-esbuild": "^1.0.1", + "@web/dev-server-rollup": "^0.6.1", + "@web/test-runner": "^0.18.0", + "chai": "^4.3.10", + "sinon": "15.2.0", + "typescript": "4.4.4" + }, + "dependencies": { + "@opentelemetry/core": "^1.8.0", + "@opentelemetry/instrumentation": "^0.57.2", + "@opentelemetry/sdk-trace-web": "^1.15.0", + "@opentelemetry/semantic-conventions": "^1.27.0" + }, + "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/web/opentelemetry-instrumentation-document-load#readme" +} \ No newline at end of file diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/src/index.ts b/plugins/web/opentelemetry-instrumentation-web-exception/src/index.ts new file mode 100644 index 0000000000..24c76056a1 --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/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 './instrumentation'; diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts new file mode 100644 index 0000000000..13576115bc --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts @@ -0,0 +1,29 @@ +/* + * 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 { + InstrumentationBase, + InstrumentationConfig, +} from '@opentelemetry/instrumentation'; + +export class WebExceptionInstrumentation extends InstrumentationBase { + constructor(config: InstrumentationConfig = {}) { + super('@opentelemetry/instrumentation-web-exception', '0.0.1', config); + console.log('WebExceptionInstrumentation was constructed'); + } + + init() {} +} diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts b/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts new file mode 100644 index 0000000000..4d706a5f9d --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts @@ -0,0 +1,32 @@ +/* + * 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 { WebExceptionInstrumentation } from '../src/instrumentation'; +// @ts-expect-error: not an export, but we want the prebundled version +import chai from 'chai/chai.js'; + +const assert = chai.assert; + +describe('WebExceptionInstrumentation', () => { + describe('constructor', () => { + it('should construct an instance', () => { + const instrumentation = new WebExceptionInstrumentation({ + enabled: false, + }); + assert.ok(instrumentation instanceof WebExceptionInstrumentation); + }); + }); +}); diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.esm.json b/plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.esm.json new file mode 100644 index 0000000000..379f547a46 --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.esm.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base.esm.json", + "compilerOptions": { + "rootDir": "src", + "outDir": "build/esm", + "tsBuildInfoFile": "build/esm/tsconfig.esm.tsbuildinfo" + }, + "include": [ + "src/**/*.ts" + ] +} diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.esnext.json b/plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.esnext.json new file mode 100644 index 0000000000..cb78dd6ff3 --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.esnext.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base.esnext.json", + "compilerOptions": { + "rootDir": "src", + "outDir": "build/esnext", + "tsBuildInfoFile": "build/esnext/tsconfig.esnext.tsbuildinfo" + }, + "include": [ + "src/**/*.ts" + ] +} diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.json b/plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.json new file mode 100644 index 0000000000..28be80d266 --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.json @@ -0,0 +1,11 @@ +{ + "extends": "../../../tsconfig.base", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "src/**/*.ts", + "test/**/*.ts" + ] +} diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/web-test-runner.config.mjs b/plugins/web/opentelemetry-instrumentation-web-exception/web-test-runner.config.mjs new file mode 100644 index 0000000000..1989a756fd --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/web-test-runner.config.mjs @@ -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 + * + * 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. + */ + +import { nodeResolve as nodeResolveRollup } from '@rollup/plugin-node-resolve'; +import commonjsRollup from '@rollup/plugin-commonjs'; +import { esbuildPlugin } from '@web/dev-server-esbuild'; +import { fromRollup } from '@web/dev-server-rollup'; +import { chromeLauncher } from '@web/test-runner'; + +const nodeResolve = fromRollup(nodeResolveRollup); +const commonjs = fromRollup(commonjsRollup); + +export default { + files: ['test/**/*.test.ts'], + nodeResolve: true, + browsers: [chromeLauncher({ launchOptions: { args: ['--no-sandbox'] } })], + plugins: [ + esbuildPlugin({ ts: true }), + nodeResolve({ browser: true, preferBuiltins: false }), + commonjs(), + ], +}; From 69d2d1f0ed56006826d49e55fab56eee2a6ff3bc Mon Sep 17 00:00:00 2001 From: Purvi Kanal Date: Fri, 7 Mar 2025 10:44:40 -0500 Subject: [PATCH 02/13] very basic implementation of errors autoinstrumentation --- package-lock.json | 23 ++++++++ .../package.json | 3 +- .../src/instrumentation.ts | 58 ++++++++++++++++++- 3 files changed, 82 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 3045fab7d6..c0bb96f9bb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9567,6 +9567,18 @@ "node": ">=8.0.0" } }, + "node_modules/@opentelemetry/api-events": { + "version": "0.57.2", + "resolved": "https://registry.npmjs.org/@opentelemetry/api-events/-/api-events-0.57.2.tgz", + "integrity": "sha512-jZn3FKfA3wyBznfJA+yCa3IZFTwT1HtVjPg3ueFEAInz33CsUbfX1otJR97nyhL8SnUgwo73lcGAg9+xv5ZBxg==", + "dependencies": { + "@opentelemetry/api": "^1.3.0", + "@opentelemetry/api-logs": "0.57.2" + }, + "engines": { + "node": ">=14" + } + }, "node_modules/@opentelemetry/api-logs": { "version": "0.57.2", "resolved": "https://registry.npmjs.org/@opentelemetry/api-logs/-/api-logs-0.57.2.tgz", @@ -38728,6 +38740,7 @@ "version": "0.0.1", "license": "Apache-2.0", "dependencies": { + "@opentelemetry/api-events": "^0.57.2", "@opentelemetry/core": "^1.8.0", "@opentelemetry/instrumentation": "^0.57.2", "@opentelemetry/sdk-trace-web": "^1.15.0", @@ -46265,6 +46278,15 @@ "resolved": "https://registry.npmjs.org/@opentelemetry/api/-/api-1.9.0.tgz", "integrity": "sha512-3giAOQvZiH5F9bMlMiv8+GSPMeqg0dbaeo58/0SlA9sxSqZhnUtxzX9/2FzyhS9sWQf5S0GJE0AKBrFqjpeYcg==" }, + "@opentelemetry/api-events": { + "version": "0.57.2", + "resolved": "https://registry.npmjs.org/@opentelemetry/api-events/-/api-events-0.57.2.tgz", + "integrity": "sha512-jZn3FKfA3wyBznfJA+yCa3IZFTwT1HtVjPg3ueFEAInz33CsUbfX1otJR97nyhL8SnUgwo73lcGAg9+xv5ZBxg==", + "requires": { + "@opentelemetry/api": "^1.3.0", + "@opentelemetry/api-logs": "0.57.2" + } + }, "@opentelemetry/api-logs": { "version": "0.57.2", "resolved": "https://registry.npmjs.org/@opentelemetry/api-logs/-/api-logs-0.57.2.tgz", @@ -48708,6 +48730,7 @@ "@babel/core": "7.22.17", "@jsdevtools/coverage-istanbul-loader": "3.0.5", "@opentelemetry/api": "^1.3.0", + "@opentelemetry/api-events": "^0.57.2", "@opentelemetry/core": "^1.8.0", "@opentelemetry/instrumentation": "^0.57.2", "@opentelemetry/sdk-trace-base": "^1.0.0", diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/package.json b/plugins/web/opentelemetry-instrumentation-web-exception/package.json index 915675d5ca..4049fb1ed9 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/package.json +++ b/plugins/web/opentelemetry-instrumentation-web-exception/package.json @@ -68,10 +68,11 @@ "typescript": "4.4.4" }, "dependencies": { + "@opentelemetry/api-events": "^0.57.2", "@opentelemetry/core": "^1.8.0", "@opentelemetry/instrumentation": "^0.57.2", "@opentelemetry/sdk-trace-web": "^1.15.0", "@opentelemetry/semantic-conventions": "^1.27.0" }, "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/web/opentelemetry-instrumentation-document-load#readme" -} \ No newline at end of file +} diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts index 13576115bc..e4c72084f6 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts +++ b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts @@ -18,12 +18,68 @@ import { InstrumentationBase, InstrumentationConfig, } from '@opentelemetry/instrumentation'; +import { + ATTR_EXCEPTION_TYPE, + ATTR_EXCEPTION_MESSAGE, + ATTR_EXCEPTION_STACKTRACE, +} from '@opentelemetry/semantic-conventions'; +// TODO: should events be imported or included as part of the instrumentation base class? +import { events } from '@opentelemetry/api-events'; +import { SeverityNumber } from '@opentelemetry/api-logs'; +import { Attributes } from '@opentelemetry/api'; + +export interface GlobalErrorsInstrumentationConfig + extends InstrumentationConfig { + /** + * A callback function for adding custom attributes to the span when an error is recorded. + * + * @param {Error} error - The error object that is being recorded. + * @returns {Attributes} - The attributes to add to the span. + */ + applyCustomAttributes?: (error: Error) => Attributes; +} export class WebExceptionInstrumentation extends InstrumentationBase { constructor(config: InstrumentationConfig = {}) { super('@opentelemetry/instrumentation-web-exception', '0.0.1', config); - console.log('WebExceptionInstrumentation was constructed'); } init() {} + + onError = (event: ErrorEvent | PromiseRejectionEvent) => { + const error: Error | undefined = + 'reason' in event ? event.reason : event.error; + if (error) { + const message = error.message; + const type = error.name; + const errorAttributes = { + [ATTR_EXCEPTION_TYPE]: type, + [ATTR_EXCEPTION_MESSAGE]: message, + [ATTR_EXCEPTION_STACKTRACE]: error.stack, + }; + + const eventLogger = events.getEventLogger( + this.instrumentationName, + this.instrumentationVersion + ); + + eventLogger.emit({ + name: 'exception', + data: errorAttributes, + // TODO: add attributes from apply custom attributes function + severityNumber: SeverityNumber.ERROR, + // TODO: figure out timestamp + }); + } + }; + + override disable(): void { + window.removeEventListener('error', this.onError); + window.removeEventListener('unhandledrejection', this.onError); + } + + override enable(): void { + window.addEventListener('error', this.onError); + window.addEventListener('unhandledrejection', this.onError); + } } From 4d42a45ce6325ce57072c97afc3baac381f61302 Mon Sep 17 00:00:00 2001 From: Purvi Kanal Date: Mon, 10 Mar 2025 10:37:31 -0400 Subject: [PATCH 03/13] add test --- package-lock.json | 32 +++++++++++ .../package.json | 2 + .../test/instrumentation.test.ts | 56 ++++++++++++++++++- 3 files changed, 89 insertions(+), 1 deletion(-) diff --git a/package-lock.json b/package-lock.json index c0bb96f9bb..37d8ca456e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10351,6 +10351,23 @@ "node": ">=14" } }, + "node_modules/@opentelemetry/sdk-events": { + "version": "0.57.2", + "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-events/-/sdk-events-0.57.2.tgz", + "integrity": "sha512-fSgRfZzf3H8adjt8Xk8C145gDD/Hw5KtLaXVzDO8nLQaYiC3mvLIUtrPjbEqzHHPDUSBsVqiDszQ27Iaa+QZKg==", + "dev": true, + "dependencies": { + "@opentelemetry/api-events": "0.57.2", + "@opentelemetry/api-logs": "0.57.2", + "@opentelemetry/sdk-logs": "0.57.2" + }, + "engines": { + "node": ">=14" + }, + "peerDependencies": { + "@opentelemetry/api": ">=1.4.0 <1.10.0" + } + }, "node_modules/@opentelemetry/sdk-logs": { "version": "0.57.2", "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-logs/-/sdk-logs-0.57.2.tgz", @@ -38750,6 +38767,8 @@ "@babel/core": "7.22.17", "@jsdevtools/coverage-istanbul-loader": "3.0.5", "@opentelemetry/api": "^1.3.0", + "@opentelemetry/sdk-events": "^0.57.2", + "@opentelemetry/sdk-logs": "^0.57.2", "@opentelemetry/sdk-trace-base": "^1.0.0", "@rollup/plugin-commonjs": "^26.0.0", "@rollup/plugin-node-resolve": "^15.2.3", @@ -48733,6 +48752,8 @@ "@opentelemetry/api-events": "^0.57.2", "@opentelemetry/core": "^1.8.0", "@opentelemetry/instrumentation": "^0.57.2", + "@opentelemetry/sdk-events": "^0.57.2", + "@opentelemetry/sdk-logs": "^0.57.2", "@opentelemetry/sdk-trace-base": "^1.0.0", "@opentelemetry/sdk-trace-web": "^1.15.0", "@opentelemetry/semantic-conventions": "^1.27.0", @@ -49544,6 +49565,17 @@ } } }, + "@opentelemetry/sdk-events": { + "version": "0.57.2", + "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-events/-/sdk-events-0.57.2.tgz", + "integrity": "sha512-fSgRfZzf3H8adjt8Xk8C145gDD/Hw5KtLaXVzDO8nLQaYiC3mvLIUtrPjbEqzHHPDUSBsVqiDszQ27Iaa+QZKg==", + "dev": true, + "requires": { + "@opentelemetry/api-events": "0.57.2", + "@opentelemetry/api-logs": "0.57.2", + "@opentelemetry/sdk-logs": "0.57.2" + } + }, "@opentelemetry/sdk-logs": { "version": "0.57.2", "resolved": "https://registry.npmjs.org/@opentelemetry/sdk-logs/-/sdk-logs-0.57.2.tgz", diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/package.json b/plugins/web/opentelemetry-instrumentation-web-exception/package.json index 4049fb1ed9..ead4b44c94 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/package.json +++ b/plugins/web/opentelemetry-instrumentation-web-exception/package.json @@ -53,6 +53,8 @@ "@babel/core": "7.22.17", "@jsdevtools/coverage-istanbul-loader": "3.0.5", "@opentelemetry/api": "^1.3.0", + "@opentelemetry/sdk-events": "^0.57.2", + "@opentelemetry/sdk-logs": "^0.57.2", "@opentelemetry/sdk-trace-base": "^1.0.0", "@rollup/plugin-commonjs": "^26.0.0", "@rollup/plugin-node-resolve": "^15.2.3", diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts b/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts index 4d706a5f9d..c4655afe26 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts +++ b/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts @@ -17,10 +17,25 @@ import { WebExceptionInstrumentation } from '../src/instrumentation'; // @ts-expect-error: not an export, but we want the prebundled version import chai from 'chai/chai.js'; - +import { EventLoggerProvider } from '@opentelemetry/sdk-events'; +import { + LoggerProvider, + SimpleLogRecordProcessor, + InMemoryLogRecordExporter, +} from '@opentelemetry/sdk-logs'; +import { events } from '@opentelemetry/api-events'; +import { registerInstrumentations } from '@opentelemetry/instrumentation'; const assert = chai.assert; describe('WebExceptionInstrumentation', () => { + const loggerProvider = new LoggerProvider(); + const exporter = new InMemoryLogRecordExporter(); + const logRecordProcessor = new SimpleLogRecordProcessor(exporter); + loggerProvider.addLogRecordProcessor(logRecordProcessor); + + const eventLoggerProvider = new EventLoggerProvider(loggerProvider); + events.setGlobalEventLoggerProvider(eventLoggerProvider); + describe('constructor', () => { it('should construct an instance', () => { const instrumentation = new WebExceptionInstrumentation({ @@ -29,4 +44,43 @@ describe('WebExceptionInstrumentation', () => { assert.ok(instrumentation instanceof WebExceptionInstrumentation); }); }); + + describe('throwing an error', () => { + beforeEach(() => { + const instr = new WebExceptionInstrumentation(); + registerInstrumentations({ + instrumentations: [instr], + }); + instr.enable(); + }); + + it('should create an event when an error is thrown', async () => { + const err = new Error('Something happened!'); + err.stack = + '' + + ' Error: Something happened\n' + + ' at baz (filename.js:10:15)\n' + + ' at bar (filename.js:6:3)\n' + + ' at foo (filename.js:2:3)\n' + + ' at (filename.js:13:1)'; + setTimeout(() => { + try { + throw err; + } catch (error) { + assert.ok(error instanceof Error); + // Do nothing + } + }); + + // Wait for error to be processed and log to be created + setTimeout(() => { + try { + const events = exporter.getFinishedLogRecords(); + assert.ok(events.length > 0, 'Expected at least one log record'); + const event = events[0]; + assert.ok(event.attributes['event.name'] === 'exception'); + } catch (e) {} + }, 0); + }); + }); }); From b5d3316ef7ef7ea94e497d658b181506d6e4f0fe Mon Sep 17 00:00:00 2001 From: Purvi Kanal Date: Mon, 10 Mar 2025 14:09:07 -0400 Subject: [PATCH 04/13] fix tests --- .../test/instrumentation.test.ts | 83 +++++++++++++++---- 1 file changed, 67 insertions(+), 16 deletions(-) diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts b/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts index c4655afe26..b2f9a5b89b 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts +++ b/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts @@ -25,6 +25,11 @@ import { } from '@opentelemetry/sdk-logs'; import { events } from '@opentelemetry/api-events'; import { registerInstrumentations } from '@opentelemetry/instrumentation'; +import { + ATTR_EXCEPTION_MESSAGE, + ATTR_EXCEPTION_STACKTRACE, + ATTR_EXCEPTION_TYPE, +} from '@opentelemetry/semantic-conventions'; const assert = chai.assert; describe('WebExceptionInstrumentation', () => { @@ -36,6 +41,21 @@ describe('WebExceptionInstrumentation', () => { const eventLoggerProvider = new EventLoggerProvider(loggerProvider); events.setGlobalEventLoggerProvider(eventLoggerProvider); + // Helper function to throw an error of a specific type so that we can allow the error to propagate and test the instrumentation. + const throwErr = (message: string, stack?: string): void => { + class ValidationError extends Error { + constructor(message: string) { + super(message); + this.name = 'ValidationError'; + } + } + const err = new ValidationError(message); + if (stack) { + err.stack = stack; + } + throw err; + }; + describe('constructor', () => { it('should construct an instance', () => { const instrumentation = new WebExceptionInstrumentation({ @@ -46,17 +66,53 @@ describe('WebExceptionInstrumentation', () => { }); describe('throwing an error', () => { + let mochaErrorHandler: OnErrorEventHandler; + const instr = new WebExceptionInstrumentation(); beforeEach(() => { - const instr = new WebExceptionInstrumentation(); + mochaErrorHandler = window.onerror; + // We need to handle the error ourselves to prevent Mocha from failing the test. + window.onerror = ( + event: Event | string, + source?: string, + lineno?: number, + colno?: number, + error?: Error + ) => { + if (error?.name !== 'ValidationError') { + // If we are testing our instrumentation, we want to let the error propagate. + // If it is any other kind of error, we want Mocha to handle the error as expected. + mochaErrorHandler?.call(window, event, source, lineno, colno, error); + } + }; registerInstrumentations({ instrumentations: [instr], }); + instr.enable(); }); + afterEach(() => { + // Resume Mocha handling of uncaughtExceptions. + window.onerror = mochaErrorHandler; + instr.disable(); + exporter.reset(); + }); + it('should create an event when an error is thrown', async () => { - const err = new Error('Something happened!'); - err.stack = + setTimeout(() => { + throwErr('Something happened!'); + }); + + setTimeout(() => { + const events = exporter.getFinishedLogRecords(); + assert.ok(events.length > 0, 'Expected at least one log record'); + const event = events[0]; + assert.strictEqual(event.attributes['event.name'], 'exception'); + }, 0); + }); + + it('should apply semantic attributes for exceptions to the event', async () => { + const stack = '' + ' Error: Something happened\n' + ' at baz (filename.js:10:15)\n' + @@ -64,22 +120,17 @@ describe('WebExceptionInstrumentation', () => { ' at foo (filename.js:2:3)\n' + ' at (filename.js:13:1)'; setTimeout(() => { - try { - throw err; - } catch (error) { - assert.ok(error instanceof Error); - // Do nothing - } + throwErr('Something happened!', stack); }); - // Wait for error to be processed and log to be created setTimeout(() => { - try { - const events = exporter.getFinishedLogRecords(); - assert.ok(events.length > 0, 'Expected at least one log record'); - const event = events[0]; - assert.ok(event.attributes['event.name'] === 'exception'); - } catch (e) {} + const events = exporter.getFinishedLogRecords(); + assert.ok(events.length > 0, 'Expected at least one log record'); + const event = events[0]; + const body = event.body as Record; + assert.strictEqual(body[ATTR_EXCEPTION_MESSAGE], 'Something happened!'); + assert.strictEqual(body[ATTR_EXCEPTION_TYPE], 'ValidationError'); + assert.strictEqual(body[ATTR_EXCEPTION_STACKTRACE], stack); }, 0); }); }); From c897dd7bdaedf9f77c59714a4dc2506131b672f5 Mon Sep 17 00:00:00 2001 From: Purvi Kanal Date: Mon, 10 Mar 2025 14:25:41 -0400 Subject: [PATCH 05/13] apply custom attributes function --- .../src/instrumentation.ts | 16 ++-- .../test/instrumentation.test.ts | 80 ++++++++++++++----- 2 files changed, 73 insertions(+), 23 deletions(-) diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts index e4c72084f6..b617bc28ca 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts +++ b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts @@ -39,9 +39,12 @@ export interface GlobalErrorsInstrumentationConfig applyCustomAttributes?: (error: Error) => Attributes; } -export class WebExceptionInstrumentation extends InstrumentationBase { - constructor(config: InstrumentationConfig = {}) { +export class WebExceptionInstrumentation extends InstrumentationBase { + readonly applyCustomAttributes?: (error: Error) => Attributes; + constructor(config: GlobalErrorsInstrumentationConfig = {}) { super('@opentelemetry/instrumentation-web-exception', '0.0.1', config); + + this.applyCustomAttributes = config.applyCustomAttributes; } init() {} @@ -63,12 +66,15 @@ export class WebExceptionInstrumentation extends InstrumentationBase { throw err; }; + let mochaErrorHandler: OnErrorEventHandler; + + beforeEach(() => { + mochaErrorHandler = window.onerror; + // We need to handle the error ourselves to prevent Mocha from failing the test. + window.onerror = ( + event: Event | string, + source?: string, + lineno?: number, + colno?: number, + error?: Error + ) => { + if (error?.name !== 'ValidationError') { + // If we are testing our instrumentation, we want to let the error propagate. + // If it is any other kind of error, we want Mocha to handle the error as expected. + mochaErrorHandler?.call(window, event, source, lineno, colno, error); + } + }; + }); + + afterEach(() => { + // Resume Mocha handling of uncaughtExceptions. + window.onerror = mochaErrorHandler; + }); + describe('constructor', () => { it('should construct an instance', () => { const instrumentation = new WebExceptionInstrumentation({ @@ -66,24 +91,8 @@ describe('WebExceptionInstrumentation', () => { }); describe('throwing an error', () => { - let mochaErrorHandler: OnErrorEventHandler; const instr = new WebExceptionInstrumentation(); beforeEach(() => { - mochaErrorHandler = window.onerror; - // We need to handle the error ourselves to prevent Mocha from failing the test. - window.onerror = ( - event: Event | string, - source?: string, - lineno?: number, - colno?: number, - error?: Error - ) => { - if (error?.name !== 'ValidationError') { - // If we are testing our instrumentation, we want to let the error propagate. - // If it is any other kind of error, we want Mocha to handle the error as expected. - mochaErrorHandler?.call(window, event, source, lineno, colno, error); - } - }; registerInstrumentations({ instrumentations: [instr], }); @@ -92,8 +101,6 @@ describe('WebExceptionInstrumentation', () => { }); afterEach(() => { - // Resume Mocha handling of uncaughtExceptions. - window.onerror = mochaErrorHandler; instr.disable(); exporter.reset(); }); @@ -134,4 +141,41 @@ describe('WebExceptionInstrumentation', () => { }, 0); }); }); + + describe('adding custom attributes', () => { + const applyCustomAttrs = (error: Error) => { + return { + 'app.custom.exception': error.message.toLocaleUpperCase(), + }; + }; + const instr = new WebExceptionInstrumentation({ + applyCustomAttributes: applyCustomAttrs, + }); + beforeEach(() => { + registerInstrumentations({ + instrumentations: [instr], + }); + + instr.enable(); + }); + + afterEach(() => { + instr.disable(); + exporter.reset(); + }); + it('should add custom attributes to the event', async () => { + setTimeout(() => { + throwErr('Something happened!'); + }); + + setTimeout(() => { + const events = exporter.getFinishedLogRecords(); + assert.ok(events.length > 0, 'Expected at least one log record'); + const event = events[0]; + const body = event.body as Record; + console.log(event); + assert.strictEqual(body['app.custom.exception'], 'SOMETHING HAPPENED!'); + }, 0); + }); + }); }); From a1816430b5f212e20d07d2273c9bc63386ceae18 Mon Sep 17 00:00:00 2001 From: Purvi Kanal Date: Mon, 10 Mar 2025 14:30:06 -0400 Subject: [PATCH 06/13] remove console.log --- .../test/instrumentation.test.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts b/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts index b4ff4513b2..2f371b8a99 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts +++ b/plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts @@ -173,7 +173,6 @@ describe('WebExceptionInstrumentation', () => { assert.ok(events.length > 0, 'Expected at least one log record'); const event = events[0]; const body = event.body as Record; - console.log(event); assert.strictEqual(body['app.custom.exception'], 'SOMETHING HAPPENED!'); }, 0); }); From 1ccf72d6cd7e6ffa13f9c4d108e22734341a3f5f Mon Sep 17 00:00:00 2001 From: Purvi Kanal Date: Mon, 10 Mar 2025 15:25:15 -0400 Subject: [PATCH 07/13] add readme --- .../README.md | 98 +++++++++++++++++++ 1 file changed, 98 insertions(+) create mode 100644 plugins/web/opentelemetry-instrumentation-web-exception/README.md diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/README.md b/plugins/web/opentelemetry-instrumentation-web-exception/README.md new file mode 100644 index 0000000000..5024608a3d --- /dev/null +++ b/plugins/web/opentelemetry-instrumentation-web-exception/README.md @@ -0,0 +1,98 @@ +# OpenTelemetry Web Exception Instrumentation + +[![NPM Published Version][npm-img]][npm-url] +[![Apache License][license-image]][license-image-url] + +This module provides automatic instrumentation for capturing unhandled exceptions and promise rejections in web applications. + +## Installation + +```bash +npm install --save @opentelemetry/instrumentation-web-exception +``` + +## Usage + +```typescript +import { LoggerProvider } from '@opentelemetry/sdk-logs'; +import { EventLoggerProvider, events } from '@opentelemetry/api-events'; +import { WebExceptionInstrumentation } from '@opentelemetry/instrumentation-web-exception'; +import { registerInstrumentations } from '@opentelemetry/instrumentation'; + +// Set up the logger provider and event logger +const loggerProvider = new LoggerProvider(); +const eventLoggerProvider = new EventLoggerProvider(loggerProvider); +events.setGlobalEventLoggerProvider(eventLoggerProvider); + +// Register the instrumentation +registerInstrumentations({ + instrumentations: [ + new WebExceptionInstrumentation({ + // Optional: customize attributes added to error events + applyCustomAttributes: (error) => ({ + 'app.error.severity': error.name === 'ValidationError' ? 'warning' : 'error', + 'custom.correlation.id': window.correlationId, + }), + }), + ], +}); +``` + +## Configuration + +The instrumentation can be configured with the following options: + +| Option | Type | Description | +| ------- | ---- | ----------- | +| `enabled` | `boolean` | Whether to enable the instrumentation. Default: `true` | +| `applyCustomAttributes` | `(error: Error) => Attributes` | Optional callback to add custom attributes to error events | + +## Features + +- Automatically captures unhandled exceptions +- Captures unhandled promise rejections +- Records error name, message, and stack trace using OpenTelemetry semantic conventions +- Supports custom attributes through configuration +- Integrates with OpenTelemetry Events API + +## Semantic Attributes + +The following semantic attributes are added to each error event: + +| Attribute | Type | Description | +| --------- | ---- | ----------- | +| `exception.type` | string | The error name or type | +| `exception.message` | string | The error message | +| `exception.stacktrace` | string | The error stack trace | + +## Example + +```typescript +// Initialize the instrumentation +const exceptionInstrumentation = new WebExceptionInstrumentation({ + applyCustomAttributes: (error) => ({ + 'error.category': error instanceof TypeError ? 'type_error' : 'runtime_error', + 'app.version': '1.0.0', + }), +}); + +// The instrumentation will automatically capture unhandled errors +throw new Error('Unhandled error'); + +// And unhandled promise rejections +Promise.reject(new Error('Unhandled rejection')); +``` + +## Contributing + +This instrumentation is maintained by the OpenTelemetry authors. We welcome contributions! + +## License + +Apache 2.0 - See [LICENSE][license-url] for more information. + +[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-web-exception +[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-web-exception.svg +[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 +[license-image-url]: https://img.shields.io/badge/license-Apache_2.0-green.svg From b192e218acf406248acf0ffbeaf09ed26b9c9911 Mon Sep 17 00:00:00 2001 From: Purvi Kanal Date: Mon, 10 Mar 2025 15:28:43 -0400 Subject: [PATCH 08/13] update dependencies --- package-lock.json | 6 ++---- .../package.json | 3 +-- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/package-lock.json b/package-lock.json index 37d8ca456e..ab54ec8712 100644 --- a/package-lock.json +++ b/package-lock.json @@ -38758,15 +38758,14 @@ "license": "Apache-2.0", "dependencies": { "@opentelemetry/api-events": "^0.57.2", - "@opentelemetry/core": "^1.8.0", "@opentelemetry/instrumentation": "^0.57.2", - "@opentelemetry/sdk-trace-web": "^1.15.0", "@opentelemetry/semantic-conventions": "^1.27.0" }, "devDependencies": { "@babel/core": "7.22.17", "@jsdevtools/coverage-istanbul-loader": "3.0.5", "@opentelemetry/api": "^1.3.0", + "@opentelemetry/api-logs": "^0.57.2", "@opentelemetry/sdk-events": "^0.57.2", "@opentelemetry/sdk-logs": "^0.57.2", "@opentelemetry/sdk-trace-base": "^1.0.0", @@ -48750,12 +48749,11 @@ "@jsdevtools/coverage-istanbul-loader": "3.0.5", "@opentelemetry/api": "^1.3.0", "@opentelemetry/api-events": "^0.57.2", - "@opentelemetry/core": "^1.8.0", + "@opentelemetry/api-logs": "^0.57.2", "@opentelemetry/instrumentation": "^0.57.2", "@opentelemetry/sdk-events": "^0.57.2", "@opentelemetry/sdk-logs": "^0.57.2", "@opentelemetry/sdk-trace-base": "^1.0.0", - "@opentelemetry/sdk-trace-web": "^1.15.0", "@opentelemetry/semantic-conventions": "^1.27.0", "@rollup/plugin-commonjs": "^26.0.0", "@rollup/plugin-node-resolve": "^15.2.3", diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/package.json b/plugins/web/opentelemetry-instrumentation-web-exception/package.json index ead4b44c94..f83f9fe281 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/package.json +++ b/plugins/web/opentelemetry-instrumentation-web-exception/package.json @@ -53,6 +53,7 @@ "@babel/core": "7.22.17", "@jsdevtools/coverage-istanbul-loader": "3.0.5", "@opentelemetry/api": "^1.3.0", + "@opentelemetry/api-logs": "^0.57.2", "@opentelemetry/sdk-events": "^0.57.2", "@opentelemetry/sdk-logs": "^0.57.2", "@opentelemetry/sdk-trace-base": "^1.0.0", @@ -71,9 +72,7 @@ }, "dependencies": { "@opentelemetry/api-events": "^0.57.2", - "@opentelemetry/core": "^1.8.0", "@opentelemetry/instrumentation": "^0.57.2", - "@opentelemetry/sdk-trace-web": "^1.15.0", "@opentelemetry/semantic-conventions": "^1.27.0" }, "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/web/opentelemetry-instrumentation-document-load#readme" From d1882bba9575faa350c9e2f5e3815dd63552eb63 Mon Sep 17 00:00:00 2001 From: Purvi Kanal Date: Mon, 10 Mar 2025 15:30:26 -0400 Subject: [PATCH 09/13] add to release please --- .release-please-manifest.json | 3 ++- release-please-config.json | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 0661c534fe..6dfdaf2d6d 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -58,9 +58,10 @@ "plugins/web/opentelemetry-instrumentation-document-load": "0.44.1", "plugins/web/opentelemetry-instrumentation-long-task": "0.44.1", "plugins/web/opentelemetry-instrumentation-user-interaction": "0.44.1", + "plugins/web/opentelemetry-instrumentation-web-exception": "0.0.1", "plugins/web/opentelemetry-plugin-react-load": "0.31.1", "propagators/opentelemetry-propagator-instana": "0.3.3", "propagators/opentelemetry-propagator-ot-trace": "0.27.3", "propagators/propagator-aws-xray": "1.26.2", "propagators/propagator-aws-xray-lambda": "0.53.2" -} +} \ No newline at end of file diff --git a/release-please-config.json b/release-please-config.json index b0993722d4..045f1684fd 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -65,10 +65,11 @@ "plugins/web/opentelemetry-instrumentation-document-load": {}, "plugins/web/opentelemetry-instrumentation-long-task": {}, "plugins/web/opentelemetry-instrumentation-user-interaction": {}, + "plugins/web/opentelemetry-instrumentation-web-exception": {}, "plugins/web/opentelemetry-plugin-react-load": {}, "propagators/opentelemetry-propagator-instana": {}, "propagators/opentelemetry-propagator-ot-trace": {}, "propagators/propagator-aws-xray": {}, "propagators/propagator-aws-xray-lambda": {} } -} +} \ No newline at end of file From c9f84b3a34cf4f8a8be77aadb4c740e62d966678 Mon Sep 17 00:00:00 2001 From: Purvi Kanal Date: Mon, 10 Mar 2025 15:38:43 -0400 Subject: [PATCH 10/13] fix lint for readme --- .../README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/README.md b/plugins/web/opentelemetry-instrumentation-web-exception/README.md index 5024608a3d..1e0faf2aab 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/README.md +++ b/plugins/web/opentelemetry-instrumentation-web-exception/README.md @@ -1,7 +1,7 @@ # OpenTelemetry Web Exception Instrumentation [![NPM Published Version][npm-img]][npm-url] -[![Apache License][license-image]][license-image-url] +[![Apache License][license-image]][license-image] This module provides automatic instrumentation for capturing unhandled exceptions and promise rejections in web applications. @@ -83,16 +83,18 @@ throw new Error('Unhandled error'); Promise.reject(new Error('Unhandled rejection')); ``` -## Contributing +## Useful links -This instrumentation is maintained by the OpenTelemetry authors. We welcome contributions! +- 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 [npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-web-exception [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-web-exception.svg -[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 -[license-image-url]: https://img.shields.io/badge/license-Apache_2.0-green.svg From 52417625c06232c40fc30db4fef2f260c8e98cd9 Mon Sep 17 00:00:00 2001 From: Purvi Kanal Date: Wed, 12 Mar 2025 13:14:01 -0400 Subject: [PATCH 11/13] use htTime instead --- .../src/instrumentation.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts index b617bc28ca..989750a4e2 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts +++ b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts @@ -27,6 +27,7 @@ import { import { events } from '@opentelemetry/api-events'; import { SeverityNumber } from '@opentelemetry/api-logs'; import { Attributes } from '@opentelemetry/api'; +import { hrTime } from '@opentelemetry/core'; export interface GlobalErrorsInstrumentationConfig extends InstrumentationConfig { @@ -74,7 +75,7 @@ export class WebExceptionInstrumentation extends InstrumentationBase Date: Wed, 12 Mar 2025 13:15:52 -0400 Subject: [PATCH 12/13] match semconv for name --- .../src/instrumentation.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts index 989750a4e2..655280f924 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts +++ b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts @@ -72,7 +72,7 @@ export class WebExceptionInstrumentation extends InstrumentationBase Date: Wed, 12 Mar 2025 13:27:12 -0400 Subject: [PATCH 13/13] use attributes for user provided attrs --- .../src/instrumentation.ts | 3 ++- .../test/instrumentation.test.ts | 6 ++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts index 655280f924..d352583e39 100644 --- a/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts +++ b/plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts @@ -73,7 +73,8 @@ export class WebExceptionInstrumentation extends InstrumentationBase { const events = exporter.getFinishedLogRecords(); assert.ok(events.length > 0, 'Expected at least one log record'); const event = events[0]; - const body = event.body as Record; - assert.strictEqual(body['app.custom.exception'], 'SOMETHING HAPPENED!'); + assert.strictEqual( + event.attributes['app.custom.exception'], + 'SOMETHING HAPPENED!' + ); }, 0); }); });