Update API signatures, fix span_kind attribute

Author: petyosi

.changeset/spotty-pens-float.md

@@ -0,0 +1,7 @@
+---
+"@pydantic/logfire-cf-workers": minor
+"@pydantic/logfire-api": minor
+"logfire": minor
+---
+
+API updates, fixes for span kind

README.md

@@ -69,24 +69,35 @@ npm install @pydantic/logfire-cf-workers @pydantic/logfire-api
 ```
 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 `.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/).
+Add your [Logfire write token](https://logfire.pydantic.dev/docs/how-to-guides/create-write-tokens/) to your `.dev.vars` file. 
 
 ```sh
 LOGFIRE_TOKEN=your-write-token
 ```
 
+For the production deployment, check the [Cloudflare documentation for further details on how to manage and deploy the secrets](https://developers.cloudflare.com/workers/configuration/secrets/).
+
+One way to do that is through the `npx wrangler` command:
+
+```sh
+npx wrangler secret put LOGFIRE_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 * as logfire from '@pydantic/logfire-api';
 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;
+  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',

examples/nextjs/app/page.tsx

@@ -2,7 +2,7 @@ import * as logfire from '@pydantic/logfire-api'
 
 /** Add your relevant code here for the issue to reproduce */
 export default async function Home() {
-  return logfire.startActiveSpan(logfire.Level.Info, 'Info parent span', {}, {}, async () => {
+  return logfire.span('Info parent span', {}, { level: logfire.Level.Info }, async () => {
     logfire.info('child span');
     return <div>Hello</div>;
   })

packages/logfire-api/src/index.ts

@@ -1,16 +1,12 @@
 /* eslint-disable perfectionist/sort-objects */
-import { context as ContextAPI, Span, SpanStatusCode, trace as TraceAPI } from '@opentelemetry/api'
+import { context as ContextAPI, Span, SpanOptions, SpanStatusCode, trace as TraceAPI } from '@opentelemetry/api'
 import { ATTR_EXCEPTION_MESSAGE, ATTR_EXCEPTION_STACKTRACE } from '@opentelemetry/semantic-conventions'
 
 export * from './AttributeScrubber'
 export { serializeAttributes } from './serializeAttributes'
 
 const DEFAULT_OTEL_SCOPE = 'logfire'
 
-export interface LogOptions {
-  tags?: string[]
-}
-
 export interface LogfireApiConfigOptions {
   otelScope?: string
 }
@@ -27,8 +23,15 @@ export const Level = {
 
 export type LogFireLevel = (typeof Level)[keyof typeof Level]
 
+export interface LogOptions {
+  level?: LogFireLevel
+  log?: true
+  tags?: string[]
+}
+
 const LOGFIRE_ATTRIBUTES_NAMESPACE = 'logfire'
 const ATTRIBUTES_LEVEL_KEY = `${LOGFIRE_ATTRIBUTES_NAMESPACE}.level_num`
+const ATTRIBUTES_SPAN_TYPE_KEY = `${LOGFIRE_ATTRIBUTES_NAMESPACE}.span_type`
 export const ATTRIBUTES_TAGS_KEY = `${LOGFIRE_ATTRIBUTES_NAMESPACE}.tags`
 
 const currentLogfireApiConfig: LogfireApiConfigOptions = {}
@@ -53,14 +56,19 @@ const logfireApiConfig = {
   },
 }
 
-function startSpan(level: LogFireLevel, message: string, attributes: Record<string, unknown> = {}, { tags = [] }: LogOptions = {}): Span {
+export function startSpan(
+  message: string,
+  attributes: Record<string, unknown> = {},
+  { log, tags = [], level = Level.Info }: LogOptions = {}
+): Span {
   const span = logfireApiConfig.tracer.startSpan(
     message,
     {
       attributes: {
         ...attributes,
         [ATTRIBUTES_LEVEL_KEY]: level,
         [ATTRIBUTES_TAGS_KEY]: Array.from(new Set(tags).values()),
+        [ATTRIBUTES_SPAN_TYPE_KEY]: log ? 'log' : 'span',
       },
     },
     logfireApiConfig.context
@@ -69,11 +77,10 @@ function startSpan(level: LogFireLevel, message: string, attributes: Record<stri
   return span
 }
 
-export function startActiveSpan<F extends (span: Span) => unknown>(
-  level: LogFireLevel,
+export function span<F extends (span: Span) => unknown>(
   message: string,
   attributes: Record<string, unknown> = {},
-  { tags = [] }: LogOptions = {},
+  { tags = [], level = Level.Info }: LogOptions = {},
   callback: F
 ) {
   return logfireApiConfig.tracer.startActiveSpan<F>(
@@ -89,40 +96,40 @@ export function startActiveSpan<F extends (span: Span) => unknown>(
   )
 }
 
-export function log(level: LogFireLevel, message: string, attributes: Record<string, unknown> = {}, options: LogOptions = {}) {
-  startSpan(level, message, attributes, options).end()
+export function log(message: string, attributes: Record<string, unknown> = {}, options: LogOptions = {}) {
+  startSpan(message, attributes, { ...options, log: true }).end()
 }
 
 export function debug(message: string, attributes: Record<string, unknown> = {}, options: LogOptions = {}) {
-  log(Level.Debug, message, attributes, options)
+  log(message, attributes, { ...options, level: Level.Debug })
 }
 
 export function info(message: string, attributes: Record<string, unknown> = {}, options: LogOptions = {}) {
-  log(Level.Info, message, attributes, options)
+  log(message, attributes, { ...options, level: Level.Info })
 }
 
 export function trace(message: string, attributes: Record<string, unknown> = {}, options: LogOptions = {}) {
-  log(Level.Trace, message, attributes, options)
+  log(message, attributes, { ...options, level: Level.Trace })
 }
 
 export function error(message: string, attributes: Record<string, unknown> = {}, options: LogOptions = {}) {
-  log(Level.Error, message, attributes, options)
+  log(message, attributes, { ...options, level: Level.Error })
 }
 
 export function fatal(message: string, attributes: Record<string, unknown> = {}, options: LogOptions = {}) {
-  log(Level.Fatal, message, attributes, options)
+  log(message, attributes, { ...options, level: Level.Fatal })
 }
 
 export function notice(message: string, attributes: Record<string, unknown> = {}, options: LogOptions = {}) {
-  log(Level.Notice, message, attributes, options)
+  log(message, attributes, { ...options, level: Level.Notice })
 }
 
 export function warning(message: string, attributes: Record<string, unknown> = {}, options: LogOptions = {}) {
-  log(Level.Warning, message, attributes, options)
+  log(message, attributes, { ...options, level: Level.Warning })
 }
 
 export function reportError(message: string, error: Error, extraAttributes: Record<string, unknown> = {}) {
-  const span = startSpan(Level.Error, message, {
+  const span = startSpan(message, {
     // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition
     [ATTR_EXCEPTION_MESSAGE]: error.message ?? 'error',
     [ATTR_EXCEPTION_STACKTRACE]: error.stack,

packages/logfire-cf-workers/package.json

@@ -49,6 +49,7 @@
     "postpack": "rm LICENSE"
   },
   "dependencies": {
+    "@pydantic/logfire-api": "*",
     "@microlabs/otel-cf-workers": "^1.0.0-rc.49"
   },
   "devDependencies": {

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

@@ -1,6 +1,8 @@
+import type { ReadableSpan } from '@opentelemetry/sdk-trace-base'
+
 import { KVNamespace } from '@cloudflare/workers-types'
 import { instrument as microlabsInstrument } from '@microlabs/otel-cf-workers'
-import { ReadableSpan } from '@opentelemetry/sdk-trace-base'
+import { AttributeScrubber, LogfireAttributeScrubber, serializeAttributes } from '@pydantic/logfire-api'
 
 export interface CloudflareConfigOptions {
   baseUrl?: string
@@ -22,6 +24,7 @@ export interface LogfireCloudflareConfigOptions {
 const DEFAULT_LOGFIRE_BASE_URL = 'https://logfire-api.pydantic.dev/'
 
 function getConfig(config: LogfireCloudflareConfigOptions) {
+  const scrubber = new LogfireAttributeScrubber()
   return (env: Env) => {
     let { LOGFIRE_BASE_URL: baseUrl = DEFAULT_LOGFIRE_BASE_URL, LOGFIRE_TOKEN: token } = env
 
@@ -34,7 +37,7 @@ function getConfig(config: LogfireCloudflareConfigOptions) {
         headers: { Authorization: token },
         url: `${baseUrl}v1/traces`,
       },
-      postProcessor: filterEmptyAttributes,
+      postProcessor: (spans: ReadableSpan[]) => postProcessAttributes(spans, scrubber),
       service: {
         name: config.serviceName ?? 'cloudflare-worker',
         namespace: config.serviceNamespace ?? '',
@@ -58,7 +61,7 @@ function instrumentDO<T>(doClass: T, config: LogfireCloudflareConfigOptions): T
 }
 */
 
-function filterEmptyAttributes(spans: ReadableSpan[]) {
+function postProcessAttributes(spans: ReadableSpan[], scrubber: AttributeScrubber) {
   for (const span of spans) {
     for (const attrKey of Object.keys(span.attributes)) {
       const attrVal = span.attributes[attrKey]
@@ -68,6 +71,7 @@ function filterEmptyAttributes(spans: ReadableSpan[]) {
         delete span.attributes[attrKey]
       }
     }
+    Object.assign(span.attributes, serializeAttributes(span.attributes, scrubber))
   }
   return spans
 }

packages/logfire-cf-workers/vite.config.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'), ['@microlabs/otel-cf-workers'])
+export default defineConfig(resolve(__dirname, 'src/index.ts'), ['@microlabs/otel-cf-workers', '@pydantic/logfire-api'])