Improvements for the cf-workers package

Author: petyosi

.changeset/wide-women-happen.md

@@ -0,0 +1,5 @@
+---
+"@pydantic/logfire-cf-workers": patch
+---
+
+Embed microlabs as a dependency

README.md

@@ -58,59 +58,37 @@ Run the script above with `node hello.js`, and you should see the span being log
 
 ### Cloudflare Workers
 
-First, install the `@microlabs/otel-cf-workers` [NPM package](https://github.com/evanderkoogh/otel-cf-workers) and the `@pydantic/logfire-cf-workers @pydantic/logfire-api` NPM package:
+First, install the `@pydantic/logfire-cf-workers @pydantic/logfire-api` NPM packages:
 
 ```sh
-npm install @microlabs/otel-cf-workers @opentelemetry/api @pydantic/logfire-cf-workers @pydantic/logfire-api
+npm install @pydantic/logfire-cf-workers @pydantic/logfire-api
 ```
-As per the otel-cf-workers package instructions, add `compatibility_flags = [ "nodejs_compat" ]` to your wrangler.toml or `"compatibility_flags": ["nodejs_compat"]` if you're using `wrangler.jsonc`.
+Next, add `compatibility_flags = [ "nodejs_compat" ]` to your wrangler.toml or `"compatibility_flags": ["nodejs_compat"]` if you're using `wrangler.jsonc`.
 
-Add your [Logfire write token](https://logfire.pydantic.dev/docs/how-to-guides/create-write-tokens/) to your Wrangler file:
+Add your [Logfire write token](https://logfire.pydantic.dev/docs/how-to-guides/create-write-tokens/) to your `.dev.vars` file. Check the [Cloudflare documentation for further details on how to manage and deploy the secrets](https://developers.cloudflare.com/workers/configuration/secrets/).
 
-`wrangler.jsonc`:
-
-```json
-  "vars": {
-    "LOGFIRE_TOKEN": "your-write-token",
-  },
-```
-
-`wrangler.toml`:
-
-```toml
-[vars]
-LOGFIRE_WRITE_TOKEN="your-write-token"
+```sh
+LOGFIRE_TOKEN=your-write-token
 ```
 
 Next, add the necessary instrumentation around your handler. The `tracerConfig` function will extract your write token from the `env` object and provide the necessary configuration for the instrumentation:
 
 ```ts
-import { instrument, ResolveConfigFn } from '@microlabs/otel-cf-workers';
-import { tracerConfig } from '@pydantic/logfire-cf-workers';
-// Optional, if you want to manually create spans. Regular OTel API can be used as well.
 import * as logfire from '@pydantic/logfire-api';
-
-export interface Env {
-  LOGFIRE_TOKEN: string;
-  LOGFIRE_BASE_URL: string;
-  OTEL_TEST: KVNamespace;
-}
+import { instrument } from '@pydantic/logfire-cf-workers';
 
 const handler = {
-  async fetch(): Promise<Response> {
-    logfire.info('Logfire: info from inside the worker body');
-    return new Response('Hello World!');
-  },
-} satisfies ExportedHandler<Env>;
-
-const config: ResolveConfigFn = (env: Env, _trigger) => {
-  return {
-    service: { name: 'cloudflare-worker', namespace: '', version: '1.0.0' },
-    ...tracerConfig(env),
-  };
-};
-
-export default instrument(handler, config);
+	async fetch(): Promise<Response> {
+		logfire.info('info span from inside the worker body');
+		return new Response('Hello World!');
+	},
+} satisfies ExportedHandler;
+
+export default instrument(handler, {
+	serviceName: 'cloudflare-worker',
+	serviceNamespace: '',
+	serviceVersion: '1.0.0',
+});
 ```
 
 A working example can be found in the `examples/cloudflare-worker` directory. 

examples/cloudflare-worker/src/index.ts

@@ -10,28 +10,18 @@
  *
  * Learn more at https://developers.cloudflare.com/workers/
  */
-import { instrument, ResolveConfigFn } from '@microlabs/otel-cf-workers';
-import { tracerConfig } from '@pydantic/logfire-cf-workers';
 import * as logfire from '@pydantic/logfire-api';
-
-export interface Env {
-	LOGFIRE_TOKEN: string;
-	LOGFIRE_BASE_URL: string;
-	OTEL_TEST: KVNamespace;
-}
+import { instrument } from '@pydantic/logfire-cf-workers';
 
 const handler = {
 	async fetch(): Promise<Response> {
 		logfire.info('info span from inside the worker body');
 		return new Response('Hello World!');
 	},
-} satisfies ExportedHandler<Env>;
-
-const config: ResolveConfigFn = (env: Env, _trigger) => {
-	return {
-		service: { name: 'cloudflare-worker', namespace: '', version: '1.0.0' },
-		...tracerConfig(env),
-	};
-};
+} satisfies ExportedHandler;
 
-export default instrument(handler, config);
+export default instrument(handler, {
+	serviceName: 'cloudflare-worker',
+	serviceNamespace: '',
+	serviceVersion: '1.0.0',
+});

examples/cloudflare-worker/wrangler.jsonc

@@ -28,9 +28,7 @@
 	 * Environment Variables
 	 * https://developers.cloudflare.com/workers/wrangler/configuration/#environment-variables
 	 */
-	"vars": {
-		"LOGFIRE_TOKEN": "your-token",
-	},
+	"vars": {},
 	/**
 	 * Note: Use secrets to store sensitive data.
 	 * https://developers.cloudflare.com/workers/configuration/secrets/

package-lock.json

@@ -48,9 +48,11 @@
     "prepack": "cp ../../LICENSE .",
     "postpack": "rm LICENSE"
   },
+  "dependencies": {
+    "@microlabs/otel-cf-workers": "^1.0.0-rc.49"
+  },
   "devDependencies": {
-    "@microlabs/otel-cf-workers": "^1.0.0-rc.49",
-    "@opentelemetry/exporter-trace-otlp-proto": "^0.57.2",
+    "@cloudflare/workers-types": "4.20250311.0",
     "@opentelemetry/sdk-trace-base": "^1.30.1",
     "@pydantic/logfire-tooling-config": "*",
     "eslint": "^9.22.0",
@@ -60,11 +62,6 @@
     "vite-plugin-dts": "^4.5.3",
     "vitest": "^3.0.8"
   },
-  "peerDependencies": {
-    "@microlabs/otel-cf-workers": "^1.0.0-rc.49",
-    "@opentelemetry/exporter-trace-otlp-proto": "^0.57.2",
-    "@opentelemetry/sdk-trace-base": "^1.30.1"
-  },
   "files": [
     "dist",
     "LICENSE"

packages/logfire-cf-workers/package.json

@@ -1,25 +1,63 @@
-import type { OTLPExporterConfig, PostProcessorFn } from '@microlabs/otel-cf-workers'
-
+import { KVNamespace } from '@cloudflare/workers-types'
+import { instrument as microlabsInstrument } from '@microlabs/otel-cf-workers'
 import { ReadableSpan } from '@opentelemetry/sdk-trace-base'
 
 export interface CloudflareConfigOptions {
   baseUrl?: string
   token: string
 }
 
+interface Env {
+  LOGFIRE_BASE_URL: string
+  LOGFIRE_TOKEN: string
+  OTEL_TEST: KVNamespace
+}
+
+export interface LogfireCloudflareConfigOptions {
+  serviceName?: string
+  serviceNamespace?: string
+  serviceVersion?: string
+}
+
 const DEFAULT_LOGFIRE_BASE_URL = 'https://logfire-api.pydantic.dev/'
 
-export function cloudflareExporterConfig({ baseUrl = DEFAULT_LOGFIRE_BASE_URL, token }: CloudflareConfigOptions): OTLPExporterConfig {
-  if (!baseUrl.endsWith('/')) {
-    baseUrl += '/'
-  }
-  return {
-    headers: { Authorization: token },
-    url: `${baseUrl}v1/traces`,
+function getConfig(config: LogfireCloudflareConfigOptions) {
+  return (env: Env) => {
+    let { LOGFIRE_BASE_URL: baseUrl = DEFAULT_LOGFIRE_BASE_URL, LOGFIRE_TOKEN: token } = env
+
+    if (!baseUrl.endsWith('/')) {
+      baseUrl += '/'
+    }
+
+    return {
+      exporter: {
+        headers: { Authorization: token },
+        url: `${baseUrl}v1/traces`,
+      },
+      postProcessor: filterEmptyAttributes,
+      service: {
+        name: config.serviceName ?? 'cloudflare-worker',
+        namespace: config.serviceNamespace ?? '',
+        version: config.serviceVersion ?? '0.0.0',
+      },
+    }
   }
 }
 
-export function filterEmptyAttributes(spans: ReadableSpan[]) {
+export function instrument<T>(handler: T, config: LogfireCloudflareConfigOptions): T {
+  return microlabsInstrument(handler, getConfig(config))
+}
+
+// ATM this is broken in microlabs,
+/*
+function instrumentDO<T>(doClass: T, config: LogfireCloudflareConfigOptions): T {
+  // the d.ts bundler choked on this
+  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-explicit-any
+  return microlabsInstrumentDO(doClass as unknown as any, getConfig(config)) as T
+}
+*/
+
+function filterEmptyAttributes(spans: ReadableSpan[]) {
   for (const span of spans) {
     for (const attrKey of Object.keys(span.attributes)) {
       const attrVal = span.attributes[attrKey]
@@ -32,14 +70,3 @@ export function filterEmptyAttributes(spans: ReadableSpan[]) {
   }
   return spans
 }
-
-export function tracerConfig(env: { LOGFIRE_BASE_URL?: string; LOGFIRE_TOKEN: string }): {
-  exporter: OTLPExporterConfig
-  postProcessor: PostProcessorFn
-} {
-  const { LOGFIRE_BASE_URL: baseUrl = DEFAULT_LOGFIRE_BASE_URL, LOGFIRE_TOKEN: token } = env
-  return {
-    exporter: cloudflareExporterConfig({ baseUrl, token }),
-    postProcessor: filterEmptyAttributes,
-  }
-}

packages/logfire-cf-workers/src/index.ts

@@ -1,4 +1,4 @@
 import defineConfig from '@pydantic/logfire-tooling-config/vite-config'
 import { resolve } from 'node:path'
 
-export default defineConfig(resolve(__dirname, 'src/index.ts'))
+export default defineConfig(resolve(__dirname, 'src/index.ts'), ['@microlabs/otel-cf-workers'])