@dash0/sdk-web 0.13.4 → 0.14.0

package/src/types/otlp.ts

@@ -0,0 +1,121 @@
+import { LOG_SEVERITY_NUMBER, LOG_SEVERITY_TEXT } from "../semantic-conventions";
+
+export type AnyValue = {
+  ["stringValue"]?: string;
+  ["boolValue"]?: boolean;
+  /** Format: int64 */
+  ["intValue"]?: string;
+  /** Format: double */
+  ["doubleValue"]?: number;
+  ["arrayValue"]?: ArrayValue;
+  ["kvlistValue"]?: KeyValueList;
+  /** Format: byte */
+  ["bytesValue"]?: string;
+};
+
+export type ArrayValue = {
+  ["values"]: AnyValue[];
+};
+
+export type KeyValue = {
+  ["key"]: string;
+  ["value"]: AnyValue;
+};
+
+export type KeyValueList = {
+  ["values"]: KeyValue[];
+};
+
+export type Resource = {
+  ["attributes"]: KeyValue[];
+};
+
+export type InstrumentationScope = {
+  ["name"]?: string;
+  ["version"]?: string;
+  ["attributes"]: KeyValue[];
+};
+
+export type ExportLogsServiceRequest = {
+  resourceLogs: ResourceLogs[];
+};
+
+export type ResourceLogs = {
+  resource: Resource;
+  scopeLogs: ScopeLogs[];
+};
+
+export type ScopeLogs = {
+  scope?: InstrumentationScope;
+  logRecords: LogRecord[];
+  schemaUrl?: string;
+};
+
+export type LogRecord = {
+  /** Format: uint64 */
+  timeUnixNano: string;
+  severityNumber?: LOG_SEVERITY_NUMBER;
+  severityText?: LOG_SEVERITY_TEXT;
+  body?: AnyValue;
+  attributes: KeyValue[];
+  /** Format: byte */
+  traceId?: string;
+  /** Format: byte */
+  spanId?: string;
+};
+
+export type ExportTraceServiceRequest = {
+  resourceSpans: ResourceSpans[];
+};
+
+export type ResourceSpans = {
+  resource: Resource;
+  scopeSpans: ScopeSpans[];
+};
+
+export type ScopeSpans = {
+  scope?: InstrumentationScope;
+  spans: Span[];
+};
+
+export type SpanStatus = {
+  message?: string;
+  code: 0 | 1 | 2;
+};
+
+export type SpanEvent = {
+  timeUnixNano: string;
+  name: string;
+  attributes: KeyValue[];
+};
+
+export type SpanLink = {
+  /** Format: byte */
+  traceId: string;
+  /** Format: byte */
+  spanId: string;
+  traceState?: string;
+  attributes: KeyValue[];
+  droppedAttributesCount: number;
+  flags?: number;
+};
+
+export type Span = {
+  /** Format: byte */
+  traceId: string;
+  /** Format: byte */
+  spanId: string;
+  traceState?: string;
+  /** Format: byte */
+  parentSpanId?: string;
+  name: string;
+  kind: number;
+  startTimeUnixNano: string;
+  endTimeUnixNano: string;
+  attributes: KeyValue[];
+  events: SpanEvent[];
+  /** Format: int64 */
+  droppedEventsCount?: number;
+  links: SpanLink[];
+  status: SpanStatus;
+};

package/src/utils/fn.ts

@@ -1,3 +1,7 @@
 export function noop() {
   // This function is intentionally empty.
 }
+
+export function identity<T>(a: T) {
+  return a;
+}

package/src/utils/otel/attributes.ts

@@ -1,4 +1,4 @@
-import { AnyValue, KeyValue } from "../../../types/otlp";
+import { AnyValue, KeyValue } from "../../types/otlp";
 
 type PrimitiveAttributeValue = string | number | boolean;
 export type AttributeValueType =

package/src/utils/otel/attributes_test.ts

@@ -1,6 +1,6 @@
 import { expect, describe, it } from "vitest";
 import { addAttribute, toAnyValue } from "./attributes";
-import { AnyValue, KeyValue } from "../../../types/otlp";
+import { AnyValue, KeyValue } from "../../types/otlp";
 
 describe("toAnyValue", () => {
   describe("primitive values", () => {

package/src/utils/otel/error.ts

@@ -1,5 +1,4 @@
 import { addSpanEvent, InProgressSpan } from "./span";
-import { KeyValue, SpanStatus } from "../../../types/otlp";
 import { addAttribute } from "./attributes";
 import {
   SPAN_EVENT_NAME_EXCEPTION,
@@ -8,6 +7,7 @@ import {
   EXCEPTION_TYPE,
   SPAN_STATUS_ERROR,
 } from "../../semantic-conventions";
+import { KeyValue, SpanStatus } from "../../types/otlp";
 
 interface ExceptionWithCode {
   code: string | number;

package/src/utils/otel/span.ts

@@ -1,10 +1,10 @@
-import { KeyValue, Span, SpanStatus } from "../../../types/otlp";
 import { nowNanos } from "../time";
 import { SPAN_KIND_CLIENT, SPAN_STATUS_UNSET, WEB_EVENT_ID } from "../../semantic-conventions";
 import { sessionId } from "../../api/session";
 import { generateTraceId } from "../trace-id";
 import { generateSpanId } from "../span-id";
 import { addAttribute } from "./attributes";
+import { KeyValue, Span, SpanStatus } from "../../types/otlp";
 
 export type InProgressSpan = Omit<Span, "endTimeUnixNano">;
 

package/src/vars.ts

@@ -1,7 +1,7 @@
-// TODO use OTel types here?
-
-import { AnyValue, InstrumentationScope, KeyValue, Resource } from "../types/otlp";
 import { AttributeValueType } from "./utils/otel";
+import { AnyValue, InstrumentationScope, KeyValue, Resource } from "./types/otlp";
+import { UrlAttributeScrubber } from "./attributes";
+import { identity } from "./utils";
 
 export type Endpoint = {
   /**
@@ -140,6 +140,16 @@ export type Vars = {
    */
   headersToCapture: RegExp[];
 
+  /**
+   * Allows the application of a custom scrubbing function to url attributes before they are applied to signals.
+   * This is invoked for each url processed for inclusion in signal attributes. For example this applies both to `page.url.*`
+   * and `url.*` attribute namespaces.
+   * Sensitive parts of the url attributes should be replaced with `REDACTED`,
+   * avoid partially or fully dropping attributes to preserve telemetry quality.
+   * Note: basic auth credentials in urls are automatically redacted before this is invoked.
+   */
+  urlAttributeScrubber: UrlAttributeScrubber;
+
   pageViewInstrumentation: PageViewInstrumentationSettings;
 };
 
@@ -162,6 +172,7 @@ export const vars: Vars = {
   maxWaitForResourceTimingsMillis: 10000,
   maxToleranceForResourceTimingsMillis: 50,
   headersToCapture: [],
+  urlAttributeScrubber: identity,
   pageViewInstrumentation: {
     trackVirtualPageViews: true,
     includeParts: [],