address bugs in the observability sdks (#76)

Vadman97 · web-flow · commit 5fdfabafd9e7 · 2025-06-06T18:16:17.000Z
## Summary

* update readmes to update early access preview progress
* gracefully handle broken url for LDRecord.getSession
* add user agent and navigator language on trace attributes
* update flag span event names to follow feature_flag.evaluation
convention
* fix internal version reporting
* enable session replay in webdriver navigators
* guard reportError call with non-error
* add version reporting for @launchdarkly/observability

## How did you test this change?

local react-router app

## Are there any deployment considerations?

changesets

## Does this work require review from our design team?

no
diff --git a/.changeset/eighty-hats-switch.md b/.changeset/eighty-hats-switch.md
@@ -0,0 +1,5 @@
+---
+'@launchdarkly/observability': patch
+---
+
+75983c01e66ee0f3fda29f7ab4a78254d11013a0
diff --git a/.changeset/plain-lands-cross.md b/.changeset/plain-lands-cross.md
@@ -0,0 +1,6 @@
+---
+'@launchdarkly/session-replay': patch
+'@launchdarkly/observability': patch
+---
+
+update readmes to update early access preview progress
diff --git a/.changeset/silent-maps-sort.md b/.changeset/silent-maps-sort.md
@@ -0,0 +1,5 @@
+---
+'@launchdarkly/session-replay': patch
+---
+
+gracefully handle broken url for LDRecord.getSession
diff --git a/.changeset/smooth-nails-begin.md b/.changeset/smooth-nails-begin.md
@@ -0,0 +1,6 @@
+---
+'@launchdarkly/observability': patch
+'highlight.run': patch
+---
+
+add user agent and navigator language on trace attributes
diff --git a/.changeset/soft-jeans-yawn.md b/.changeset/soft-jeans-yawn.md
@@ -0,0 +1,6 @@
+---
+'@launchdarkly/observability': patch
+'highlight.run': patch
+---
+
+update flag span event names to follow feature_flag.evaluation convention
diff --git a/.changeset/tasty-books-repeat.md b/.changeset/tasty-books-repeat.md
@@ -0,0 +1,5 @@
+---
+'highlight.run': patch
+---
+
+fix internal version reporting
diff --git a/.changeset/thirty-chicken-win.md b/.changeset/thirty-chicken-win.md
@@ -0,0 +1,5 @@
+---
+'@launchdarkly/observability': patch
+---
+
+add version reporting for @launchdarkly/observability
diff --git a/.changeset/true-facts-show.md b/.changeset/true-facts-show.md
@@ -0,0 +1,5 @@
+---
+'@launchdarkly/session-replay': patch
+---
+
+enable session replay in webdriver navigators
diff --git a/sdk/@launchdarkly/observability/README.md b/sdk/@launchdarkly/observability/README.md
@@ -5,12 +5,10 @@
 [![NPM][o11y-sdk-dm-badge]][o11y-sdk-npm-link]
 [![NPM][o11y-sdk-dt-badge]][o11y-sdk-npm-link]
 
-# ⛔️⛔️⛔️⛔️
+# Early Access Preview️
 
 > [!CAUTION]
-> This library is a alpha version and should not be considered ready for production use while this message is visible.
-
-# ☝️☝️☝️☝️☝️☝️
+> This library is in Early Access Preview and APIs are subject to change until a 1.x version is released.
 
 ## Install
 
diff --git a/sdk/@launchdarkly/session-replay/README.md b/sdk/@launchdarkly/session-replay/README.md
@@ -5,12 +5,10 @@
 [![NPM][o11y-sdk-dm-badge]][o11y-sdk-npm-link]
 [![NPM][o11y-sdk-dt-badge]][o11y-sdk-npm-link]
 
-# ⛔️⛔️⛔️⛔️
+# Early Access Preview️
 
 > [!CAUTION]
-> This library is a alpha version and should not be considered ready for production use while this message is visible.
-
-# ☝️☝️☝️☝️☝️☝️
+> This library is in Early Access Preview and APIs are subject to change until a 1.x version is released.
 
 ## Install
 
diff --git a/sdk/highlight-run/package.json b/sdk/highlight-run/package.json
@@ -102,7 +102,6 @@
 		"@opentelemetry/sdk-trace-web": "^1.30.1",
 		"@opentelemetry/semantic-conventions": "^1.28.0",
 		"@rollup/plugin-commonjs": "^25.0.7",
-		"@rollup/plugin-json": "^6.1.0",
 		"@rollup/plugin-node-resolve": "^15.2.3",
 		"@rrweb/rrweb-plugin-sequential-id-record": "workspace:*",
 		"@rrweb/types": "workspace:*",
diff --git a/sdk/highlight-run/src/__generated/version.ts b/sdk/highlight-run/src/__generated/version.ts
diff --git a/sdk/highlight-run/src/api/observe.ts b/sdk/highlight-run/src/api/observe.ts
@@ -138,7 +138,7 @@ export interface Observe {
 	 * @see {@link https://docs.highlight.run/grouping-errors} for more information.
 	 */
 	recordError: (
-		error: Error,
+		error: any,
 		message?: string,
 		payload?: { [key: string]: string },
 		source?: string,
diff --git a/sdk/highlight-run/src/client/constants/sessions.ts b/sdk/highlight-run/src/client/constants/sessions.ts
@@ -42,7 +42,7 @@ export const VISIBILITY_DEBOUNCE_MS = 100
 export const UPLOAD_TIMEOUT = 1000 * 15
 
 export const HIGHLIGHT_URL = 'app.highlight.io'
-export const LAUNCHDARKLY_URL = 'app.launchdarkly.com'
+export const LAUNCHDARKLY_URL = 'https://app.launchdarkly.com'
 export const LAUNCHDARKLY_ENV_APPS = {
 	'observability.ld-stg.launchdarkly.com': 'ld-stg.launchdarkly.com',
 	'observability.app.launchdarkly.com': 'app.launchdarkly.com',
diff --git a/sdk/highlight-run/src/client/otel/index.ts b/sdk/highlight-run/src/client/otel/index.ts
@@ -19,9 +19,9 @@ import {
 	PropagateTraceHeaderCorsUrls,
 	ReadableSpan,
 	SimpleSpanProcessor,
+	Span as SDKSpan,
 	StackContextManager,
 	WebTracerProvider,
-	Span as SDKSpan,
 } from '@opentelemetry/sdk-trace-web'
 import * as SemanticAttributes from '@opentelemetry/semantic-conventions'
 import { parse } from 'graphql'
@@ -54,6 +54,7 @@ import {
 } from '@opentelemetry/sdk-metrics'
 import { IntegrationClient } from '../../integrations'
 import { LD_METRIC_NAME_DOCUMENT_LOAD } from '../../integrations/launchdarkly'
+import version from '../../version'
 
 import { ExportSampler } from './sampling/ExportSampler'
 import { getPersistentSessionSecureID } from '../utils/sessionStorage/highlightSession'
@@ -134,12 +135,17 @@ export const setupBrowserTracing = (
 	const resource = new Resource({
 		[SemanticAttributes.ATTR_SERVICE_NAME]:
 			config.serviceName ?? 'highlight-browser',
-		[SemanticAttributes.SEMRESATTRS_DEPLOYMENT_ENVIRONMENT]: environment,
+		'deployment.environment.name': environment,
 		'highlight.project_id': config.projectId,
+		[SemanticAttributes.ATTR_USER_AGENT_ORIGINAL]: navigator.userAgent,
+		'browser.language': navigator.language,
+		'telemetry.distro.name': '@highlight-run/observability',
+		'telemetry.distro.version': version,
 	})
 
 	providers.tracerProvider = new WebTracerProvider({
 		resource,
+		mergeResourceWithDefaults: true,
 		spanProcessors: isDebug
 			? [
 					new SimpleSpanProcessor(new ConsoleSpanExporter()),
diff --git a/sdk/highlight-run/src/index.tsx b/sdk/highlight-run/src/index.tsx
@@ -38,7 +38,7 @@ import {
 } from './client/utils/sessionStorage/highlightSession.js'
 import { setCookieWriteEnabled } from './client/utils/storage'
 import { Attributes, Context, Span, SpanOptions } from '@opentelemetry/api'
-import firstloadVersion from './__generated/version.js'
+import version from './version.js'
 import { listenToChromeExtensionMessage } from './browserExtension/extensionListener.js'
 import configureElectronHighlight from './environments/electron.js'
 import { HighlightSegmentMiddleware } from './integrations/segment.js'
@@ -137,7 +137,7 @@ const H: HighlightPublicInterface = {
 			const client_options: HighlightClassOptions = {
 				...options,
 				organizationID: projectID,
-				firstloadVersion,
+				firstloadVersion: version,
 				environment: options?.environment || 'production',
 				appVersion: options?.version,
 				sessionSecureID,
diff --git a/sdk/highlight-run/src/integrations/launchdarkly/index.ts b/sdk/highlight-run/src/integrations/launchdarkly/index.ts
@@ -22,6 +22,7 @@ export type { Hook, LDClient }
 export const FEATURE_FLAG_SCOPE = 'feature_flag'
 export const LD_SCOPE = 'launchdarkly'
 export const FEATURE_FLAG_SPAN_NAME = 'evaluation'
+export const FEATURE_FLAG_EVENT_NAME = `${FEATURE_FLAG_SCOPE}.${FEATURE_FLAG_SPAN_NAME}`
 
 export const FEATURE_FLAG_ENV_ATTR = `${FEATURE_FLAG_SCOPE}.set.id`
 export const FEATURE_FLAG_KEY_ATTR = `${FEATURE_FLAG_SCOPE}.key`
@@ -159,7 +160,7 @@ export function setupLaunchDarklyIntegration(
 
 			hClient.startSpan(FEATURE_FLAG_SPAN_NAME, (s) => {
 				if (s) {
-					s.addEvent(FEATURE_FLAG_SCOPE, eventAttributes)
+					s.addEvent(FEATURE_FLAG_EVENT_NAME, eventAttributes)
 				}
 			})
 
diff --git a/sdk/highlight-run/src/plugins/record.ts b/sdk/highlight-run/src/plugins/record.ts
@@ -7,7 +7,7 @@ import {
 	LDClient,
 } from '../integrations/launchdarkly'
 import { RecordSDK } from '../sdk/record'
-import firstloadVersion from '../__generated/version'
+import firstloadVersion from '../version'
 import { setupMixpanelIntegration } from '../integrations/mixpanel'
 import { setupAmplitudeIntegration } from '../integrations/amplitude'
 import { LDRecord } from '../sdk/LDRecord'
diff --git a/sdk/highlight-run/src/sdk/observe.ts b/sdk/highlight-run/src/sdk/observe.ts
@@ -145,13 +145,13 @@ export class ObserveSDK implements Observe {
 	}
 
 	recordError(
-		error: Error,
+		error: any,
 		message?: string,
 		payload?: { [key: string]: string },
 		source?: string,
 		type?: ErrorMessageType,
 	) {
-		if (error.cause) {
+		if (error instanceof Error && error.cause) {
 			payload = {
 				...payload,
 				'exception.cause': JSON.stringify(error.cause),
diff --git a/sdk/highlight-run/src/sdk/record.ts b/sdk/highlight-run/src/sdk/record.ts
@@ -344,7 +344,9 @@ export class RecordSDK implements Record {
 
 	identify(user_identifier: string, user_object = {}, source?: Source) {
 		if (!user_identifier || user_identifier === '') {
-			console.warn(
+			internalLog(
+				'identify',
+				'warn',
 				`Highlight's identify() call was passed an empty identifier.`,
 				{ user_identifier, user_object },
 			)
@@ -393,7 +395,6 @@ export class RecordSDK implements Record {
 
 	async start(options?: StartOptions) {
 		if (
-			(navigator?.webdriver && !window.Cypress) ||
 			navigator?.userAgent?.includes('Googlebot') ||
 			navigator?.userAgent?.includes('AdsBot')
 		) {
@@ -1149,8 +1150,19 @@ SessionSecureID: ${this.sessionData.sessionSecureID}`,
 		}
 
 		const now = new Date().getTime()
-		const url = new URL(baseUrl)
-		const urlWithTimestamp = new URL(baseUrl)
+		let url!: URL
+		try {
+			url = new URL(baseUrl)
+		} catch (e) {
+			internalLog(
+				'identify',
+				'warn',
+				`failed to construct session url from ${baseUrl}`,
+				e,
+			)
+			return null
+		}
+		const urlWithTimestamp = new URL(url)
 		const relativeTimestamp = (now - this._recordingStartTime) / 1000
 		urlWithTimestamp.searchParams.set('ts', relativeTimestamp.toString())
 
diff --git a/sdk/highlight-run/src/version.ts b/sdk/highlight-run/src/version.ts
@@ -0,0 +1,2 @@
+import pkg from '../package.json' assert { type: 'json' }
+export default pkg.version
diff --git a/sdk/highlight-run/vite.config.ts b/sdk/highlight-run/vite.config.ts
@@ -1,6 +1,5 @@
 // vite.config.ts
 import commonjs from '@rollup/plugin-commonjs'
-import json from '@rollup/plugin-json'
 import resolve from '@rollup/plugin-node-resolve'
 import { resolve as resolvePath } from 'path'
 import { defineConfig } from 'vite'
@@ -61,7 +60,6 @@ export default defineConfig({
 		rollupOptions: {
 			treeshake: 'smallest',
 			plugins: [
-				json(),
 				commonjs({
 					transformMixedEsModules: true,
 				}),
diff --git a/yarn.lock b/yarn.lock
@@ -25390,7 +25390,6 @@ __metadata:
     "@opentelemetry/sdk-trace-web": "npm:^1.30.1"
     "@opentelemetry/semantic-conventions": "npm:^1.28.0"
     "@rollup/plugin-commonjs": "npm:^25.0.7"
-    "@rollup/plugin-json": "npm:^6.1.0"
     "@rollup/plugin-node-resolve": "npm:^15.2.3"
     "@rrweb/rrweb-plugin-sequential-id-record": "workspace:*"
     "@rrweb/types": "workspace:*"

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'@launchdarkly/observability': patch
 +---
++
 +75983c01e66ee0f3fda29f7ab4a78254d11013a0