feat(web-exception-instrumentation): Add instrumentation for web exceptions

.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"
-}
+}

plugins/web/opentelemetry-instrumentation-web-exception/.eslintignore

@@ -0,0 +1 @@
+build

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'),
+};

plugins/web/opentelemetry-instrumentation-web-exception/CHANGELOG.md

@@ -0,0 +1,2 @@
+# Changelog
+

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.

plugins/web/opentelemetry-instrumentation-web-exception/README.md

@@ -0,0 +1,100 @@
+# OpenTelemetry Web Exception Instrumentation
+
+[![NPM Published Version][npm-img]][npm-url]
+[![Apache License][license-image]][license-image]
+
+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'));
+```
+
+## Useful links
+
+- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
+- 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

plugins/web/opentelemetry-instrumentation-web-exception/package.json

@@ -0,0 +1,79 @@
+{
+  "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/api-logs": "^0.57.2",
+    "@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",
+    "@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/api-events": "^0.57.2",
+    "@opentelemetry/instrumentation": "^0.57.2",
+    "@opentelemetry/semantic-conventions": "^1.27.0"
+  },
+  "homepage": "https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/web/opentelemetry-instrumentation-document-load#readme"
+}

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';

plugins/web/opentelemetry-instrumentation-web-exception/src/instrumentation.ts

@@ -0,0 +1,93 @@
+/*
+ * 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';
+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';
+import { hrTime } from '@opentelemetry/core';
+
+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<GlobalErrorsInstrumentationConfig> {
+  readonly applyCustomAttributes?: (error: Error) => Attributes;
+  constructor(config: GlobalErrorsInstrumentationConfig = {}) {
+    super('@opentelemetry/instrumentation-web-exception', '0.0.1', config);
+
+    this.applyCustomAttributes = config.applyCustomAttributes;
+  }
+
+  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
+      );
+
+      const customAttributes = this.applyCustomAttributes
+        ? this.applyCustomAttributes(error)
+        : {};
+
+      eventLogger.emit({
+        name: 'browser.exception',
+        data: errorAttributes,
+        attributes: customAttributes,
+        severityNumber: SeverityNumber.ERROR,
+        timestamp: hrTime(),
+      });
+    }
+  };
+
+  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);
+  }
+}

plugins/web/opentelemetry-instrumentation-web-exception/test/instrumentation.test.ts

@@ -0,0 +1,182 @@
+/*
+ * 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';
+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';
+import {
+  ATTR_EXCEPTION_MESSAGE,
+  ATTR_EXCEPTION_STACKTRACE,
+  ATTR_EXCEPTION_TYPE,
+} from '@opentelemetry/semantic-conventions';
+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);
+
+  // 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;
+  };
+
+  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({
+        enabled: false,
+      });
+      assert.ok(instrumentation instanceof WebExceptionInstrumentation);
+    });
+  });
+
+  describe('throwing an error', () => {
+    const instr = new WebExceptionInstrumentation();
+    beforeEach(() => {
+      registerInstrumentations({
+        instrumentations: [instr],
+      });
+
+      instr.enable();
+    });
+
+    afterEach(() => {
+      instr.disable();
+      exporter.reset();
+    });
+
+    it('should create an event when an error is thrown', 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];
+        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' +
+        '    at bar (filename.js:6:3)\n' +
+        '    at foo (filename.js:2:3)\n' +
+        '    at (filename.js:13:1)';
+      setTimeout(() => {
+        throwErr('Something happened!', stack);
+      });
+
+      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<string, any>;
+        assert.strictEqual(body[ATTR_EXCEPTION_MESSAGE], 'Something happened!');
+        assert.strictEqual(body[ATTR_EXCEPTION_TYPE], 'ValidationError');
+        assert.strictEqual(body[ATTR_EXCEPTION_STACKTRACE], stack);
+      }, 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];
+        assert.strictEqual(
+          event.attributes['app.custom.exception'],
+          'SOMETHING HAPPENED!'
+        );
+      }, 0);
+    });
+  });
+});

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"
+  ]
+}

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"
+  ]
+}

plugins/web/opentelemetry-instrumentation-web-exception/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../../tsconfig.base",
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "build"
+  },
+  "include": [
+    "src/**/*.ts",
+    "test/**/*.ts"
+  ]
+}

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(),
+  ],
+};

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": {}
   }
-}
+}