@bitfab/sdk 0.33.7 → 0.34.0

package/README.md

@@ -104,6 +104,22 @@ pnpm add bitfab @openai/agents
 
 The `@openai/agents` package is an optional peer dependency - the SDK works fine without it unless you need tracing functionality.
 
+### With an OpenTelemetry Collector
+
+Spans are batched and delivered through a private OpenTelemetry pipeline that
+the SDK owns. Direct delivery to Bitfab is the default and needs no extra
+configuration.
+
+To route traces through an OTel Collector instead, set the receiver URL:
+
+```bash
+BITFAB_OTEL_EXPORTER_ENDPOINT=http://localhost:4318
+```
+
+The protobuf exporter Collector mode uses ships with the SDK and is code-split,
+so it loads only when you set an endpoint. See [OpenTelemetry Transport
+Architecture](https://docs.bitfab.ai/otel-architecture) for the full model.
+
 ## Local Development
 
 ```bash
@@ -261,6 +277,9 @@ When `executeLocally: false`, the SDK:
 
 - `BITFAB_URL`: The base URL for the Bitfab API (used if `serviceUrl` is not provided)
 - `OPENAI_API_KEY`, `ANTHROPIC_API_KEY`, etc.: LLM provider API keys (required for local execution)
+- `BITFAB_OTEL_EXPORTER_ENDPOINT`: OTLP/HTTP Collector base URL; unset means batches go directly to Bitfab
+- `BITFAB_OTEL_MAX_REQUEST_BYTES`: request-size target for exports (positive integer up to `3000000`)
+- `BITFAB_OTEL_EXPORT_CONCURRENCY`: concurrent direct requests per export window (`1`-`64`, default `32`)
 
 ## Testing