diff --git a/.github/component_owners.yml b/.github/component_owners.yml
index f679210752..f5253bfb17 100644
--- a/.github/component_owners.yml
+++ b/.github/component_owners.yml
@@ -44,6 +44,8 @@ components:
- obecny
plugins/web/opentelemetry-instrumentation-user-interaction:
- obecny
+ plugins/web/opentelemetry-instrumentation-web-vitals:
+ - mhennoch
propagators/opentelemetry-propagator-aws-xray:
- NathanielRN
- willarmiros
diff --git a/plugins/web/opentelemetry-instrumentation-web-vitals/.eslintignore b/plugins/web/opentelemetry-instrumentation-web-vitals/.eslintignore
new file mode 100644
index 0000000000..378eac25d3
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/.eslintignore
@@ -0,0 +1 @@
+build
diff --git a/plugins/web/opentelemetry-instrumentation-web-vitals/.eslintrc.js b/plugins/web/opentelemetry-instrumentation-web-vitals/.eslintrc.js
new file mode 100644
index 0000000000..6ad6c9f216
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/.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-vitals/LICENSE b/plugins/web/opentelemetry-instrumentation-web-vitals/LICENSE
new file mode 100644
index 0000000000..261eeb9e9f
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/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-vitals/README.md b/plugins/web/opentelemetry-instrumentation-web-vitals/README.md
new file mode 100644
index 0000000000..81637b530a
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/README.md
@@ -0,0 +1,56 @@
+# OpenTelemetry Instrumentation Web Vitals
+
+[![NPM Published Version][npm-img]][npm-url]
+[![dependencies][dependencies-image]][dependencies-url]
+[![devDependencies][devDependencies-image]][devDependencies-url]
+[![Apache License][license-image]][license-image]
+
+This module provides captures core [web-vitals](https://web.dev/vitals/) for Web applications.
+Uses https://github.com/GoogleChrome/web-vitals to do the capturing and reports LCP, CLS and FID as "fake" spans that have 0 duration.
+The real values are reported as attributes on those spans.
+
+## Installation
+
+```bash
+npm install --save @opentelemetry/instrumentation-web-vitals
+```
+
+## Usage
+
+```js
+import { ConsoleSpanExporter, SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base';
+import { WebTracerProvider } from '@opentelemetry/sdk-trace-web';
+import { WebVitalsInstrumentation } from '@opentelemetry/instrumentation-web-vitals';
+import { registerInstrumentations } from '@opentelemetry/instrumentation';
+
+const provider = new WebTracerProvider();
+
+provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
+
+registerInstrumentations({
+ tracerProvider: provider,
+ instrumentations: [new WebVitalsInstrumentation({enabled: false})],
+});
+
+```
+
+
+## Useful links
+
+- For more information on OpenTelemetry, visit:
+- For more about OpenTelemetry JavaScript:
+- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]
+
+## License
+
+Apache 2.0 - See [LICENSE][license-url] for more information.
+
+[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
+[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE
+[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
+[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fweb%2Fopentelemetry-instrumentation-web-vitals
+[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fweb%2Fopentelemetry-instrumentation-web-vitals
+[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=plugins%2Fweb%2Fopentelemetry-instrumentation-web-vitals&type=dev
+[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=plugins%2Fweb%2Fopentelemetry-instrumentation-web-vitals&type=dev
+[npm-url]: https://www.npmjs.com/package/@opentelemetry/instrumentation-web-vitals
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Finstrumentation-web-vitals.svg
diff --git a/plugins/web/opentelemetry-instrumentation-web-vitals/karma.conf.js b/plugins/web/opentelemetry-instrumentation-web-vitals/karma.conf.js
new file mode 100644
index 0000000000..6174839d65
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/karma.conf.js
@@ -0,0 +1,24 @@
+/*!
+ * 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.
+ */
+
+const karmaWebpackConfig = require('../../../karma.webpack');
+const karmaBaseConfig = require('../../../karma.base');
+
+module.exports = (config) => {
+ config.set(Object.assign({}, karmaBaseConfig, {
+ webpack: karmaWebpackConfig
+ }))
+};
diff --git a/plugins/web/opentelemetry-instrumentation-web-vitals/package.json b/plugins/web/opentelemetry-instrumentation-web-vitals/package.json
new file mode 100644
index 0000000000..ed361f8f12
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/package.json
@@ -0,0 +1,87 @@
+{
+ "name": "@opentelemetry/instrumentation-web-vitals",
+ "version": "0.25.0",
+ "description": "OpenTelemetry web-vitals automatic instrumentation package.",
+ "main": "build/src/index.js",
+ "module": "build/esm/index.js",
+ "types": "build/src/index.d.ts",
+ "repository": "open-telemetry/opentelemetry-js-contrib",
+ "scripts": {
+ "clean": "tsc --build --clean tsconfig.json tsconfig.esm.json",
+ "lint": "eslint . --ext .ts",
+ "lint:fix": "eslint . --ext .ts --fix",
+ "codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
+ "precompile": "tsc --version",
+ "version:update": "node ../../../scripts/version-update.js",
+ "compile": "npm run version:update && tsc --build tsconfig.json tsconfig.esm.json",
+ "prepare": "npm run compile",
+ "tdd": "karma start",
+ "test:browser": "nyc karma start --single-run",
+ "watch": "tsc --build -watch tsconfig.json tsconfig.esm.json"
+ },
+ "keywords": [
+ "opentelemetry",
+ "web-vitals",
+ "web",
+ "tracing",
+ "profiling",
+ "plugin"
+ ],
+ "author": "OpenTelemetry Authors",
+ "license": "Apache-2.0",
+ "engines": {
+ "node": ">=8.0.0"
+ },
+ "files": [
+ "build/esm/**/*.js",
+ "build/esm/**/*.map",
+ "build/esm/**/*.d.ts",
+ "build/src/**/*.js",
+ "build/src/**/*.map",
+ "build/src/**/*.d.ts",
+ "doc",
+ "LICENSE",
+ "README.md"
+ ],
+ "publishConfig": {
+ "access": "public"
+ },
+ "peerDependencies": {
+ "@opentelemetry/api": "^1.0.2"
+ },
+ "devDependencies": {
+ "@babel/core": "7.15.0",
+ "@opentelemetry/api": "1.0.2",
+ "@opentelemetry/sdk-trace-base": "^0.25.0",
+ "@opentelemetry/sdk-trace-web": "^0.25.0",
+ "@types/mocha": "8.2.3",
+ "@types/node": "14.17.9",
+ "@types/sinon": "10.0.2",
+ "@types/webpack-env": "1.16.2",
+ "babel-loader": "8.2.2",
+ "codecov": "3.8.3",
+ "gts": "3.1.0",
+ "istanbul-instrumenter-loader": "3.0.1",
+ "karma": "5.2.3",
+ "karma-chrome-launcher": "3.1.0",
+ "karma-coverage-istanbul-reporter": "3.0.3",
+ "karma-mocha": "2.0.1",
+ "karma-spec-reporter": "0.0.32",
+ "karma-webpack": "4.0.2",
+ "mocha": "7.2.0",
+ "nyc": "15.1.0",
+ "rimraf": "3.0.2",
+ "sinon": "11.1.2",
+ "ts-loader": "8.3.0",
+ "ts-mocha": "8.0.0",
+ "typescript": "4.3.5",
+ "webpack": "4.46.0",
+ "webpack-cli": "4.7.2",
+ "webpack-merge": "5.8.0"
+ },
+ "dependencies": {
+ "@opentelemetry/core": "^0.25.0",
+ "@opentelemetry/instrumentation": "^0.25.0",
+ "web-vitals": "^2.1.1"
+ }
+}
diff --git a/plugins/web/opentelemetry-instrumentation-web-vitals/src/index.ts b/plugins/web/opentelemetry-instrumentation-web-vitals/src/index.ts
new file mode 100644
index 0000000000..24c76056a1
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/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-vitals/src/instrumentation.ts b/plugins/web/opentelemetry-instrumentation-web-vitals/src/instrumentation.ts
new file mode 100644
index 0000000000..139033efaf
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/src/instrumentation.ts
@@ -0,0 +1,104 @@
+/*
+ * 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 { getFID, getLCP, getCLS, Metric } from 'web-vitals';
+import { hrTime } from '@opentelemetry/core';
+import {
+ InstrumentationBase,
+ InstrumentationConfig,
+} from '@opentelemetry/instrumentation';
+import { VERSION } from './version';
+
+export interface WebVitalsInstrumentationConfig extends InstrumentationConfig {
+ lcp?: {
+ reportAllChanges: boolean;
+ };
+ cls?: {
+ reportAllChanges: boolean;
+ };
+}
+
+/**
+ * This class represents a web vitals plugin
+ */
+export class WebVitalsInstrumentation extends InstrumentationBase {
+ readonly component: string = 'web-vitals';
+ readonly version: string = '1';
+ moduleName = this.component;
+ enabled: boolean | undefined;
+
+ /**
+ *
+ * @param config
+ */
+ constructor(
+ config: WebVitalsInstrumentationConfig & InstrumentationConfig = {}
+ ) {
+ super(
+ '@opentelemetry/instrumentation-web-vitals',
+ VERSION,
+ Object.assign({}, config)
+ );
+ }
+
+ private _getConfig(): WebVitalsInstrumentationConfig {
+ return this._config;
+ }
+
+ init() {}
+
+ report(name: string, metric: Metric, reportDeltas = false): void {
+ if (this.enabled) {
+ const value = metric.value;
+ const now = hrTime();
+ const span = this.tracer.startSpan('webvitals', { startTime: now });
+ span.setAttribute(name, value);
+ if (reportDeltas) {
+ span.setAttribute(`${name}.delta`, metric.delta);
+ span.setAttribute(`${name}.id`, metric.id);
+ }
+ span.end(now);
+ }
+ }
+ /**
+ * implements enable function
+ */
+ override enable(): void {
+ if (this.enabled) {
+ return;
+ }
+ this.enabled = true;
+ getFID(metric => {
+ this.report('fid', metric);
+ });
+ const clsReportAllChanges = this._getConfig().cls?.reportAllChanges;
+ getCLS(metric => {
+ this.report('cls', metric, clsReportAllChanges);
+ }, clsReportAllChanges);
+
+ const lcpReportAllChanges = this._getConfig().lcp?.reportAllChanges;
+ getLCP(metric => {
+ this.report('lcp', metric, lcpReportAllChanges);
+ }, lcpReportAllChanges);
+ }
+
+ /**
+ * implements disable function
+ */
+ override disable() {
+ this.enabled = false;
+ }
+}
diff --git a/plugins/web/opentelemetry-instrumentation-web-vitals/src/version.ts b/plugins/web/opentelemetry-instrumentation-web-vitals/src/version.ts
new file mode 100644
index 0000000000..2c1c3f80c6
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/src/version.ts
@@ -0,0 +1,18 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// this is autogenerated file, see scripts/version-update.js
+export const VERSION = '0.25.0';
diff --git a/plugins/web/opentelemetry-instrumentation-web-vitals/test/index-webpack.ts b/plugins/web/opentelemetry-instrumentation-web-vitals/test/index-webpack.ts
new file mode 100644
index 0000000000..061a48ccfa
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/test/index-webpack.ts
@@ -0,0 +1,20 @@
+/*
+ * 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.
+ */
+const testsContext = require.context('.', true, /test$/);
+testsContext.keys().forEach(testsContext);
+
+const srcContext = require.context('.', true, /src$/);
+srcContext.keys().forEach(srcContext);
diff --git a/plugins/web/opentelemetry-instrumentation-web-vitals/test/webVitals.test.ts b/plugins/web/opentelemetry-instrumentation-web-vitals/test/webVitals.test.ts
new file mode 100644
index 0000000000..7a15c292d0
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/test/webVitals.test.ts
@@ -0,0 +1,94 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import * as tracing from '@opentelemetry/sdk-trace-base';
+import { WebTracerProvider } from '@opentelemetry/sdk-trace-web';
+import { registerInstrumentations } from '@opentelemetry/instrumentation';
+
+import * as assert from 'assert';
+import * as sinon from 'sinon';
+import { WebVitalsInstrumentation } from '../src';
+
+const exporter = new tracing.InMemorySpanExporter();
+const provider = new tracing.BasicTracerProvider();
+const spanProcessor = new tracing.SimpleSpanProcessor(exporter);
+let exportSpy: any;
+
+provider.addSpanProcessor(spanProcessor);
+provider.register();
+
+class DummySpanExporter implements tracing.SpanExporter {
+ export(spans: any) {}
+
+ shutdown() {
+ return Promise.resolve();
+ }
+}
+
+describe('Web vitals Instrumentation', () => {
+ beforeEach(() => {
+ const conf = { enabled: false };
+ const webVitalsInstrumentation = new WebVitalsInstrumentation(conf);
+ const webTracerProvider = new WebTracerProvider();
+
+ const dummySpanExporter = new DummySpanExporter();
+ exportSpy = sinon.stub(dummySpanExporter, 'export');
+ webTracerProvider.addSpanProcessor(
+ new tracing.SimpleSpanProcessor(dummySpanExporter)
+ );
+
+ registerInstrumentations({
+ tracerProvider: webTracerProvider,
+ instrumentations: [webVitalsInstrumentation],
+ });
+ });
+
+ it('should capture lcp and cls', done => {
+ document.body.appendChild(document.createTextNode("Don't shift me!"));
+
+ // tests very flaky without those weird timeouts
+ setTimeout(() => {
+ document.body.insertBefore(
+ document.createTextNode('CLSandLCPForcingNode'),
+ document.body.firstChild
+ );
+
+ setTimeout(() => {
+ // CLS is sent on page hide
+ Object.defineProperty(document, 'visibilityState', {
+ value: 'hidden',
+ configurable: true,
+ });
+ window.dispatchEvent(new Event('visibilitychange'));
+ const cls = exportSpy.args.find((el: any) => {
+ return el[0][0].attributes.cls !== undefined;
+ });
+
+ assert.ok(cls, 'CLS span not found');
+ assert.ok(cls[0][0].attributes.cls > 0, 'CLS is 0');
+
+ const lcp = exportSpy.args.find((el: any) => {
+ return el[0][0].attributes.lcp !== undefined;
+ });
+
+ assert.ok(lcp, 'LCP span not found');
+ assert.ok(lcp[0][0].attributes.lcp > 0, 'LCP is 0');
+
+ done();
+ }, 100);
+ }, 100);
+ });
+});
diff --git a/plugins/web/opentelemetry-instrumentation-web-vitals/tsconfig.esm.json b/plugins/web/opentelemetry-instrumentation-web-vitals/tsconfig.esm.json
new file mode 100644
index 0000000000..379f547a46
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/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-vitals/tsconfig.json b/plugins/web/opentelemetry-instrumentation-web-vitals/tsconfig.json
new file mode 100644
index 0000000000..28be80d266
--- /dev/null
+++ b/plugins/web/opentelemetry-instrumentation-web-vitals/tsconfig.json
@@ -0,0 +1,11 @@
+{
+ "extends": "../../../tsconfig.base",
+ "compilerOptions": {
+ "rootDir": ".",
+ "outDir": "build"
+ },
+ "include": [
+ "src/**/*.ts",
+ "test/**/*.ts"
+ ]
+}