Allow disabling global fetch and cache instrumentation (#130)

evanderkoogh · Apr 29, 2024 · f10e4cd · f10e4cd
1 parent 922ba72
commit f10e4cd
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 2 deletions.
diff --git a/.changeset/violet-bananas-attend.md b/.changeset/violet-bananas-attend.md
@@ -0,0 +1,5 @@
+---
+"@microlabs/otel-cf-workers": minor
+---
+
+Add option to disable auto-instrumentation of global fetch and cache API
diff --git a/src/sdk.ts b/src/sdk.ts
@@ -76,8 +76,12 @@ function isSpanExporter(exporterConfig: ExporterConfig): exporterConfig is SpanE
 let initialised = false
 function init(config: ResolvedTraceConfig): void {
 	if (!initialised) {
-		instrumentGlobalCache()
-		instrumentGlobalFetch()
+		if (config.instrumentation.instrumentGlobalCache) {
+			instrumentGlobalCache()
+		}
+		if (config.instrumentation.instrumentGlobalFetch) {
+			instrumentGlobalFetch()
+		}
 		propagation.setGlobalPropagator(config.propagator)
 		const resource = createResource(config)
 
@@ -135,6 +139,10 @@ function parseConfig(supplied: TraceConfig): ResolvedTraceConfig {
 			service: supplied.service,
 			spanProcessors,
 			propagator: supplied.propagator || new W3CTraceContextPropagator(),
+			instrumentation: {
+				instrumentGlobalCache: supplied.instrumentation?.instrumentGlobalCache ?? true,
+				instrumentGlobalFetch: supplied.instrumentation?.instrumentGlobalFetch ?? true,
+			},
 		}
 	} else {
 		const exporter = isSpanExporter(supplied.exporter) ? supplied.exporter : new OTLPExporter(supplied.exporter)

diff --git a/src/types.ts b/src/types.ts
@@ -29,13 +29,19 @@ export interface SamplingConfig<HS extends HeadSamplerConf = HeadSamplerConf> {
 	tailSampler?: TailSampleFn
 }
 
+export interface InstrumentationOptions {
+	instrumentGlobalFetch?: boolean
+	instrumentGlobalCache?: boolean
+}
+
 interface TraceConfigBase {
 	service: ServiceConfig
 	handlers?: HandlerConfig
 	fetch?: FetcherConfig
 	postProcessor?: PostProcessorFn
 	sampling?: SamplingConfig
 	propagator?: TextMapPropagator
+	instrumentation?: InstrumentationOptions
 }
 
 interface TraceConfigExporter extends TraceConfigBase {
@@ -59,6 +65,7 @@ export interface ResolvedTraceConfig extends TraceConfigBase {
 	sampling: Required<SamplingConfig<Sampler>>
 	spanProcessors: SpanProcessor[]
 	propagator: TextMapPropagator
+	instrumentation: InstrumentationOptions
 }
 
 export interface DOConstructorTrigger {