@opentelemetry/browser-instrumentation 0.1.0

package/README.md

@@ -0,0 +1,123 @@
+# @opentelemetry/browser-instrumentation
+
+[![NPM Published Version][npm-img]][npm-url]
+[![Apache License][license-image]][license-image]
+
+OpenTelemetry browser instrumentations, available as subpath exports under `./experimental/*`.
+
+## Installation
+
+```bash
+npm install @opentelemetry/browser-instrumentation
+```
+
+## Instrumentations
+
+- [Navigation Timing](#navigation-timing) — automatic instrumentation for navigation timing
+- [User Action](#user-action) — automatic instrumentation for user actions (clicks)
+- [Web Vitals](#web-vitals) — automatic instrumentation for Core Web Vitals
+
+## Usage
+
+```typescript
+import { logs } from '@opentelemetry/api-logs';
+import {
+  ConsoleLogRecordExporter,
+  LoggerProvider,
+  SimpleLogRecordProcessor,
+} from '@opentelemetry/sdk-logs';
+import { registerInstrumentations } from '@opentelemetry/instrumentation';
+import { NavigationTimingInstrumentation } from '@opentelemetry/browser-instrumentation/experimental/navigation-timing';
+import { UserActionInstrumentation } from '@opentelemetry/browser-instrumentation/experimental/user-action';
+import { WebVitalsInstrumentation } from '@opentelemetry/browser-instrumentation/experimental/web-vitals';
+
+const logProvider = new LoggerProvider({
+  processors: [
+    new SimpleLogRecordProcessor(new ConsoleLogRecordExporter()),
+  ],
+});
+logs.setGlobalLoggerProvider(logProvider);
+
+registerInstrumentations({
+  instrumentations: [
+    new NavigationTimingInstrumentation(),
+    new UserActionInstrumentation(),
+    new WebVitalsInstrumentation(),
+  ],
+});
+```
+
+---
+
+### Navigation Timing
+
+```typescript
+import { NavigationTimingInstrumentation } from '@opentelemetry/browser-instrumentation/experimental/navigation-timing';
+```
+
+Provides automatic instrumentation for [Navigation Timing](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming) in web applications.
+
+---
+
+### User Action
+
+```typescript
+import { UserActionInstrumentation } from '@opentelemetry/browser-instrumentation/experimental/user-action';
+```
+
+Provides automatic instrumentation for user actions in web applications.
+
+Compatible with OpenTelemetry JS API and SDK `1.0+`.
+
+#### Configuration
+
+By default the instrumentation captures `click` events. You can configure which events to capture by passing an options object:
+
+```typescript
+new UserActionInstrumentation({
+  autoCapturedActions: [], // default is ['click']
+});
+```
+
+#### Additional Attributes
+
+Data attributes with the prefix `data-otel-` on the target element will be added as additional attributes to the generated log record. For example:
+
+```html
+<button id="btn1" data-otel-user-id="12345" data-otel-feature="signup">
+  Sign Up
+</button>
+```
+
+---
+
+### Web Vitals
+
+```typescript
+import { WebVitalsInstrumentation } from '@opentelemetry/browser-instrumentation/experimental/web-vitals';
+```
+
+Provides automatic instrumentation for [Core Web Vitals](https://web.dev/vitals/) using the [`web-vitals`](https://github.com/GoogleChrome/web-vitals) library.
+
+#### Configuration
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `includeRawAttribution` | `boolean` | `false` | When true, sets the log record body to the JSON-stringified `web-vitals` attribution object. |
+| `applyCustomLogRecordData` | `(logRecord: LogRecord) => void` | — | Hook to modify log records before they are emitted. |
+
+## Useful links
+
+- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
+- For more about OpenTelemetry Browser: <https://github.com/open-telemetry/opentelemetry-browser>
+- 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-browser/discussions/landing
+[license-url]: https://github.com/open-telemetry/opentelemetry-browser/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/browser-instrumentation
+[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fbrowser-instrumentation.svg

package/dist/navigation-timing/index.d.ts

@@ -0,0 +1,2 @@
+import { NavigationTimingInstrumentation } from "./instrumentation.js";
+export { NavigationTimingInstrumentation };

package/dist/navigation-timing/index.js

@@ -0,0 +1,2 @@
+import { NavigationTimingInstrumentation } from "./instrumentation.js";
+export { NavigationTimingInstrumentation };

package/dist/navigation-timing/instrumentation.d.ts

@@ -0,0 +1,41 @@
+import { NavigationTimingInstrumentationConfig } from "./types.js";
+import { InstrumentationBase } from "@opentelemetry/instrumentation";
+
+//#region src/navigation-timing/instrumentation.d.ts
+/**
+ * This class automatically instruments navigation timing within the browser.
+ */
+declare class NavigationTimingInstrumentation extends InstrumentationBase<NavigationTimingInstrumentationConfig> {
+  private _lastEntry?;
+  private _didEmit;
+  private _completeDelayTimeoutId?;
+  private _retryCount;
+  private _isEnabled;
+  private _onLoad;
+  private _onPageHide;
+  constructor(config?: NavigationTimingInstrumentationConfig);
+  protected init(): never[];
+  enable(): void;
+  disable(): void;
+  private _getLatestNavigationEntry;
+  private _calculateBackoffDelay;
+  /**
+   * Attempts to emit the navigation timing event.
+   *
+   * - Emits immediately if a complete `PerformanceNavigationTiming` entry is available.
+   * - If the page is still loading, waits for `window.load` and retries.
+   * - If the page is already loaded but the entry is not finalized yet, schedules one
+   *   deferred re-check (to allow the browser to populate the timing fields).
+   *
+   * This method can be called multiple times (from `enable()`, the load handler, or the
+   * deferred timeout), so it must be safe to re-enter.
+   */
+  private _tryEmitOrSchedule;
+  private _handleUnload;
+  private _emitAndCleanup;
+  private _emitNavigationTiming;
+  private _unsubscribeAll;
+}
+//#endregion
+export { NavigationTimingInstrumentation };
+//# sourceMappingURL=instrumentation.d.ts.map

package/dist/navigation-timing/instrumentation.js

@@ -0,0 +1,144 @@
+import { ATTR_NAVIGATION_CONNECT_END, ATTR_NAVIGATION_CONNECT_START, ATTR_NAVIGATION_DECODED_BODY_SIZE, ATTR_NAVIGATION_DOMAIN_LOOKUP_END, ATTR_NAVIGATION_DOMAIN_LOOKUP_START, ATTR_NAVIGATION_DOM_COMPLETE, ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_END, ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_START, ATTR_NAVIGATION_DOM_INTERACTIVE, ATTR_NAVIGATION_DURATION, ATTR_NAVIGATION_ENCODED_BODY_SIZE, ATTR_NAVIGATION_FETCH_START, ATTR_NAVIGATION_LOAD_EVENT_END, ATTR_NAVIGATION_LOAD_EVENT_START, ATTR_NAVIGATION_REDIRECT_COUNT, ATTR_NAVIGATION_REQUEST_START, ATTR_NAVIGATION_RESPONSE_END, ATTR_NAVIGATION_RESPONSE_START, ATTR_NAVIGATION_SECURE_CONNECTION_START, ATTR_NAVIGATION_TRANSFER_SIZE, ATTR_NAVIGATION_TYPE, ATTR_NAVIGATION_UNLOAD_EVENT_END, ATTR_NAVIGATION_UNLOAD_EVENT_START, ATTR_NAVIGATION_URL, NAVIGATION_TIMING_EVENT_NAME } from "./semconv.js";
+import { SeverityNumber } from "@opentelemetry/api-logs";
+import { InstrumentationBase } from "@opentelemetry/instrumentation";
+//#region src/navigation-timing/instrumentation.ts
+const BASE_DELAY_MS = 50;
+const MAX_RETRIES = 5;
+/**
+* This class automatically instruments navigation timing within the browser.
+*/
+var NavigationTimingInstrumentation = class extends InstrumentationBase {
+	_lastEntry;
+	_didEmit = false;
+	_completeDelayTimeoutId;
+	_retryCount = 0;
+	_isEnabled = false;
+	_onLoad = () => {
+		this._tryEmitOrSchedule();
+	};
+	_onPageHide = () => {
+		this._handleUnload();
+	};
+	constructor(config = {}) {
+		super("@opentelemetry/instrumentation-navigation-timing", "0.1.0", config);
+	}
+	init() {
+		return [];
+	}
+	enable() {
+		if (this._isEnabled) return;
+		this._isEnabled = true;
+		this._tryEmitOrSchedule();
+		if (this._didEmit) return;
+		window.addEventListener("pagehide", this._onPageHide);
+	}
+	disable() {
+		this._isEnabled = false;
+		this._unsubscribeAll();
+		this._lastEntry = void 0;
+		this._didEmit = false;
+		this._retryCount = 0;
+	}
+	_getLatestNavigationEntry() {
+		const entries = performance?.getEntriesByType?.("navigation");
+		if (!entries || entries.length === 0) return;
+		return entries[entries.length - 1];
+	}
+	_calculateBackoffDelay() {
+		return this._retryCount * BASE_DELAY_MS;
+	}
+	/**
+	* Attempts to emit the navigation timing event.
+	*
+	* - Emits immediately if a complete `PerformanceNavigationTiming` entry is available.
+	* - If the page is still loading, waits for `window.load` and retries.
+	* - If the page is already loaded but the entry is not finalized yet, schedules one
+	*   deferred re-check (to allow the browser to populate the timing fields).
+	*
+	* This method can be called multiple times (from `enable()`, the load handler, or the
+	* deferred timeout), so it must be safe to re-enter.
+	*/
+	_tryEmitOrSchedule() {
+		if (this._didEmit) return;
+		const entry = this._getLatestNavigationEntry();
+		if (entry) this._lastEntry = entry;
+		if (entry && entry.loadEventEnd > 0) {
+			this._emitAndCleanup(entry);
+			return;
+		}
+		if (document.readyState !== "complete") {
+			window.addEventListener("load", this._onLoad, { once: true });
+			return;
+		}
+		if (this._completeDelayTimeoutId !== void 0 || this._retryCount > MAX_RETRIES) return;
+		else {
+			const delay = this._calculateBackoffDelay();
+			this._retryCount++;
+			this._completeDelayTimeoutId = window.setTimeout(() => {
+				this._completeDelayTimeoutId = void 0;
+				this._tryEmitOrSchedule();
+			}, delay);
+		}
+	}
+	_handleUnload() {
+		if (this._didEmit) return;
+		const entry = this._getLatestNavigationEntry() ?? this._lastEntry;
+		if (!entry) {
+			this._unsubscribeAll();
+			return;
+		}
+		this._emitAndCleanup(entry);
+	}
+	_emitAndCleanup(entry) {
+		if (this._didEmit) return;
+		this._didEmit = true;
+		this._emitNavigationTiming(entry);
+		this._lastEntry = void 0;
+		this._unsubscribeAll();
+	}
+	_emitNavigationTiming(entry) {
+		if (!entry) return;
+		this.logger.emit({
+			eventName: NAVIGATION_TIMING_EVENT_NAME,
+			severityNumber: SeverityNumber.INFO,
+			attributes: {
+				[ATTR_NAVIGATION_TYPE]: entry.type,
+				[ATTR_NAVIGATION_URL]: entry.name,
+				[ATTR_NAVIGATION_DURATION]: entry.duration,
+				[ATTR_NAVIGATION_DOM_COMPLETE]: entry.domComplete,
+				[ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_END]: entry.domContentLoadedEventEnd,
+				[ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_START]: entry.domContentLoadedEventStart,
+				[ATTR_NAVIGATION_DOM_INTERACTIVE]: entry.domInteractive,
+				[ATTR_NAVIGATION_LOAD_EVENT_END]: entry.loadEventEnd,
+				[ATTR_NAVIGATION_LOAD_EVENT_START]: entry.loadEventStart,
+				[ATTR_NAVIGATION_REDIRECT_COUNT]: entry.redirectCount,
+				[ATTR_NAVIGATION_UNLOAD_EVENT_END]: entry.unloadEventEnd,
+				[ATTR_NAVIGATION_UNLOAD_EVENT_START]: entry.unloadEventStart,
+				[ATTR_NAVIGATION_FETCH_START]: entry.fetchStart,
+				[ATTR_NAVIGATION_DOMAIN_LOOKUP_START]: entry.domainLookupStart,
+				[ATTR_NAVIGATION_DOMAIN_LOOKUP_END]: entry.domainLookupEnd,
+				[ATTR_NAVIGATION_CONNECT_START]: entry.connectStart,
+				[ATTR_NAVIGATION_CONNECT_END]: entry.connectEnd,
+				[ATTR_NAVIGATION_SECURE_CONNECTION_START]: entry.secureConnectionStart,
+				[ATTR_NAVIGATION_REQUEST_START]: entry.requestStart,
+				[ATTR_NAVIGATION_RESPONSE_START]: entry.responseStart,
+				[ATTR_NAVIGATION_RESPONSE_END]: entry.responseEnd,
+				[ATTR_NAVIGATION_TRANSFER_SIZE]: entry.transferSize,
+				[ATTR_NAVIGATION_ENCODED_BODY_SIZE]: entry.encodedBodySize,
+				[ATTR_NAVIGATION_DECODED_BODY_SIZE]: entry.decodedBodySize
+			}
+		});
+	}
+	_unsubscribeAll() {
+		if (this._completeDelayTimeoutId) {
+			clearTimeout(this._completeDelayTimeoutId);
+			this._completeDelayTimeoutId = void 0;
+		}
+		window.removeEventListener("load", this._onLoad);
+		window.removeEventListener("pagehide", this._onPageHide);
+	}
+};
+//#endregion
+export { NavigationTimingInstrumentation };
+
+//# sourceMappingURL=instrumentation.js.map

package/dist/navigation-timing/instrumentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumentation.js","names":[],"sources":["../../src/navigation-timing/instrumentation.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n * SPDX-License-Identifier: Apache-2.0\n */\n\nimport { SeverityNumber } from '@opentelemetry/api-logs';\nimport { InstrumentationBase } from '@opentelemetry/instrumentation';\nimport {\n  ATTR_NAVIGATION_CONNECT_END,\n  ATTR_NAVIGATION_CONNECT_START,\n  ATTR_NAVIGATION_DECODED_BODY_SIZE,\n  ATTR_NAVIGATION_DOM_COMPLETE,\n  ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_END,\n  ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_START,\n  ATTR_NAVIGATION_DOM_INTERACTIVE,\n  ATTR_NAVIGATION_DOMAIN_LOOKUP_END,\n  ATTR_NAVIGATION_DOMAIN_LOOKUP_START,\n  ATTR_NAVIGATION_DURATION,\n  ATTR_NAVIGATION_ENCODED_BODY_SIZE,\n  ATTR_NAVIGATION_FETCH_START,\n  ATTR_NAVIGATION_LOAD_EVENT_END,\n  ATTR_NAVIGATION_LOAD_EVENT_START,\n  ATTR_NAVIGATION_REDIRECT_COUNT,\n  ATTR_NAVIGATION_REQUEST_START,\n  ATTR_NAVIGATION_RESPONSE_END,\n  ATTR_NAVIGATION_RESPONSE_START,\n  ATTR_NAVIGATION_SECURE_CONNECTION_START,\n  ATTR_NAVIGATION_TRANSFER_SIZE,\n  ATTR_NAVIGATION_TYPE,\n  ATTR_NAVIGATION_UNLOAD_EVENT_END,\n  ATTR_NAVIGATION_UNLOAD_EVENT_START,\n  ATTR_NAVIGATION_URL,\n  NAVIGATION_TIMING_EVENT_NAME,\n} from './semconv.ts';\nimport type { NavigationTimingInstrumentationConfig } from './types.ts';\n\nconst BASE_DELAY_MS = 50;\nconst MAX_RETRIES = 5;\n\n/**\n * This class automatically instruments navigation timing within the browser.\n */\nexport class NavigationTimingInstrumentation extends InstrumentationBase<NavigationTimingInstrumentationConfig> {\n  private _lastEntry?: PerformanceNavigationTiming;\n  private _didEmit = false;\n  private _completeDelayTimeoutId?: number;\n  private _retryCount = 0;\n  private _isEnabled = false;\n\n  private _onLoad = () => {\n    this._tryEmitOrSchedule();\n  };\n\n  private _onPageHide = () => {\n    this._handleUnload();\n  };\n\n  constructor(config: NavigationTimingInstrumentationConfig = {}) {\n    super('@opentelemetry/instrumentation-navigation-timing', '0.1.0', config);\n  }\n\n  protected override init() {\n    return [];\n  }\n\n  override enable(): void {\n    if (this._isEnabled) {\n      return;\n    }\n    this._isEnabled = true;\n\n    // Try emitting immediately (e.g. when enabled after load),\n    // otherwise schedule for `load` or fall back to unload.\n    this._tryEmitOrSchedule();\n    if (this._didEmit) {\n      return;\n    }\n\n    window.addEventListener('pagehide', this._onPageHide);\n  }\n\n  override disable(): void {\n    this._isEnabled = false;\n    this._unsubscribeAll();\n    this._lastEntry = undefined;\n    this._didEmit = false;\n    this._retryCount = 0;\n  }\n\n  private _getLatestNavigationEntry(): PerformanceNavigationTiming | undefined {\n    const entries = performance?.getEntriesByType?.('navigation') as\n      | PerformanceNavigationTiming[]\n      | undefined;\n    if (!entries || entries.length === 0) {\n      return;\n    }\n\n    return entries[entries.length - 1];\n  }\n\n  private _calculateBackoffDelay(): number {\n    return this._retryCount * BASE_DELAY_MS;\n  }\n\n  /**\n   * Attempts to emit the navigation timing event.\n   *\n   * - Emits immediately if a complete `PerformanceNavigationTiming` entry is available.\n   * - If the page is still loading, waits for `window.load` and retries.\n   * - If the page is already loaded but the entry is not finalized yet, schedules one\n   *   deferred re-check (to allow the browser to populate the timing fields).\n   *\n   * This method can be called multiple times (from `enable()`, the load handler, or the\n   * deferred timeout), so it must be safe to re-enter.\n   */\n  private _tryEmitOrSchedule(): void {\n    if (this._didEmit) {\n      return;\n    }\n\n    const entry = this._getLatestNavigationEntry();\n    if (entry) {\n      this._lastEntry = entry;\n    }\n\n    // Prefer emitting a \"complete\" navigation entry.\n    if (entry && entry.loadEventEnd > 0) {\n      this._emitAndCleanup(entry);\n      return;\n    }\n\n    // If the document is still loading, wait for `load` and try again.\n    if (document.readyState !== 'complete') {\n      window.addEventListener('load', this._onLoad, { once: true });\n      return;\n    }\n\n    // If the document is already complete but navigation timings are not finalized yet,\n    // schedule a deferred re-check with linear backoff to allow the browser to finish\n    // populating the entry.\n    if (\n      this._completeDelayTimeoutId !== undefined ||\n      this._retryCount > MAX_RETRIES\n    ) {\n      return;\n    } else {\n      const delay = this._calculateBackoffDelay();\n      this._retryCount++;\n\n      this._completeDelayTimeoutId = window.setTimeout(() => {\n        this._completeDelayTimeoutId = undefined;\n        this._tryEmitOrSchedule();\n      }, delay);\n    }\n  }\n\n  private _handleUnload(): void {\n    if (this._didEmit) {\n      return;\n    }\n\n    const entry = this._getLatestNavigationEntry() ?? this._lastEntry;\n    if (!entry) {\n      this._unsubscribeAll();\n      return;\n    }\n\n    // Emit even if partial (e.g. loadEventEnd === 0).\n    this._emitAndCleanup(entry);\n  }\n\n  private _emitAndCleanup(entry: PerformanceNavigationTiming): void {\n    if (this._didEmit) {\n      return;\n    }\n\n    this._didEmit = true;\n\n    this._emitNavigationTiming(entry);\n    this._lastEntry = undefined;\n    this._unsubscribeAll();\n  }\n\n  private _emitNavigationTiming(entry: PerformanceNavigationTiming) {\n    if (!entry) {\n      return;\n    }\n\n    this.logger.emit({\n      eventName: NAVIGATION_TIMING_EVENT_NAME,\n      severityNumber: SeverityNumber.INFO,\n      attributes: {\n        [ATTR_NAVIGATION_TYPE]: entry.type,\n        [ATTR_NAVIGATION_URL]: entry.name,\n        [ATTR_NAVIGATION_DURATION]: entry.duration,\n        [ATTR_NAVIGATION_DOM_COMPLETE]: entry.domComplete,\n        [ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_END]:\n          entry.domContentLoadedEventEnd,\n        [ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_START]:\n          entry.domContentLoadedEventStart,\n        [ATTR_NAVIGATION_DOM_INTERACTIVE]: entry.domInteractive,\n        [ATTR_NAVIGATION_LOAD_EVENT_END]: entry.loadEventEnd,\n        [ATTR_NAVIGATION_LOAD_EVENT_START]: entry.loadEventStart,\n        [ATTR_NAVIGATION_REDIRECT_COUNT]: entry.redirectCount,\n        [ATTR_NAVIGATION_UNLOAD_EVENT_END]: entry.unloadEventEnd,\n        [ATTR_NAVIGATION_UNLOAD_EVENT_START]: entry.unloadEventStart,\n        [ATTR_NAVIGATION_FETCH_START]: entry.fetchStart,\n        [ATTR_NAVIGATION_DOMAIN_LOOKUP_START]: entry.domainLookupStart,\n        [ATTR_NAVIGATION_DOMAIN_LOOKUP_END]: entry.domainLookupEnd,\n        [ATTR_NAVIGATION_CONNECT_START]: entry.connectStart,\n        [ATTR_NAVIGATION_CONNECT_END]: entry.connectEnd,\n        [ATTR_NAVIGATION_SECURE_CONNECTION_START]: entry.secureConnectionStart,\n        [ATTR_NAVIGATION_REQUEST_START]: entry.requestStart,\n        [ATTR_NAVIGATION_RESPONSE_START]: entry.responseStart,\n        [ATTR_NAVIGATION_RESPONSE_END]: entry.responseEnd,\n        [ATTR_NAVIGATION_TRANSFER_SIZE]: entry.transferSize,\n        [ATTR_NAVIGATION_ENCODED_BODY_SIZE]: entry.encodedBodySize,\n        [ATTR_NAVIGATION_DECODED_BODY_SIZE]: entry.decodedBodySize,\n      },\n    });\n  }\n\n  private _unsubscribeAll(): void {\n    if (this._completeDelayTimeoutId) {\n      clearTimeout(this._completeDelayTimeoutId);\n      this._completeDelayTimeoutId = undefined;\n    }\n\n    window.removeEventListener('load', this._onLoad);\n    window.removeEventListener('pagehide', this._onPageHide);\n  }\n}\n"],"mappings":";;;;AAoCA,MAAM,gBAAgB;AACtB,MAAM,cAAc;;;;AAKpB,IAAa,kCAAb,cAAqD,oBAA2D;CAC9G;CACA,WAAmB;CACnB;CACA,cAAsB;CACtB,aAAqB;CAErB,gBAAwB;AACtB,OAAK,oBAAoB;;CAG3B,oBAA4B;AAC1B,OAAK,eAAe;;CAGtB,YAAY,SAAgD,EAAE,EAAE;AAC9D,QAAM,oDAAoD,SAAS,OAAO;;CAG5E,OAA0B;AACxB,SAAO,EAAE;;CAGX,SAAwB;AACtB,MAAI,KAAK,WACP;AAEF,OAAK,aAAa;AAIlB,OAAK,oBAAoB;AACzB,MAAI,KAAK,SACP;AAGF,SAAO,iBAAiB,YAAY,KAAK,YAAY;;CAGvD,UAAyB;AACvB,OAAK,aAAa;AAClB,OAAK,iBAAiB;AACtB,OAAK,aAAa,KAAA;AAClB,OAAK,WAAW;AAChB,OAAK,cAAc;;CAGrB,4BAA6E;EAC3E,MAAM,UAAU,aAAa,mBAAmB,aAAa;AAG7D,MAAI,CAAC,WAAW,QAAQ,WAAW,EACjC;AAGF,SAAO,QAAQ,QAAQ,SAAS;;CAGlC,yBAAyC;AACvC,SAAO,KAAK,cAAc;;;;;;;;;;;;;CAc5B,qBAAmC;AACjC,MAAI,KAAK,SACP;EAGF,MAAM,QAAQ,KAAK,2BAA2B;AAC9C,MAAI,MACF,MAAK,aAAa;AAIpB,MAAI,SAAS,MAAM,eAAe,GAAG;AACnC,QAAK,gBAAgB,MAAM;AAC3B;;AAIF,MAAI,SAAS,eAAe,YAAY;AACtC,UAAO,iBAAiB,QAAQ,KAAK,SAAS,EAAE,MAAM,MAAM,CAAC;AAC7D;;AAMF,MACE,KAAK,4BAA4B,KAAA,KACjC,KAAK,cAAc,YAEnB;OACK;GACL,MAAM,QAAQ,KAAK,wBAAwB;AAC3C,QAAK;AAEL,QAAK,0BAA0B,OAAO,iBAAiB;AACrD,SAAK,0BAA0B,KAAA;AAC/B,SAAK,oBAAoB;MACxB,MAAM;;;CAIb,gBAA8B;AAC5B,MAAI,KAAK,SACP;EAGF,MAAM,QAAQ,KAAK,2BAA2B,IAAI,KAAK;AACvD,MAAI,CAAC,OAAO;AACV,QAAK,iBAAiB;AACtB;;AAIF,OAAK,gBAAgB,MAAM;;CAG7B,gBAAwB,OAA0C;AAChE,MAAI,KAAK,SACP;AAGF,OAAK,WAAW;AAEhB,OAAK,sBAAsB,MAAM;AACjC,OAAK,aAAa,KAAA;AAClB,OAAK,iBAAiB;;CAGxB,sBAA8B,OAAoC;AAChE,MAAI,CAAC,MACH;AAGF,OAAK,OAAO,KAAK;GACf,WAAW;GACX,gBAAgB,eAAe;GAC/B,YAAY;KACT,uBAAuB,MAAM;KAC7B,sBAAsB,MAAM;KAC5B,2BAA2B,MAAM;KACjC,+BAA+B,MAAM;KACrC,+CACC,MAAM;KACP,iDACC,MAAM;KACP,kCAAkC,MAAM;KACxC,iCAAiC,MAAM;KACvC,mCAAmC,MAAM;KACzC,iCAAiC,MAAM;KACvC,mCAAmC,MAAM;KACzC,qCAAqC,MAAM;KAC3C,8BAA8B,MAAM;KACpC,sCAAsC,MAAM;KAC5C,oCAAoC,MAAM;KAC1C,gCAAgC,MAAM;KACtC,8BAA8B,MAAM;KACpC,0CAA0C,MAAM;KAChD,gCAAgC,MAAM;KACtC,iCAAiC,MAAM;KACvC,+BAA+B,MAAM;KACrC,gCAAgC,MAAM;KACtC,oCAAoC,MAAM;KAC1C,oCAAoC,MAAM;IAC5C;GACF,CAAC;;CAGJ,kBAAgC;AAC9B,MAAI,KAAK,yBAAyB;AAChC,gBAAa,KAAK,wBAAwB;AAC1C,QAAK,0BAA0B,KAAA;;AAGjC,SAAO,oBAAoB,QAAQ,KAAK,QAAQ;AAChD,SAAO,oBAAoB,YAAY,KAAK,YAAY"}

package/dist/navigation-timing/semconv.js

@@ -0,0 +1,102 @@
+//#region src/navigation-timing/semconv.ts
+const NAVIGATION_TIMING_EVENT_NAME = "browser.navigation_timing";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_TYPE = "navigation.type";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_URL = "navigation.url";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_DURATION = "navigation.duration";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_DOM_COMPLETE = "navigation.dom_complete";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_END = "navigation.dom_content_loaded_event_end";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_START = "navigation.dom_content_loaded_event_start";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_DOM_INTERACTIVE = "navigation.dom_interactive";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_LOAD_EVENT_END = "navigation.load_event_end";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_LOAD_EVENT_START = "navigation.load_event_start";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_REDIRECT_COUNT = "navigation.redirect_count";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_UNLOAD_EVENT_END = "navigation.unload_event_end";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_UNLOAD_EVENT_START = "navigation.unload_event_start";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_FETCH_START = "navigation.fetch_start";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_DOMAIN_LOOKUP_START = "navigation.domain_lookup_start";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_DOMAIN_LOOKUP_END = "navigation.domain_lookup_end";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_CONNECT_START = "navigation.connect_start";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_CONNECT_END = "navigation.connect_end";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_SECURE_CONNECTION_START = "navigation.secure_connection_start";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_REQUEST_START = "navigation.request_start";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_RESPONSE_START = "navigation.response_start";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_RESPONSE_END = "navigation.response_end";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_TRANSFER_SIZE = "navigation.transfer_size";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_ENCODED_BODY_SIZE = "navigation.encoded_body_size";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_NAVIGATION_DECODED_BODY_SIZE = "navigation.decoded_body_size";
+//#endregion
+export { ATTR_NAVIGATION_CONNECT_END, ATTR_NAVIGATION_CONNECT_START, ATTR_NAVIGATION_DECODED_BODY_SIZE, ATTR_NAVIGATION_DOMAIN_LOOKUP_END, ATTR_NAVIGATION_DOMAIN_LOOKUP_START, ATTR_NAVIGATION_DOM_COMPLETE, ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_END, ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_START, ATTR_NAVIGATION_DOM_INTERACTIVE, ATTR_NAVIGATION_DURATION, ATTR_NAVIGATION_ENCODED_BODY_SIZE, ATTR_NAVIGATION_FETCH_START, ATTR_NAVIGATION_LOAD_EVENT_END, ATTR_NAVIGATION_LOAD_EVENT_START, ATTR_NAVIGATION_REDIRECT_COUNT, ATTR_NAVIGATION_REQUEST_START, ATTR_NAVIGATION_RESPONSE_END, ATTR_NAVIGATION_RESPONSE_START, ATTR_NAVIGATION_SECURE_CONNECTION_START, ATTR_NAVIGATION_TRANSFER_SIZE, ATTR_NAVIGATION_TYPE, ATTR_NAVIGATION_UNLOAD_EVENT_END, ATTR_NAVIGATION_UNLOAD_EVENT_START, ATTR_NAVIGATION_URL, NAVIGATION_TIMING_EVENT_NAME };
+
+//# sourceMappingURL=semconv.js.map

package/dist/navigation-timing/semconv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semconv.js","names":[],"sources":["../../src/navigation-timing/semconv.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n * SPDX-License-Identifier: Apache-2.0\n */\n\n/*\n * This file contains a copy of unstable semantic convention definitions\n * used by this package.\n * @see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv\n */\n\nexport const NAVIGATION_TIMING_EVENT_NAME = 'browser.navigation_timing';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_TYPE = 'navigation.type';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_URL = 'navigation.url';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_DURATION = 'navigation.duration';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_DOM_COMPLETE = 'navigation.dom_complete';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_END =\n  'navigation.dom_content_loaded_event_end';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_DOM_CONTENT_LOADED_EVENT_START =\n  'navigation.dom_content_loaded_event_start';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_DOM_INTERACTIVE = 'navigation.dom_interactive';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_LOAD_EVENT_END = 'navigation.load_event_end';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_LOAD_EVENT_START = 'navigation.load_event_start';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_REDIRECT_COUNT = 'navigation.redirect_count';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_UNLOAD_EVENT_END = 'navigation.unload_event_end';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_UNLOAD_EVENT_START =\n  'navigation.unload_event_start';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_FETCH_START = 'navigation.fetch_start';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_DOMAIN_LOOKUP_START =\n  'navigation.domain_lookup_start';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_DOMAIN_LOOKUP_END = 'navigation.domain_lookup_end';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_CONNECT_START = 'navigation.connect_start';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_CONNECT_END = 'navigation.connect_end';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_SECURE_CONNECTION_START =\n  'navigation.secure_connection_start';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_REQUEST_START = 'navigation.request_start';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_RESPONSE_START = 'navigation.response_start';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_RESPONSE_END = 'navigation.response_end';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_TRANSFER_SIZE = 'navigation.transfer_size';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_ENCODED_BODY_SIZE = 'navigation.encoded_body_size';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_NAVIGATION_DECODED_BODY_SIZE = 'navigation.decoded_body_size';\n"],"mappings":";AAWA,MAAa,+BAA+B;;;;AAK5C,MAAa,uBAAuB;;;;AAKpC,MAAa,sBAAsB;;;;AAKnC,MAAa,2BAA2B;;;;AAKxC,MAAa,+BAA+B;;;;AAK5C,MAAa,+CACX;;;;AAKF,MAAa,iDACX;;;;AAKF,MAAa,kCAAkC;;;;AAK/C,MAAa,iCAAiC;;;;AAK9C,MAAa,mCAAmC;;;;AAKhD,MAAa,iCAAiC;;;;AAK9C,MAAa,mCAAmC;;;;AAKhD,MAAa,qCACX;;;;AAKF,MAAa,8BAA8B;;;;AAK3C,MAAa,sCACX;;;;AAKF,MAAa,oCAAoC;;;;AAKjD,MAAa,gCAAgC;;;;AAK7C,MAAa,8BAA8B;;;;AAK3C,MAAa,0CACX;;;;AAKF,MAAa,gCAAgC;;;;AAK7C,MAAa,iCAAiC;;;;AAK9C,MAAa,+BAA+B;;;;AAK5C,MAAa,gCAAgC;;;;AAK7C,MAAa,oCAAoC;;;;AAKjD,MAAa,oCAAoC"}

package/dist/navigation-timing/types.d.ts

@@ -0,0 +1,10 @@
+import { InstrumentationConfig } from "@opentelemetry/instrumentation";
+
+//#region src/navigation-timing/types.d.ts
+/**
+ * NavigationTimingInstrumentation Configuration
+ */
+interface NavigationTimingInstrumentationConfig extends InstrumentationConfig {}
+//#endregion
+export { NavigationTimingInstrumentationConfig };
+//# sourceMappingURL=types.d.ts.map

package/dist/user-action/index.d.ts

@@ -0,0 +1,2 @@
+import { UserActionInstrumentation } from "./instrumentation.js";
+export { UserActionInstrumentation };

package/dist/user-action/index.js

@@ -0,0 +1,2 @@
+import { UserActionInstrumentation } from "./instrumentation.js";
+export { UserActionInstrumentation };

package/dist/user-action/instrumentation.d.ts

@@ -0,0 +1,19 @@
+import { UserActionInstrumentationConfig } from "./types.js";
+import { InstrumentationBase } from "@opentelemetry/instrumentation";
+
+//#region src/user-action/instrumentation.d.ts
+/**
+ * This class automatically instruments different User Actions within the browser.
+ */
+declare class UserActionInstrumentation extends InstrumentationBase<UserActionInstrumentationConfig> {
+  private _onClickHandler?;
+  constructor(config?: UserActionInstrumentationConfig);
+  protected init(): never[];
+  private _getMouseButtonFromMouseEvent;
+  private onClick;
+  enable(): void;
+  disable(): void;
+}
+//#endregion
+export { UserActionInstrumentation };
+//# sourceMappingURL=instrumentation.d.ts.map

package/dist/user-action/instrumentation.js

@@ -0,0 +1,61 @@
+import { getElementCSSSelector } from "../web-utils/dist/getElementCSSSelector.js";
+import { ATTR_CSS_SELECTOR, ATTR_MOUSE_EVENT_BUTTON, ATTR_PAGE_X, ATTR_PAGE_Y, ATTR_TAGS, ATTR_TAG_NAME, CLICK_EVENT_NAME } from "./semconv.js";
+import { SeverityNumber } from "@opentelemetry/api-logs";
+import { InstrumentationBase } from "@opentelemetry/instrumentation";
+//#region src/user-action/instrumentation.ts
+const DEFAULT_AUTO_CAPTURED_ACTIONS = ["click"];
+const OTEL_ELEMENT_ATTRIBUTE_PREFIX = "data-otel-";
+/**
+* This class automatically instruments different User Actions within the browser.
+*/
+var UserActionInstrumentation = class extends InstrumentationBase {
+	constructor(config = {}) {
+		super("@opentelemetry/instrumentation-user-action", "0.1.0", config);
+	}
+	init() {
+		return [];
+	}
+	_getMouseButtonFromMouseEvent(event) {
+		switch (event.button) {
+			case 0: return "left";
+			case 1: return "middle";
+			case 2: return "right";
+			default: return "left";
+		}
+	}
+	onClick(event) {
+		const element = event.target;
+		if (!(element instanceof HTMLElement)) return;
+		if (element.hasAttribute("disabled")) return;
+		const cssSelector = getElementCSSSelector(element, {
+			useIdForTargetElement: true,
+			useIdForAncestors: true
+		});
+		const otelPrefixedAttributes = {};
+		for (const attr of element.attributes) if (attr.name.startsWith(OTEL_ELEMENT_ATTRIBUTE_PREFIX)) otelPrefixedAttributes[attr.name.slice(10)] = attr.value;
+		this.logger.emit({
+			severityNumber: SeverityNumber.INFO,
+			eventName: CLICK_EVENT_NAME,
+			attributes: {
+				[ATTR_PAGE_X]: event.pageX,
+				[ATTR_PAGE_Y]: event.pageY,
+				[ATTR_TAG_NAME]: element.tagName,
+				[ATTR_TAGS]: otelPrefixedAttributes,
+				[ATTR_MOUSE_EVENT_BUTTON]: this._getMouseButtonFromMouseEvent(event),
+				[ATTR_CSS_SELECTOR]: cssSelector
+			}
+		});
+	}
+	enable() {
+		const autoCapturedActions = this._config.autoCapturedActions ?? DEFAULT_AUTO_CAPTURED_ACTIONS;
+		if (!this._onClickHandler) this._onClickHandler = this.onClick.bind(this);
+		if (autoCapturedActions.includes("click")) document.addEventListener("click", this._onClickHandler, true);
+	}
+	disable() {
+		if (this._onClickHandler) document.removeEventListener("click", this._onClickHandler, true);
+	}
+};
+//#endregion
+export { UserActionInstrumentation };
+
+//# sourceMappingURL=instrumentation.js.map

package/dist/user-action/instrumentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumentation.js","names":[],"sources":["../../src/user-action/instrumentation.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n * SPDX-License-Identifier: Apache-2.0\n */\n\nimport { SeverityNumber } from '@opentelemetry/api-logs';\nimport { InstrumentationBase } from '@opentelemetry/instrumentation';\nimport { getElementCSSSelector } from '@opentelemetry/web-utils';\nimport {\n  ATTR_CSS_SELECTOR,\n  ATTR_MOUSE_EVENT_BUTTON,\n  ATTR_PAGE_X,\n  ATTR_PAGE_Y,\n  ATTR_TAG_NAME,\n  ATTR_TAGS,\n  CLICK_EVENT_NAME,\n} from './semconv.ts';\nimport type {\n  AutoCapturedUserAction,\n  MouseButton,\n  UserActionInstrumentationConfig,\n} from './types.ts';\n\nconst DEFAULT_AUTO_CAPTURED_ACTIONS: AutoCapturedUserAction[] = ['click'];\nconst OTEL_ELEMENT_ATTRIBUTE_PREFIX = 'data-otel-';\n\n/**\n * This class automatically instruments different User Actions within the browser.\n */\nexport class UserActionInstrumentation extends InstrumentationBase<UserActionInstrumentationConfig> {\n  private declare _onClickHandler?: (event: MouseEvent) => void;\n\n  constructor(config: UserActionInstrumentationConfig = {}) {\n    super('@opentelemetry/instrumentation-user-action', '0.1.0', config);\n  }\n\n  protected override init() {\n    return [];\n  }\n\n  private _getMouseButtonFromMouseEvent(event: MouseEvent): MouseButton {\n    switch (event.button) {\n      case 0:\n        return 'left';\n      case 1:\n        return 'middle';\n      case 2:\n        return 'right';\n      default:\n        return 'left';\n    }\n  }\n\n  private onClick(event: MouseEvent) {\n    const element = event.target;\n\n    if (!(element instanceof HTMLElement)) {\n      return;\n    }\n\n    if (element.hasAttribute('disabled')) {\n      return;\n    }\n\n    const cssSelector = getElementCSSSelector(element, {\n      useIdForTargetElement: true,\n      useIdForAncestors: true,\n    });\n    const otelPrefixedAttributes: Record<string, string> = {};\n\n    // Grab all the attributes in the element that start with data-otel-*\n    for (const attr of element.attributes) {\n      if (attr.name.startsWith(OTEL_ELEMENT_ATTRIBUTE_PREFIX)) {\n        otelPrefixedAttributes[\n          attr.name.slice(OTEL_ELEMENT_ATTRIBUTE_PREFIX.length)\n        ] = attr.value;\n      }\n    }\n\n    this.logger.emit({\n      severityNumber: SeverityNumber.INFO,\n      eventName: CLICK_EVENT_NAME,\n      attributes: {\n        [ATTR_PAGE_X]: event.pageX,\n        [ATTR_PAGE_Y]: event.pageY,\n        [ATTR_TAG_NAME]: element.tagName,\n        [ATTR_TAGS]: otelPrefixedAttributes,\n        [ATTR_MOUSE_EVENT_BUTTON]: this._getMouseButtonFromMouseEvent(event),\n        [ATTR_CSS_SELECTOR]: cssSelector,\n      },\n    });\n  }\n\n  override enable(): void {\n    const autoCapturedActions =\n      this._config.autoCapturedActions ?? DEFAULT_AUTO_CAPTURED_ACTIONS;\n    if (!this._onClickHandler) {\n      this._onClickHandler = this.onClick.bind(this);\n    }\n\n    if (autoCapturedActions.includes('click')) {\n      document.addEventListener('click', this._onClickHandler, true);\n    }\n  }\n\n  override disable(): void {\n    if (this._onClickHandler) {\n      document.removeEventListener('click', this._onClickHandler, true);\n    }\n  }\n}\n"],"mappings":";;;;;AAuBA,MAAM,gCAA0D,CAAC,QAAQ;AACzE,MAAM,gCAAgC;;;;AAKtC,IAAa,4BAAb,cAA+C,oBAAqD;CAGlG,YAAY,SAA0C,EAAE,EAAE;AACxD,QAAM,8CAA8C,SAAS,OAAO;;CAGtE,OAA0B;AACxB,SAAO,EAAE;;CAGX,8BAAsC,OAAgC;AACpE,UAAQ,MAAM,QAAd;GACE,KAAK,EACH,QAAO;GACT,KAAK,EACH,QAAO;GACT,KAAK,EACH,QAAO;GACT,QACE,QAAO;;;CAIb,QAAgB,OAAmB;EACjC,MAAM,UAAU,MAAM;AAEtB,MAAI,EAAE,mBAAmB,aACvB;AAGF,MAAI,QAAQ,aAAa,WAAW,CAClC;EAGF,MAAM,cAAc,sBAAsB,SAAS;GACjD,uBAAuB;GACvB,mBAAmB;GACpB,CAAC;EACF,MAAM,yBAAiD,EAAE;AAGzD,OAAK,MAAM,QAAQ,QAAQ,WACzB,KAAI,KAAK,KAAK,WAAW,8BAA8B,CACrD,wBACE,KAAK,KAAK,MAAM,GAAqC,IACnD,KAAK;AAIb,OAAK,OAAO,KAAK;GACf,gBAAgB,eAAe;GAC/B,WAAW;GACX,YAAY;KACT,cAAc,MAAM;KACpB,cAAc,MAAM;KACpB,gBAAgB,QAAQ;KACxB,YAAY;KACZ,0BAA0B,KAAK,8BAA8B,MAAM;KACnE,oBAAoB;IACtB;GACF,CAAC;;CAGJ,SAAwB;EACtB,MAAM,sBACJ,KAAK,QAAQ,uBAAuB;AACtC,MAAI,CAAC,KAAK,gBACR,MAAK,kBAAkB,KAAK,QAAQ,KAAK,KAAK;AAGhD,MAAI,oBAAoB,SAAS,QAAQ,CACvC,UAAS,iBAAiB,SAAS,KAAK,iBAAiB,KAAK;;CAIlE,UAAyB;AACvB,MAAI,KAAK,gBACP,UAAS,oBAAoB,SAAS,KAAK,iBAAiB,KAAK"}

package/dist/user-action/semconv.js

@@ -0,0 +1,42 @@
+//#region src/user-action/semconv.ts
+const CLICK_EVENT_NAME = "browser.user_action.click";
+/**
+* @example left
+*
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_MOUSE_EVENT_BUTTON = "browser.mouse_event.button";
+/**
+* @example 10
+*
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_PAGE_X = "browser.page.x";
+/**
+* @example 10
+*
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_PAGE_Y = "browser.page.y";
+/**
+* @example "BUTTON"
+*
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_TAG_NAME = "browser.tag_name";
+/**
+* @example {"id": "123", "name": "Name"}
+*
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_TAGS = "browser.element.attributes";
+/**
+* @example "#main > div:nth-child(2) > button.submit"
+*
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_CSS_SELECTOR = "browser.css_selector";
+//#endregion
+export { ATTR_CSS_SELECTOR, ATTR_MOUSE_EVENT_BUTTON, ATTR_PAGE_X, ATTR_PAGE_Y, ATTR_TAGS, ATTR_TAG_NAME, CLICK_EVENT_NAME };
+
+//# sourceMappingURL=semconv.js.map

package/dist/user-action/semconv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semconv.js","names":[],"sources":["../../src/user-action/semconv.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n * SPDX-License-Identifier: Apache-2.0\n */\n\n/*\n * This file contains a copy of unstable semantic convention definitions\n * used by this package.\n * @see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv\n */\n\nexport const CLICK_EVENT_NAME = 'browser.user_action.click';\n\n/**\n * @example left\n *\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_MOUSE_EVENT_BUTTON = 'browser.mouse_event.button';\n\n/**\n * @example 10\n *\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_PAGE_X = 'browser.page.x';\n\n/**\n * @example 10\n *\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_PAGE_Y = 'browser.page.y';\n\n/**\n * @example \"BUTTON\"\n *\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_TAG_NAME = 'browser.tag_name';\n\n/**\n * @example {\"id\": \"123\", \"name\": \"Name\"}\n *\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_TAGS = 'browser.element.attributes';\n\n/**\n * @example \"#main > div:nth-child(2) > button.submit\"\n *\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_CSS_SELECTOR = 'browser.css_selector';\n"],"mappings":";AAWA,MAAa,mBAAmB;;;;;;AAOhC,MAAa,0BAA0B;;;;;;AAOvC,MAAa,cAAc;;;;;;AAO3B,MAAa,cAAc;;;;;;AAO3B,MAAa,gBAAgB;;;;;;AAO7B,MAAa,YAAY;;;;;;AAOzB,MAAa,oBAAoB"}

package/dist/user-action/types.d.ts

@@ -0,0 +1,13 @@
+import { InstrumentationConfig } from "@opentelemetry/instrumentation";
+
+//#region src/user-action/types.d.ts
+type AutoCapturedUserAction = 'click';
+/**
+ * UserActionInstrumentation Configuration
+ */
+interface UserActionInstrumentationConfig extends InstrumentationConfig {
+  autoCapturedActions?: AutoCapturedUserAction[];
+}
+//#endregion
+export { UserActionInstrumentationConfig };
+//# sourceMappingURL=types.d.ts.map

package/dist/web-utils/dist/getElementCSSSelector.js

@@ -0,0 +1,43 @@
+//#region ../web-utils/dist/getElementCSSSelector.js
+/**
+* Generates the CSS selector of a given element in the DOM tree.
+*
+* @example #main > div:nth-child(2) > button.submit
+* @example #unique-id
+*/
+const getElementCSSSelector = (element, { useIdForTargetElement = false, useIdForAncestors = false } = {}) => {
+	if (element.nodeType === Node.DOCUMENT_NODE) return "";
+	const htmlElement = element;
+	const nodeValue = getNodeSelector(htmlElement, useIdForTargetElement || useIdForAncestors);
+	if (nodeValue.startsWith("#")) return nodeValue;
+	const parent = htmlElement.parentElement;
+	const parentSelector = parent ? getElementCSSSelector(parent, {
+		useIdForAncestors,
+		useIdForTargetElement: false
+	}) : "";
+	return parentSelector ? `${parentSelector} > ${nodeValue}` : nodeValue;
+};
+const getNodeSelector = (element, useElementId = false) => {
+	if (element.nodeType !== Node.ELEMENT_NODE) return "";
+	const htmlElement = element;
+	const id = htmlElement.getAttribute("id");
+	if (useElementId && id) {
+		if (htmlElement.ownerDocument.querySelectorAll(`#${CSS.escape(id)}`).length === 1) return `#${CSS.escape(id)}`;
+	}
+	let selector = getFullClassSelector(htmlElement);
+	const index = getNthChild(htmlElement);
+	if (index > 0) selector += `:nth-child(${index})`;
+	return selector;
+};
+const getNthChild = (element) => {
+	if (!element.parentElement) return 0;
+	const selector = getFullClassSelector(element);
+	const siblings = Array.from(element.parentElement.children).filter((sibling) => getFullClassSelector(sibling) === selector);
+	if (siblings.length > 1) return siblings.indexOf(element) + 1;
+	return 0;
+};
+const getFullClassSelector = (element) => element.localName + (element.classList.length > 0 ? Array.from(element.classList).map((cls) => `.${CSS.escape(cls)}`).join("") : "");
+//#endregion
+export { getElementCSSSelector };
+
+//# sourceMappingURL=getElementCSSSelector.js.map

package/dist/web-utils/dist/getElementCSSSelector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getElementCSSSelector.js","names":[],"sources":["../../../../web-utils/dist/getElementCSSSelector.js"],"sourcesContent":["//#region src/getElementCSSSelector.ts\n/**\n* Generates the CSS selector of a given element in the DOM tree.\n*\n* @example #main > div:nth-child(2) > button.submit\n* @example #unique-id\n*/\nconst getElementCSSSelector = (element, { useIdForTargetElement = false, useIdForAncestors = false } = {}) => {\n\tif (element.nodeType === Node.DOCUMENT_NODE) return \"\";\n\tconst htmlElement = element;\n\tconst nodeValue = getNodeSelector(htmlElement, useIdForTargetElement || useIdForAncestors);\n\tif (nodeValue.startsWith(\"#\")) return nodeValue;\n\tconst parent = htmlElement.parentElement;\n\tconst parentSelector = parent ? getElementCSSSelector(parent, {\n\t\tuseIdForAncestors,\n\t\tuseIdForTargetElement: false\n\t}) : \"\";\n\treturn parentSelector ? `${parentSelector} > ${nodeValue}` : nodeValue;\n};\nconst getNodeSelector = (element, useElementId = false) => {\n\tif (element.nodeType !== Node.ELEMENT_NODE) return \"\";\n\tconst htmlElement = element;\n\tconst id = htmlElement.getAttribute(\"id\");\n\tif (useElementId && id) {\n\t\tif (htmlElement.ownerDocument.querySelectorAll(`#${CSS.escape(id)}`).length === 1) return `#${CSS.escape(id)}`;\n\t}\n\tlet selector = getFullClassSelector(htmlElement);\n\tconst index = getNthChild(htmlElement);\n\tif (index > 0) selector += `:nth-child(${index})`;\n\treturn selector;\n};\nconst getNthChild = (element) => {\n\tif (!element.parentElement) return 0;\n\tconst selector = getFullClassSelector(element);\n\tconst siblings = Array.from(element.parentElement.children).filter((sibling) => getFullClassSelector(sibling) === selector);\n\tif (siblings.length > 1) return siblings.indexOf(element) + 1;\n\treturn 0;\n};\nconst getFullClassSelector = (element) => element.localName + (element.classList.length > 0 ? Array.from(element.classList).map((cls) => `.${CSS.escape(cls)}`).join(\"\") : \"\");\n//#endregion\nexport { getElementCSSSelector };\n\n//# sourceMappingURL=getElementCSSSelector.js.map"],"mappings":";;;;;;;AAOA,MAAM,yBAAyB,SAAS,EAAE,wBAAwB,OAAO,oBAAoB,UAAU,EAAE,KAAK;AAC7G,KAAI,QAAQ,aAAa,KAAK,cAAe,QAAO;CACpD,MAAM,cAAc;CACpB,MAAM,YAAY,gBAAgB,aAAa,yBAAyB,kBAAkB;AAC1F,KAAI,UAAU,WAAW,IAAI,CAAE,QAAO;CACtC,MAAM,SAAS,YAAY;CAC3B,MAAM,iBAAiB,SAAS,sBAAsB,QAAQ;EAC7D;EACA,uBAAuB;EACvB,CAAC,GAAG;AACL,QAAO,iBAAiB,GAAG,eAAe,KAAK,cAAc;;AAE9D,MAAM,mBAAmB,SAAS,eAAe,UAAU;AAC1D,KAAI,QAAQ,aAAa,KAAK,aAAc,QAAO;CACnD,MAAM,cAAc;CACpB,MAAM,KAAK,YAAY,aAAa,KAAK;AACzC,KAAI,gBAAgB;MACf,YAAY,cAAc,iBAAiB,IAAI,IAAI,OAAO,GAAG,GAAG,CAAC,WAAW,EAAG,QAAO,IAAI,IAAI,OAAO,GAAG;;CAE7G,IAAI,WAAW,qBAAqB,YAAY;CAChD,MAAM,QAAQ,YAAY,YAAY;AACtC,KAAI,QAAQ,EAAG,aAAY,cAAc,MAAM;AAC/C,QAAO;;AAER,MAAM,eAAe,YAAY;AAChC,KAAI,CAAC,QAAQ,cAAe,QAAO;CACnC,MAAM,WAAW,qBAAqB,QAAQ;CAC9C,MAAM,WAAW,MAAM,KAAK,QAAQ,cAAc,SAAS,CAAC,QAAQ,YAAY,qBAAqB,QAAQ,KAAK,SAAS;AAC3H,KAAI,SAAS,SAAS,EAAG,QAAO,SAAS,QAAQ,QAAQ,GAAG;AAC5D,QAAO;;AAER,MAAM,wBAAwB,YAAY,QAAQ,aAAa,QAAQ,UAAU,SAAS,IAAI,MAAM,KAAK,QAAQ,UAAU,CAAC,KAAK,QAAQ,IAAI,IAAI,OAAO,IAAI,GAAG,CAAC,KAAK,GAAG,GAAG"}

package/dist/web-vitals/index.d.ts

@@ -0,0 +1,3 @@
+import { WebVitalsInstrumentationConfig } from "./types.js";
+import { WebVitalsInstrumentation } from "./instrumentation.js";
+export { WebVitalsInstrumentation, type WebVitalsInstrumentationConfig };

package/dist/web-vitals/index.js

@@ -0,0 +1,2 @@
+import { WebVitalsInstrumentation } from "./instrumentation.js";
+export { WebVitalsInstrumentation };

package/dist/web-vitals/instrumentation.d.ts

@@ -0,0 +1,40 @@
+import { WebVitalsInstrumentationConfig } from "./types.js";
+import { InstrumentationBase } from "@opentelemetry/instrumentation";
+
+//#region src/web-vitals/instrumentation.d.ts
+/**
+ * Instrumentation for Core Web Vitals using the `web-vitals` library.
+ * https://github.com/GoogleChrome/web-vitals
+ *
+ * Note: The `web-vitals` library does not support removing listeners once
+ * registered. Calling `disable()` will stop emitting logs, but the underlying
+ * listeners remain active. Calling `enable()` again will resume emission.
+ */
+declare class WebVitalsInstrumentation extends InstrumentationBase<WebVitalsInstrumentationConfig> {
+  private _isEnabled;
+  private _listenersRegistered;
+  private _applyCustomLogRecordData?;
+  private _includeRawAttribution;
+  constructor(config?: WebVitalsInstrumentationConfig);
+  protected init(): never[];
+  /**
+   * Enables the instrumentation and registers web-vitals listeners.
+   * Listeners are registered only once. If disabled, subsequent calls resume emission.
+   */
+  enable(): void;
+  /**
+   * Disables the instrumentation, pausing log emission.
+   * Listeners remain active due to web-vitals library limitations.
+   */
+  disable(): void;
+  /**
+   * Gets the timestamp for a metric based on attribution timing.
+   * Returns undefined to let OTel use the current time for metrics without
+   * specific timing information.
+   */
+  private _getTimestampForMetric;
+  private _emitWebVital;
+}
+//#endregion
+export { WebVitalsInstrumentation };
+//# sourceMappingURL=instrumentation.d.ts.map

package/dist/web-vitals/instrumentation.js

@@ -0,0 +1,99 @@
+import { ATTR_WEB_VITAL_DELTA, ATTR_WEB_VITAL_ID, ATTR_WEB_VITAL_NAME, ATTR_WEB_VITAL_NAVIGATION_TYPE, ATTR_WEB_VITAL_RATING, ATTR_WEB_VITAL_VALUE, WEB_VITAL_EVENT_NAME } from "./semconv.js";
+import { SeverityNumber } from "@opentelemetry/api-logs";
+import { InstrumentationBase, safeExecuteInTheMiddle } from "@opentelemetry/instrumentation";
+import { onCLS, onFCP, onINP, onLCP, onTTFB } from "web-vitals/attribution";
+//#region src/web-vitals/instrumentation.ts
+/**
+* Instrumentation for Core Web Vitals using the `web-vitals` library.
+* https://github.com/GoogleChrome/web-vitals
+*
+* Note: The `web-vitals` library does not support removing listeners once
+* registered. Calling `disable()` will stop emitting logs, but the underlying
+* listeners remain active. Calling `enable()` again will resume emission.
+*/
+var WebVitalsInstrumentation = class extends InstrumentationBase {
+	_applyCustomLogRecordData;
+	_includeRawAttribution;
+	constructor(config = {}) {
+		super("@opentelemetry/instrumentation-web-vitals", "0.1.0", config);
+		this._applyCustomLogRecordData = config.applyCustomLogRecordData;
+		this._includeRawAttribution = config.includeRawAttribution ?? false;
+	}
+	init() {
+		return [];
+	}
+	/**
+	* Enables the instrumentation and registers web-vitals listeners.
+	* Listeners are registered only once. If disabled, subsequent calls resume emission.
+	*/
+	enable() {
+		if (typeof PerformanceObserver === "undefined") {
+			this._diag.debug("PerformanceObserver not supported, web vitals will not be collected");
+			return;
+		}
+		this._isEnabled = true;
+		if (this._listenersRegistered) {
+			this._diag.debug("Listeners already registered, resuming emission");
+			return;
+		}
+		this._listenersRegistered = true;
+		this._diag.debug(`Registering listeners`);
+		onCLS((metric) => this._emitWebVital(metric));
+		onINP((metric) => this._emitWebVital(metric));
+		onLCP((metric) => this._emitWebVital(metric));
+		onFCP((metric) => this._emitWebVital(metric));
+		onTTFB((metric) => this._emitWebVital(metric));
+	}
+	/**
+	* Disables the instrumentation, pausing log emission.
+	* Listeners remain active due to web-vitals library limitations.
+	*/
+	disable() {
+		this._isEnabled = false;
+		this._diag.debug("Instrumentation disabled, pausing emission");
+	}
+	/**
+	* Gets the timestamp for a metric based on attribution timing.
+	* Returns undefined to let OTel use the current time for metrics without
+	* specific timing information.
+	*/
+	_getTimestampForMetric(metric) {
+		if (metric.name === "CLS") {
+			const { attribution } = metric;
+			if (attribution.largestShiftTime !== void 0) return attribution.largestShiftTime;
+			return;
+		}
+		if (metric.name === "INP") {
+			const { attribution } = metric;
+			return attribution.interactionTime;
+		}
+		return metric.value;
+	}
+	_emitWebVital(metric) {
+		if (!this._isEnabled) return;
+		const attributes = {
+			[ATTR_WEB_VITAL_NAME]: metric.name.toLowerCase(),
+			[ATTR_WEB_VITAL_VALUE]: metric.value,
+			[ATTR_WEB_VITAL_DELTA]: metric.delta,
+			[ATTR_WEB_VITAL_RATING]: metric.rating,
+			[ATTR_WEB_VITAL_ID]: metric.id,
+			[ATTR_WEB_VITAL_NAVIGATION_TYPE]: metric.navigationType
+		};
+		const timestamp = this._getTimestampForMetric(metric);
+		const logRecord = {
+			eventName: WEB_VITAL_EVENT_NAME,
+			severityNumber: SeverityNumber.INFO,
+			attributes,
+			...this._includeRawAttribution ? { body: JSON.stringify(metric.attribution) } : {},
+			...timestamp !== void 0 ? { timestamp } : {}
+		};
+		if (this._applyCustomLogRecordData) safeExecuteInTheMiddle(() => this._applyCustomLogRecordData?.(logRecord), (error) => {
+			if (error) this._diag.error("applyCustomLogRecordData hook failed", error);
+		}, true);
+		this.logger.emit(logRecord);
+	}
+};
+//#endregion
+export { WebVitalsInstrumentation };
+
+//# sourceMappingURL=instrumentation.js.map

package/dist/web-vitals/instrumentation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instrumentation.js","names":[],"sources":["../../src/web-vitals/instrumentation.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n * SPDX-License-Identifier: Apache-2.0\n */\n\nimport type { Attributes } from '@opentelemetry/api';\nimport type { LogRecord } from '@opentelemetry/api-logs';\nimport { SeverityNumber } from '@opentelemetry/api-logs';\nimport {\n  InstrumentationBase,\n  safeExecuteInTheMiddle,\n} from '@opentelemetry/instrumentation';\nimport type {\n  CLSMetricWithAttribution,\n  INPMetricWithAttribution,\n  MetricWithAttribution,\n} from 'web-vitals/attribution';\nimport { onCLS, onFCP, onINP, onLCP, onTTFB } from 'web-vitals/attribution';\nimport {\n  ATTR_WEB_VITAL_DELTA,\n  ATTR_WEB_VITAL_ID,\n  ATTR_WEB_VITAL_NAME,\n  ATTR_WEB_VITAL_NAVIGATION_TYPE,\n  ATTR_WEB_VITAL_RATING,\n  ATTR_WEB_VITAL_VALUE,\n  WEB_VITAL_EVENT_NAME,\n} from './semconv.ts';\nimport type { WebVitalsInstrumentationConfig } from './types.ts';\n\n/**\n * Instrumentation for Core Web Vitals using the `web-vitals` library.\n * https://github.com/GoogleChrome/web-vitals\n *\n * Note: The `web-vitals` library does not support removing listeners once\n * registered. Calling `disable()` will stop emitting logs, but the underlying\n * listeners remain active. Calling `enable()` again will resume emission.\n */\nexport class WebVitalsInstrumentation extends InstrumentationBase<WebVitalsInstrumentationConfig> {\n  // Using `declare` is required here: InstrumentationBase calls enable() during\n  // construction, and standard field initialization would reset this flag after\n  // super() returns, breaking the duplicate-registration guard.\n  private declare _isEnabled: boolean;\n  private declare _listenersRegistered: boolean;\n  private _applyCustomLogRecordData?: (logRecord: LogRecord) => void;\n  private _includeRawAttribution: boolean;\n\n  constructor(config: WebVitalsInstrumentationConfig = {}) {\n    super('@opentelemetry/instrumentation-web-vitals', '0.1.0', config);\n    this._applyCustomLogRecordData = config.applyCustomLogRecordData;\n    this._includeRawAttribution = config.includeRawAttribution ?? false;\n  }\n\n  protected override init() {\n    return [];\n  }\n\n  /**\n   * Enables the instrumentation and registers web-vitals listeners.\n   * Listeners are registered only once. If disabled, subsequent calls resume emission.\n   */\n  override enable(): void {\n    if (typeof PerformanceObserver === 'undefined') {\n      this._diag.debug(\n        'PerformanceObserver not supported, web vitals will not be collected',\n      );\n      return;\n    }\n\n    this._isEnabled = true;\n\n    if (this._listenersRegistered) {\n      this._diag.debug('Listeners already registered, resuming emission');\n      return;\n    }\n\n    this._listenersRegistered = true;\n    this._diag.debug(`Registering listeners`);\n    // CLS is only supported in Chromium. See:\n    // https://github.com/GoogleChrome/web-vitals?tab=readme-ov-file#browser-support\n    onCLS((metric) => this._emitWebVital(metric));\n    onINP((metric) => this._emitWebVital(metric));\n    onLCP((metric) => this._emitWebVital(metric));\n    onFCP((metric) => this._emitWebVital(metric));\n    onTTFB((metric) => this._emitWebVital(metric));\n  }\n\n  /**\n   * Disables the instrumentation, pausing log emission.\n   * Listeners remain active due to web-vitals library limitations.\n   */\n  override disable(): void {\n    this._isEnabled = false;\n    this._diag.debug('Instrumentation disabled, pausing emission');\n  }\n\n  /**\n   * Gets the timestamp for a metric based on attribution timing.\n   * Returns undefined to let OTel use the current time for metrics without\n   * specific timing information.\n   */\n  private _getTimestampForMetric(\n    metric: MetricWithAttribution,\n  ): number | undefined {\n    if (metric.name === 'CLS') {\n      const { attribution } = metric as CLSMetricWithAttribution;\n      if (attribution.largestShiftTime !== undefined) {\n        return attribution.largestShiftTime;\n      }\n      return undefined;\n    }\n    if (metric.name === 'INP') {\n      const { attribution } = metric as INPMetricWithAttribution;\n      return attribution.interactionTime;\n    }\n    // FCP, LCP, TTFB: metric.value is already DOMHighResTimeStamp of the event\n    return metric.value;\n  }\n\n  private _emitWebVital(metric: MetricWithAttribution): void {\n    if (!this._isEnabled) {\n      return;\n    }\n    const attributes: Attributes = {\n      [ATTR_WEB_VITAL_NAME]: metric.name.toLowerCase(),\n      [ATTR_WEB_VITAL_VALUE]: metric.value,\n      // `delta` equals `value` on the first emission; subsequent emissions report only the change\n      [ATTR_WEB_VITAL_DELTA]: metric.delta,\n      [ATTR_WEB_VITAL_RATING]: metric.rating,\n      [ATTR_WEB_VITAL_ID]: metric.id,\n      [ATTR_WEB_VITAL_NAVIGATION_TYPE]: metric.navigationType,\n    };\n\n    const timestamp = this._getTimestampForMetric(metric);\n\n    const logRecord: LogRecord = {\n      eventName: WEB_VITAL_EVENT_NAME,\n      severityNumber: SeverityNumber.INFO,\n      attributes,\n      ...(this._includeRawAttribution\n        ? { body: JSON.stringify(metric.attribution) }\n        : {}),\n      ...(timestamp !== undefined ? { timestamp } : {}),\n    };\n\n    if (this._applyCustomLogRecordData) {\n      safeExecuteInTheMiddle(\n        () => this._applyCustomLogRecordData?.(logRecord),\n        (error) => {\n          if (error) {\n            this._diag.error('applyCustomLogRecordData hook failed', error);\n          }\n        },\n        true,\n      );\n    }\n\n    this.logger.emit(logRecord);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAqCA,IAAa,2BAAb,cAA8C,oBAAoD;CAMhG;CACA;CAEA,YAAY,SAAyC,EAAE,EAAE;AACvD,QAAM,6CAA6C,SAAS,OAAO;AACnE,OAAK,4BAA4B,OAAO;AACxC,OAAK,yBAAyB,OAAO,yBAAyB;;CAGhE,OAA0B;AACxB,SAAO,EAAE;;;;;;CAOX,SAAwB;AACtB,MAAI,OAAO,wBAAwB,aAAa;AAC9C,QAAK,MAAM,MACT,sEACD;AACD;;AAGF,OAAK,aAAa;AAElB,MAAI,KAAK,sBAAsB;AAC7B,QAAK,MAAM,MAAM,kDAAkD;AACnE;;AAGF,OAAK,uBAAuB;AAC5B,OAAK,MAAM,MAAM,wBAAwB;AAGzC,SAAO,WAAW,KAAK,cAAc,OAAO,CAAC;AAC7C,SAAO,WAAW,KAAK,cAAc,OAAO,CAAC;AAC7C,SAAO,WAAW,KAAK,cAAc,OAAO,CAAC;AAC7C,SAAO,WAAW,KAAK,cAAc,OAAO,CAAC;AAC7C,UAAQ,WAAW,KAAK,cAAc,OAAO,CAAC;;;;;;CAOhD,UAAyB;AACvB,OAAK,aAAa;AAClB,OAAK,MAAM,MAAM,6CAA6C;;;;;;;CAQhE,uBACE,QACoB;AACpB,MAAI,OAAO,SAAS,OAAO;GACzB,MAAM,EAAE,gBAAgB;AACxB,OAAI,YAAY,qBAAqB,KAAA,EACnC,QAAO,YAAY;AAErB;;AAEF,MAAI,OAAO,SAAS,OAAO;GACzB,MAAM,EAAE,gBAAgB;AACxB,UAAO,YAAY;;AAGrB,SAAO,OAAO;;CAGhB,cAAsB,QAAqC;AACzD,MAAI,CAAC,KAAK,WACR;EAEF,MAAM,aAAyB;IAC5B,sBAAsB,OAAO,KAAK,aAAa;IAC/C,uBAAuB,OAAO;IAE9B,uBAAuB,OAAO;IAC9B,wBAAwB,OAAO;IAC/B,oBAAoB,OAAO;IAC3B,iCAAiC,OAAO;GAC1C;EAED,MAAM,YAAY,KAAK,uBAAuB,OAAO;EAErD,MAAM,YAAuB;GAC3B,WAAW;GACX,gBAAgB,eAAe;GAC/B;GACA,GAAI,KAAK,yBACL,EAAE,MAAM,KAAK,UAAU,OAAO,YAAY,EAAE,GAC5C,EAAE;GACN,GAAI,cAAc,KAAA,IAAY,EAAE,WAAW,GAAG,EAAE;GACjD;AAED,MAAI,KAAK,0BACP,8BACQ,KAAK,4BAA4B,UAAU,GAChD,UAAU;AACT,OAAI,MACF,MAAK,MAAM,MAAM,wCAAwC,MAAM;KAGnE,KACD;AAGH,OAAK,OAAO,KAAK,UAAU"}

package/dist/web-vitals/semconv.js

@@ -0,0 +1,30 @@
+//#region src/web-vitals/semconv.ts
+const WEB_VITAL_EVENT_NAME = "browser.web_vital";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_WEB_VITAL_NAME = "browser.web_vital.name";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_WEB_VITAL_VALUE = "browser.web_vital.value";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_WEB_VITAL_RATING = "browser.web_vital.rating";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_WEB_VITAL_DELTA = "browser.web_vital.delta";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_WEB_VITAL_ID = "browser.web_vital.id";
+/**
+* @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.
+*/
+const ATTR_WEB_VITAL_NAVIGATION_TYPE = "browser.web_vital.navigation_type";
+//#endregion
+export { ATTR_WEB_VITAL_DELTA, ATTR_WEB_VITAL_ID, ATTR_WEB_VITAL_NAME, ATTR_WEB_VITAL_NAVIGATION_TYPE, ATTR_WEB_VITAL_RATING, ATTR_WEB_VITAL_VALUE, WEB_VITAL_EVENT_NAME };
+
+//# sourceMappingURL=semconv.js.map

package/dist/web-vitals/semconv.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semconv.js","names":[],"sources":["../../src/web-vitals/semconv.ts"],"sourcesContent":["/*\n * Copyright The OpenTelemetry Authors\n * SPDX-License-Identifier: Apache-2.0\n */\n\n/*\n * This file contains a copy of unstable semantic convention definitions\n * used by this package.\n * @see https://github.com/open-telemetry/opentelemetry-js/tree/main/semantic-conventions#unstable-semconv\n */\n\nexport const WEB_VITAL_EVENT_NAME = 'browser.web_vital';\n\n// Core metric attributes\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_WEB_VITAL_NAME = 'browser.web_vital.name';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_WEB_VITAL_VALUE = 'browser.web_vital.value';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_WEB_VITAL_RATING = 'browser.web_vital.rating';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_WEB_VITAL_DELTA = 'browser.web_vital.delta';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_WEB_VITAL_ID = 'browser.web_vital.id';\n\n/**\n * @experimental This attribute is experimental and is subject to breaking changes in minor releases of `@opentelemetry/semantic-conventions`.\n */\nexport const ATTR_WEB_VITAL_NAVIGATION_TYPE =\n  'browser.web_vital.navigation_type';\n"],"mappings":";AAWA,MAAa,uBAAuB;;;;AAOpC,MAAa,sBAAsB;;;;AAKnC,MAAa,uBAAuB;;;;AAKpC,MAAa,wBAAwB;;;;AAKrC,MAAa,uBAAuB;;;;AAKpC,MAAa,oBAAoB;;;;AAKjC,MAAa,iCACX"}

package/dist/web-vitals/types.d.ts

@@ -0,0 +1,26 @@
+import { LogRecord } from "@opentelemetry/api-logs";
+import { InstrumentationConfig } from "@opentelemetry/instrumentation";
+
+//#region src/web-vitals/types.d.ts
+/**
+ * WebVitalsInstrumentation Configuration
+ */
+interface WebVitalsInstrumentationConfig extends InstrumentationConfig {
+  /**
+   * @experimental
+   * When true, sets the log record body to the JSON-stringified
+   * `web-vitals` attribution object for the metric.
+   *
+   * Note: `applyCustomLogRecordData` runs after the body is set.
+   * If the hook assigns a new `body`, it will overwrite the attribution data.
+   */
+  includeRawAttribution?: boolean;
+  /**
+   * Hook to modify log records before they are emitted.
+   * Use this to add custom attributes or modify the log record.
+   */
+  applyCustomLogRecordData?: (logRecord: LogRecord) => void;
+}
+//#endregion
+export { WebVitalsInstrumentationConfig };
+//# sourceMappingURL=types.d.ts.map

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@opentelemetry/browser-instrumentation",
+  "version": "0.1.0",
+  "description": "OpenTelemetry browser instrumentations.",
+  "keywords": [
+    "opentelemetry",
+    "browser",
+    "web",
+    "instrumentation",
+    "navigation-timing",
+    "user-action",
+    "web-vitals"
+  ],
+  "homepage": "https://github.com/open-telemetry/opentelemetry-browser",
+  "bugs": "https://github.com/open-telemetry/opentelemetry-browser/issues",
+  "license": "Apache-2.0",
+  "author": "OpenTelemetry Authors",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/open-telemetry/opentelemetry-browser.git",
+    "directory": "packages/instrumentation"
+  },
+  "type": "module",
+  "exports": {
+    "./experimental/navigation-timing": "./dist/navigation-timing/index.js",
+    "./experimental/user-action": "./dist/user-action/index.js",
+    "./experimental/web-vitals": "./dist/web-vitals/index.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsdown",
+    "watch": "tsdown --watch --no-clean",
+    "check-types": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest --coverage"
+  },
+  "dependencies": {
+    "@opentelemetry/api-logs": "^0.213.0",
+    "@opentelemetry/instrumentation": "^0.213.0",
+    "web-vitals": "^5.1.0"
+  },
+  "peerDependencies": {
+    "@opentelemetry/api": "^1.9.0"
+  },
+  "devDependencies": {
+    "@opentelemetry/test-utils": "*",
+    "@opentelemetry/web-utils": "*"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}