feat: Update instrumentation configuration for ease of use.

Author: kinyoklion

sdk/@launchdarkly/observability-node/package.json

@@ -29,6 +29,23 @@
 	"dependencies": {
 		"@graphql-codegen/cli": "^5.0.7",
 		"@launchdarkly/node-server-sdk-otel": "^1.3.0",
+		"@opentelemetry/api": "^1.9.0",
+		"@opentelemetry/api-logs": "^0.203.0",
+		"@opentelemetry/auto-instrumentations-node": "^0.62.0",
+		"@opentelemetry/core": "^2.0.1",
+		"@opentelemetry/exporter-jaeger": "^2.0.1",
+		"@opentelemetry/exporter-logs-otlp-http": "^0.203.0",
+		"@opentelemetry/exporter-metrics-otlp-http": "^0.203.0",
+		"@opentelemetry/exporter-trace-otlp-http": "^0.203.0",
+		"@opentelemetry/instrumentation": "^0.203.0",
+		"@opentelemetry/otlp-exporter-base": "^0.203.0",
+		"@opentelemetry/otlp-transformer": "^0.203.0",
+		"@opentelemetry/resources": "^2.0.1",
+		"@opentelemetry/sdk-logs": "^0.203.0",
+		"@opentelemetry/sdk-node": "^0.203.0",
+		"@opentelemetry/sdk-trace-base": "^2.0.1",
+		"@opentelemetry/semantic-conventions": "^1.34.0",
+		"@opentelemetry/winston-transport": "^0.14.0",
 		"@prisma/instrumentation": ">=5.0.0",
 		"require-in-the-middle": "^7.4.0"
 	},
@@ -38,23 +55,6 @@
 	},
 	"devDependencies": {
 		"@launchdarkly/node-server-sdk": "^9.9.2",
-		"@opentelemetry/api": "^1.9.0",
-		"@opentelemetry/api-logs": "^0.57.2",
-		"@opentelemetry/auto-instrumentations-node": "^0.56.0",
-		"@opentelemetry/core": "^1.30.1",
-		"@opentelemetry/exporter-jaeger": "^1.30.1",
-		"@opentelemetry/exporter-logs-otlp-http": "^0.57.2",
-		"@opentelemetry/exporter-metrics-otlp-http": "^0.57.2",
-		"@opentelemetry/exporter-trace-otlp-http": "^0.57.2",
-		"@opentelemetry/instrumentation": "^0.57.2",
-		"@opentelemetry/otlp-exporter-base": "^0.57.2",
-		"@opentelemetry/otlp-transformer": "^0.57.2",
-		"@opentelemetry/resources": "^1.30.1",
-		"@opentelemetry/sdk-logs": "^0.57.2",
-		"@opentelemetry/sdk-node": "^0.57.2",
-		"@opentelemetry/sdk-trace-base": "^1.30.1",
-		"@opentelemetry/semantic-conventions": "^1.30.0",
-		"@opentelemetry/winston-transport": "^0.10.0",
 		"@rollup/plugin-commonjs": "^28.0.2",
 		"@rollup/plugin-json": "^6.1.0",
 		"@rollup/plugin-node-resolve": "^16.0.0",

sdk/@launchdarkly/observability-node/rollup.config.mjs

@@ -36,12 +36,14 @@ const config = {
 			format: 'es',
 			sourcemap: true,
 			exports: 'auto',
+			inlineDynamicImports: true,
 		},
 		{
 			file: 'dist/index.cjs',
 			format: 'cjs',
 			sourcemap: true,
 			exports: 'auto',
+			inlineDynamicImports: true,
 		},
 	],
 	treeshake: 'safest',

sdk/@launchdarkly/observability-node/src/api/Options.ts

@@ -23,6 +23,28 @@ export const ALL_CONSOLE_METHODS = [
 type ConsoleMethodsTuple = typeof ALL_CONSOLE_METHODS
 export type ConsoleMethods = ConsoleMethodsTuple[number]
 
+/**
+ * Options for configuring the LaunchDarkly Observability Plugin.
+ *
+ * Additionally the following environment variables can be used to configure
+ * the plugin.
+ *
+ * LAUNCHDARKLY_OTEL_NODE_ENABLE_FILESYSTEM_INSTRUMENTATION - Enable filesystem
+ * instrumentation. Defaults to false.
+ * LAUNCHDARKLY_OTEL_NODE_ENABLE_OUTGOING_HTTP_INSTRUMENTATION - Enable outgoing
+ * HTTP instrumentation. Defaults to true.
+ * This only affects the outgoing HTTP requests instrumented by
+ * `@opentelemetry/instrumentation-http`. It does not affect fetch for example.
+ *
+ * OTEL_NODE_ENABLED_INSTRUMENTATIONS, and OTEL_NODE_DISABLED_INSTRUMENTATIONS
+ * can be used per the OpenTelemetry documentation, but with a few exceptions.
+ * https://opentelemetry.io/docs/zero-code/js/configuration/
+ *
+ * The `@opentelemetry/instrumentation-fs` instrumentation will only be enabled
+ * if LAUNCHDARKLY_OTEL_NODE_ENABLE_FILESYSTEM_INSTRUMENTATION is true, and
+ * will be unaffected by the OTEL_NODE_ENABLED_INSTRUMENTATIONS and
+ * OTEL_NODE_DISABLED_INSTRUMENTATIONS environment variables.
+ */
 export interface NodeOptions {
 	/**
 	 * The endpoint string to send OTLP HTTP data to.
@@ -82,4 +104,18 @@ export interface NodeOptions {
 	 * @example consoleMethodsToRecord: ['log', 'info', 'error']
 	 */
 	consoleMethodsToRecord?: ConsoleMethods[]
+
+	/**
+	 * Specifies whether to enable HTTP instrumentation.
+	 *
+	 * @default true
+	 */
+	enableHttpInstrumentation?: boolean
+
+	/**
+	 * Specifies whether to enable filesystem instrumentation.
+	 *
+	 * @default false
+	 */
+	enableFileSystemInstrumentation?: boolean
 }

sdk/@launchdarkly/observability-node/src/client/ObservabilityClient.ts

@@ -32,7 +32,10 @@ import {
 	registerInstrumentations,
 } from '@opentelemetry/instrumentation'
 import { CompressionAlgorithm } from '@opentelemetry/otlp-exporter-base'
-import { processDetectorSync, Resource } from '@opentelemetry/resources'
+import {
+	processDetector,
+	resourceFromAttributes,
+} from '@opentelemetry/resources'
 import { NodeSDK } from '@opentelemetry/sdk-node'
 import {
 	AlwaysOnSampler,
@@ -70,16 +73,20 @@ export const HIGHLIGHT_REQUEST_HEADER = 'x-highlight-request'
 
 const instrumentations = getNodeAutoInstrumentations({
 	'@opentelemetry/instrumentation-http': {
-		enabled:
-			(process.env.OTEL_NODE_ENABLED_INSTRUMENTATIONS || '')
-				.split(',')
-				.indexOf('http') !== -1,
+		disableOutgoingRequestInstrumentation:
+			(
+				process.env
+					.LAUNCHDARKLY_OTEL_NODE_ENABLE_OUTGOING_HTTP_INSTRUMENTATION ||
+				''
+			).toLowerCase() === 'false',
 	},
 	'@opentelemetry/instrumentation-fs': {
 		enabled:
-			(process.env.OTEL_NODE_ENABLED_INSTRUMENTATIONS || '')
-				.split(',')
-				.indexOf('fs') !== -1,
+			(
+				process.env
+					.LAUNCHDARKLY_OTEL_NODE_ENABLE_FILESYSTEM_INSTRUMENTATION ||
+				''
+			).toLowerCase() === 'true',
 	},
 	'@opentelemetry/instrumentation-pino': {
 		logHook: (span, record, _) => {
@@ -91,6 +98,7 @@ const instrumentations = getNodeAutoInstrumentations({
 		},
 	},
 })
+
 instrumentations.push(new PrismaInstrumentation())
 registerInstrumentations({ instrumentations })
 
@@ -216,7 +224,7 @@ export class ObservabilityClient {
 				attributes[otelAttr] = options[option]
 			}
 		}
-		const resource = new Resource(attributes)
+		const resource = resourceFromAttributes(attributes)
 
 		const sampler = new CustomSampler()
 		this._getSamplingConfig(sampler)
@@ -229,18 +237,19 @@ export class ObservabilityClient {
 		)
 		this.processor = new BatchSpanProcessor(exporter, opts)
 
-		this.loggerProvider = new LoggerProvider({
-			resource,
-		})
 		const logsExporter = new SamplingLogExporter(
 			{
 				...config,
 				url: `${config.url}/v1/logs`,
 			},
 			sampler,
 		)
+
 		const logsProcessor = new BatchLogRecordProcessor(logsExporter, opts)
-		this.loggerProvider.addLogRecordProcessor(logsProcessor)
+		this.loggerProvider = new LoggerProvider({
+			resource,
+			processors: [logsProcessor],
+		})
 
 		const metricsExporter = new OTLPMetricExporter({
 			...config,
@@ -254,7 +263,7 @@ export class ObservabilityClient {
 
 		this.otel = new NodeSDK({
 			autoDetectResources: true,
-			resourceDetectors: [processDetectorSync],
+			resourceDetectors: [processDetector],
 			resource,
 			spanProcessors: [this.processor],
 			logRecordProcessors: [logsProcessor],

sdk/@launchdarkly/observability-node/src/otel/sampling/sampleSpans.ts

@@ -1,4 +1,4 @@
-import { ReadableSpan } from '@opentelemetry/sdk-trace-web'
+import { ReadableSpan } from '@opentelemetry/sdk-trace-base'
 import { Attributes } from '@opentelemetry/api'
 import { merge } from '@opentelemetry/core'
 import { ExportSampler } from './ExportSampler'
@@ -12,7 +12,7 @@ export function cloneReadableSpanWithAttributes(
 		name: span.name,
 		kind: span.kind,
 		spanContext: () => spanContext,
-		parentSpanId: span.parentSpanId,
+		parentSpanContext: span.parentSpanContext,
 		startTime: span.startTime,
 		endTime: span.endTime,
 		status: span.status,
@@ -22,7 +22,7 @@ export function cloneReadableSpanWithAttributes(
 		duration: span.duration,
 		ended: span.ended,
 		resource: span.resource,
-		instrumentationLibrary: span.instrumentationLibrary,
+		instrumentationScope: span.instrumentationScope,
 		droppedAttributesCount: span.droppedAttributesCount,
 		droppedEventsCount: span.droppedEventsCount,
 		droppedLinksCount: span.droppedLinksCount,
@@ -44,10 +44,10 @@ export function sampleSpans(
 	// The first pass we sample items which are directly impacted by a sampling decision.
 	// We also build a map of children spans by parent span id, which allows us to quickly traverse the span tree.
 	for (const item of items) {
-		if (item.parentSpanId) {
-			childrenByParentId[item.parentSpanId] =
-				childrenByParentId[item.parentSpanId] || []
-			childrenByParentId[item.parentSpanId].push(
+		if (item.parentSpanContext?.spanId) {
+			childrenByParentId[item.parentSpanContext.spanId] =
+				childrenByParentId[item.parentSpanContext.spanId] || []
+			childrenByParentId[item.parentSpanContext.spanId].push(
 				item.spanContext().spanId,
 			)
 		}

sdk/@launchdarkly/observability-node/src/sdk/LDObserve.ts

@@ -1,5 +1,4 @@
 import { Attributes, Span as OtelSpan, SpanOptions } from '@opentelemetry/api'
-import { ResourceAttributes } from '@opentelemetry/resources'
 import { ObservabilityClient } from '../client/ObservabilityClient'
 
 import { RequestContext } from '../api/RequestContext'
@@ -129,7 +128,7 @@ const _LDObserve = {
 	) => {
 		return observabilityClient.startWithHeaders(spanName, headers, options)
 	},
-	setAttributes: (attributes: ResourceAttributes) => {
+	setAttributes: (attributes: Attributes) => {
 		return observabilityClient.setAttributes(attributes)
 	},
 	_debug: (...data: any[]) => {