@dash0/sdk-web 0.13.3 → 0.13.4

package/src/attributes/common.ts

@@ -3,6 +3,7 @@ import { generateUniqueId, nav, NO_VALUE_FALLBACK, WEB_EVENT_ID_BYTES, win } fro
 import {
   BROWSER_TAB_ID,
   NETWORK_CONNECTION_TYPE,
+  PAGE_URL_ATTR_PREFIX,
   SESSION_ID,
   WEB_EVENT_ID,
   WINDOW_HEIGHT,
@@ -15,6 +16,9 @@ import { addUrlAttributes } from "./url";
 import { tabId } from "../utils/tab-id";
 
 type Options = {
+  /**
+   * Override url to be used instead of window.location.href
+   */
   url?: string | URL;
 };
 
@@ -27,7 +31,7 @@ export function addCommonAttributes(attributes: KeyValue[], options?: Options):
     attributes.push(vars.signalAttributes[i]!);
   }
 
-  addUrlAttributes(attributes, options?.url ?? win?.location.href ?? NO_VALUE_FALLBACK);
+  addUrlAttributes(attributes, options?.url ?? win?.location.href ?? NO_VALUE_FALLBACK, PAGE_URL_ATTR_PREFIX);
 
   if (sessionId) {
     addAttribute(attributes, SESSION_ID, sessionId);

package/src/attributes/url.ts

@@ -1,25 +1,27 @@
 import { KeyValue } from "../../types/otlp";
-import { addAttribute } from "../utils/otel";
+import { addAttribute, AttrPrefix, withPrefix } from "../utils/otel";
 import { URL_DOMAIN, URL_FRAGMENT, URL_FULL, URL_PATH, URL_QUERY, URL_SCHEME } from "../semantic-conventions";
-import { parseUrl } from "../utils/url";
+import { parseUrl } from "../utils";
+
+export function addUrlAttributes(attributes: KeyValue[], url: string | URL, prefix?: AttrPrefix) {
+  const applyPrefix = withPrefix(prefix);
 
-export function addUrlAttributes(attributes: KeyValue[], url: string | URL) {
   try {
     const parsed = parseUrl(url);
     if (parsed.username) parsed.username = "REDACTED";
     if (parsed.password) parsed.password = "REDACTED";
 
-    addAttribute(attributes, URL_FULL, parsed.href);
-    addAttribute(attributes, URL_PATH, parsed.pathname);
-    addAttribute(attributes, URL_DOMAIN, parsed.hostname);
-    addAttribute(attributes, URL_SCHEME, parsed.protocol.replace(":", ""));
+    addAttribute(attributes, applyPrefix(URL_FULL), parsed.href);
+    addAttribute(attributes, applyPrefix(URL_PATH), parsed.pathname);
+    addAttribute(attributes, applyPrefix(URL_DOMAIN), parsed.hostname);
+    addAttribute(attributes, applyPrefix(URL_SCHEME), parsed.protocol.replace(":", ""));
     if (parsed.hash) {
-      addAttribute(attributes, URL_FRAGMENT, parsed.hash.replace("#", ""));
+      addAttribute(attributes, applyPrefix(URL_FRAGMENT), parsed.hash.replace("#", ""));
     }
     if (parsed.search) {
-      addAttribute(attributes, URL_QUERY, parsed.search.replace("?", ""));
+      addAttribute(attributes, applyPrefix(URL_QUERY), parsed.search.replace("?", ""));
     }
   } catch (_e) {
-    addAttribute(attributes, URL_FULL, String(url));
+    addAttribute(attributes, applyPrefix(URL_FULL), String(url));
   }
 }

package/src/instrumentations/http/fetch.ts

@@ -24,7 +24,7 @@ import { vars } from "../../vars";
 import { httpRequestHeaderKey, httpResponseHeaderKey } from "../../utils/otel/http";
 import { sendSpan } from "../../transport";
 import { addResourceNetworkEvents, addResourceSize, HTTP_METHOD_OTHER, isWellKnownHttpMethod } from "./utils";
-import { addCommonAttributes } from "../../attributes";
+import { addCommonAttributes, addUrlAttributes } from "../../attributes";
 
 export function instrumentFetch() {
   if (!win || !win.fetch || !win.Request) {
@@ -64,8 +64,8 @@ function wrapFetch(original: typeof fetch) {
     const method = isWellKnownMethodMatchingLeniently ? originalMethod.toUpperCase() : HTTP_METHOD_OTHER;
 
     const span = startSpan(`HTTP ${method}`);
-    // The url namespace of a http span has a different meaning than for common rum signals.
-    addCommonAttributes(span.attributes, { url });
+    addCommonAttributes(span.attributes);
+    addUrlAttributes(span.attributes, url);
     addGraphQlProperties(input, init, span);
     addAttribute(span.attributes, HTTP_REQUEST_METHOD, method);
     if (!isWellKnownMethod) {

package/src/semantic-conventions.ts

@@ -35,6 +35,7 @@ export const EXCEPTION_STACKTRACE = "exception.stacktrace";
 export const ERROR_TYPE = "error.type";
 
 // URL Attribute Keys
+export const PAGE_URL_ATTR_PREFIX = "page";
 export const URL_DOMAIN = "url.domain";
 export const URL_FRAGMENT = "url.fragment";
 export const URL_FULL = "url.full";

package/src/utils/otel/attributes.ts

@@ -67,3 +67,14 @@ export function removeAttribute(attributes: KeyValue[], key: string) {
     attributes.splice(index, 1);
   }
 }
+
+export type AttrPrefix = string | string[];
+export function withPrefix(prefix?: AttrPrefix): (attr: string) => string {
+  if (!prefix) return (attr) => attr;
+
+  if (Array.isArray(prefix)) {
+    return (attr) => [...prefix, attr].join(".");
+  }
+
+  return (attr) => `${prefix}.${attr}`;
+}