@heystack/otel 0.13.0 → 0.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +102 -20
- package/dist/llm-enrich.d.ts +63 -1
- package/dist/llm-enrich.js +292 -19
- package/dist/node.js +2 -2
- package/dist/workers-bindings.d.ts +4 -1
- package/dist/workers-bindings.js +194 -3
- package/dist/workers.d.ts +31 -3
- package/dist/workers.js +278 -68
- package/package.json +8 -8
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@ Always read your key from the environment — never paste it into source:
|
|
|
13
13
|
HEYSTACK_API_KEY=sk_live_…
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
> **Use `@heystack/otel` `>=0.
|
|
16
|
+
> **Use `@heystack/otel` `>=0.15.0`.** 0.15 extends direct Workers instrumentation to D1 sessions and batches. Cloudflare native OTel remains the preferred path for Workers; direct SDK export is a compatibility fallback when native tracing is unavailable. See [Migration](#migration--versioning) below.
|
|
17
17
|
|
|
18
18
|
## Runtime matrix
|
|
19
19
|
|
|
@@ -21,6 +21,8 @@ HEYSTACK_API_KEY=sk_live_…
|
|
|
21
21
|
| --- | --- | --- |
|
|
22
22
|
| Next.js — **any** deploy target (Vercel/Node **and** Cloudflare/OpenNext) | `@heystack/otel/next` | `registerHeystack` in `instrumentation.ts`. Auto-detects Node vs Cloudflare workerd and picks the right exporter. No-op on Edge. |
|
|
23
23
|
| Standalone Cloudflare Workers (hand-written `export default { fetch }`) | `@heystack/otel/workers` | Native-first `instrument()` wrapper; Cloudflare owns OTLP export and automatic platform spans. |
|
|
24
|
+
| Cloudflare Python Workers | No `@heystack/otel` import | Enable Cloudflare native traces/logs and an OTLP destination. Python runs inside workerd, so platform tracing covers handler and supported binding operations without a JavaScript SDK. |
|
|
25
|
+
| WebAssembly modules used by a Worker | Instrument the JavaScript/TypeScript host, if present | Enable Cloudflare native traces/logs for the Worker. Wasm execution is part of its host invocation; this package does not inject language-level spans inside Rust/Go/C Wasm code. |
|
|
24
26
|
| Cloudflare Agents SDK / Agents Tail Worker | `@heystack/otel/workers/agents` | Structured Agents lifecycle events, trace correlation, redaction, and Tail Worker adapter. |
|
|
25
27
|
| Node / Express / Fastify / NestJS (long-running server) | `@heystack/otel/node` | `initHeystack`: auto-instrumentations + graceful shutdown. |
|
|
26
28
|
| Browser (SPA / any web frontend) | `@heystack/otel/web` | `instrumentWeb`: session replay + opt-in browser distributed tracing (`tracing: true`) that emits CLIENT spans + propagates W3C `traceparent` (browser→API shows as one trace). No-op on the server (SSR-safe). |
|
|
@@ -127,7 +129,7 @@ head_sampling_rate = 1
|
|
|
127
129
|
persist = false
|
|
128
130
|
```
|
|
129
131
|
|
|
130
|
-
Cloudflare creates the invocation and supported platform/binding spans and exports trace-correlated logs. `instrument()` detects `ctx.tracing` and adds Heystack business/identity attributes to that same tree. In this mode it creates no OTel provider, makes no Heystack export request, does not
|
|
132
|
+
Cloudflare creates the invocation and supported platform/binding spans and exports trace-correlated logs. `instrument()` detects `ctx.tracing` and adds Heystack business/identity attributes to that same tree. In this mode it creates no OTel provider, makes no Heystack export request, does not proxy bindings, and does not require `HEYSTACK_API_KEY` in the Worker. The only `fetch` patch it installs is a **lean, LLM-only** one (0.14+): outbound calls to a detected LLM provider or a configured AI gateway get a native `<operation> <provider>` span (e.g. `chat mistral`) with `gen_ai.*` attributes — every other subrequest passes through untouched, since Cloudflare already records it. See [AI / LLM observability](#ai--llm-observability).
|
|
131
133
|
|
|
132
134
|
```ts
|
|
133
135
|
import { instrument, withCloudflareSpan } from "@heystack/otel/workers";
|
|
@@ -147,6 +149,12 @@ export default instrument(worker, {
|
|
|
147
149
|
});
|
|
148
150
|
```
|
|
149
151
|
|
|
152
|
+
Native export is the portable path across Workers languages. The dashboard destination sends OTLP/HTTP traces and logs, so the same configuration applies to JavaScript/TypeScript, [Python Workers](https://developers.cloudflare.com/workers/languages/python/), and Workers whose handlers call [WebAssembly modules](https://developers.cloudflare.com/workers/runtime-apis/webassembly/). Cloudflare's [OTel export documentation](https://developers.cloudflare.com/workers/observability/exporting-opentelemetry-data/) currently says infrastructure and custom metrics export is unavailable.
|
|
153
|
+
|
|
154
|
+
For a Python Worker, configure the same `observability.traces` and `observability.logs` blocks and emit structured application logs through the runtime's `console`. There is no Python entry point in this npm package and no claim of Python function-level auto-instrumentation. For WebAssembly, native tracing observes the Worker invocation and Cloudflare operations around the module. Add explicit spans in the JavaScript/TypeScript host with `withCloudflareSpan` when you need timings around a Wasm call; spans inside the compiled module require that language's own workerd-compatible instrumentation.
|
|
155
|
+
|
|
156
|
+
Cloudflare native tracing automatically covers handler invocations, fetch subrequests, and supported platform operations such as KV, R2, and Durable Objects. The direct JavaScript binding proxies below are a compatibility and enrichment layer; they are not required when native tracing is active.
|
|
157
|
+
|
|
150
158
|
The wrapper also enters native spans for default-export queue and scheduled handlers. `withCloudflareSpan(ctx, ...)` remains native across arbitrary `await` boundaries and does not require `nodejs_compat`. `withSpan(...)` routes to the native tracer whenever its active context is available.
|
|
151
159
|
|
|
152
160
|
### Cloudflare Agents SDK
|
|
@@ -184,7 +192,7 @@ export default instrument(
|
|
|
184
192
|
getUser: (req) => ({
|
|
185
193
|
id: req.headers.get("x-user-id") ?? undefined,
|
|
186
194
|
}),
|
|
187
|
-
instrumentBindings: true, //
|
|
195
|
+
instrumentBindings: true, // direct-mode spans for supported binding operations
|
|
188
196
|
},
|
|
189
197
|
);
|
|
190
198
|
```
|
|
@@ -201,7 +209,7 @@ Set the key as a secret: `wrangler secret put HEYSTACK_API_KEY`, and set `native
|
|
|
201
209
|
> ```toml
|
|
202
210
|
> compatibility_flags = ["nodejs_compat"]
|
|
203
211
|
> ```
|
|
204
|
-
> Without it the SDK falls back to a synchronous stack-based context manager — suppression still works, and **binding spans
|
|
212
|
+
> Without it the SDK falls back to a synchronous stack-based context manager — suppression still works, and **instrumented binding spans are still parented to the request's SERVER span** (they fall back to the request context explicitly, so they never orphan into their own single-span traces). What still degrades to best-effort without `nodejs_compat` is cross-`await` parenting for *outbound-fetch CLIENT spans* and *manual `withSpan` spans* — so `nodejs_compat` remains recommended for a fully-nested trace tree.
|
|
205
213
|
|
|
206
214
|
### `WorkersConfig` options
|
|
207
215
|
|
|
@@ -211,9 +219,9 @@ Set the key as a secret: `wrangler secret put HEYSTACK_API_KEY`, and set `native
|
|
|
211
219
|
| `nativeTracing` | `"auto" \| "native" \| "direct"` | `auto` (default) uses Cloudflare's native tree when `ctx.tracing` exists. `direct` forces the compatibility exporter. |
|
|
212
220
|
| `apiKey` | `string?` | Defaults to `env.HEYSTACK_API_KEY`. |
|
|
213
221
|
| `getUser` | `(req: Request) => { id?, session?, requestId? } \| undefined` | Called per request. `id` → `enduser.id`, `session` → `session.id`, `requestId` → `http.request.id` (falls back to the `cf-ray` header). |
|
|
214
|
-
| `instrumentBindings` | `boolean \| string[]` | `true` =
|
|
222
|
+
| `instrumentBindings` | `boolean \| string[]` | Direct mode only. `true` = child spans for all detected supported bindings; `string[]` = only named bindings. Default `false`. See the operation matrix below. |
|
|
215
223
|
| `sampling` | `{ rate?: number } \| { remote: true }` | Head-sampling configuration. `{ rate }`: keep a deterministic fraction of fresh root traces (0–1; default `1` = keep all). `{ remote: true }`: fetch the rate from the Heystack config endpoint instead — lets you change it centrally without redeploying. Cold isolates keep all traffic until the first config fetch resolves; fails open if the config can't be reached. Parent-respecting in both modes: a request arriving with a sampled `traceparent` is always recorded. See [Head sampling](#head-sampling) below. |
|
|
216
|
-
| `ai` | `{ captureContent?: boolean; redact?: (text: string) => string; maxContentChars?: number }` | LLM/gen_ai capture for outbound calls to known providers. See [AI / LLM observability](#ai--llm-observability) below. |
|
|
224
|
+
| `ai` | `{ captureContent?: boolean; redact?: (text: string) => string; maxContentChars?: number; gateways?: Array<{ hostSuffix: string; pathPattern: string }> }` | LLM/gen_ai capture for outbound calls to known providers (works under native tracing and the direct exporter). `gateways` declares AI gateways/proxies you call instead of the provider host (e.g. Wafer). See [AI / LLM observability](#ai--llm-observability) below. |
|
|
217
225
|
| `waitUntil` | `(p: Promise<unknown>) => void` | Override the isolate keep-alive hook; defaults to the auto-detected `ctx.waitUntil`. |
|
|
218
226
|
| `version` | `string?` | Release identifier → `service.version` resource attribute. Powers release health + suspect release. See [Release & commit attribution](#release--commit-attribution-version--build). |
|
|
219
227
|
| `build` | `string?` | Commit SHA → `service.build` resource attribute. Powers suspect commit (deep-links to the commit when a repo URL is set in the console). |
|
|
@@ -257,7 +265,22 @@ On startup the worker fetches its configured rate from the Heystack config endpo
|
|
|
257
265
|
- **Outbound `fetch`** — each outbound subrequest while a request span is active gets a CLIENT child span (`http.request.method`, `url.full`, `server.address`, `http.response.status_code`). A W3C `traceparent` header is injected into the subrequest so a downstream Heystack-instrumented service continues the same trace (distributed tracing across services). The exporter's own ingest POST is never traced.
|
|
258
266
|
- **Queue consumers (`queue`)** — a CONSUMER span per batch, with `messaging.destination.name` (queue name) and `messaging.batch.message_count`.
|
|
259
267
|
- **Scheduled handlers (`scheduled`)** — an INTERNAL span per invocation, with `controller.cron`.
|
|
260
|
-
- **Binding calls** (when `instrumentBindings` is set) —
|
|
268
|
+
- **Binding calls** (direct mode, when `instrumentBindings` is set) — child spans for the stable operations listed below. Service binding `.fetch` calls receive a W3C `traceparent` header so another instrumented Worker can continue the trace.
|
|
269
|
+
|
|
270
|
+
| Binding | Direct-mode operations covered |
|
|
271
|
+
| --- | --- |
|
|
272
|
+
| D1 | prepared statement `all`, `first`, `run`, `raw`; database/session `batch`; database `exec`; statements created through `withSession` |
|
|
273
|
+
| KV | `get`, `getWithMetadata`, `put`, `list`, `delete` |
|
|
274
|
+
| R2 | `get`, `put`, `head`, `delete`, `list`; multipart create/resume plus `uploadPart`, `complete`, `abort` |
|
|
275
|
+
| Vectorize | `query`, `upsert`, `insert`, `deleteByIds`, `getByIds` |
|
|
276
|
+
| Workers AI | `run`, including model and token usage when returned without consuming streams |
|
|
277
|
+
| Queues producer | `send`, `sendBatch`, `metrics` |
|
|
278
|
+
| Workflows | `get`, `create`, `createBatch`, `deleteBatch` |
|
|
279
|
+
| Rate Limiting | `limit`; the caller's rate-limit key is deliberately not attached |
|
|
280
|
+
| Analytics Engine | synchronous `writeDataPoint`; datapoint values are deliberately not attached |
|
|
281
|
+
| Fetch-compatible bindings | `fetch` on Service, Browser Rendering, Assets, and other Fetcher-shaped bindings |
|
|
282
|
+
|
|
283
|
+
Some bindings intentionally remain outside generic direct-mode proxying. Durable Object namespaces return arbitrary RPC stubs whose method surface is application-defined; Hyperdrive exposes a connection string and the actual calls belong to the selected database driver. Email and Pipelines both expose only a generic `send` method; Analytics SQL exposes only `query`; Media begins with a generic `input`; blindly identifying those shapes could wrap an unrelated application object. Images' chained transform handles and hosted-image handles are also not proxied. Secrets, version metadata, and static-data bindings do not perform observable operations. Use [Cloudflare native tracing](https://developers.cloudflare.com/workers/observability/traces/) where it supports the binding, instrument the database/client library, or wrap a known application operation with `withSpan`. RPC methods beyond `.fetch()` need explicit application spans because automatically proxying arbitrary properties can change RPC stub semantics.
|
|
261
284
|
|
|
262
285
|
### Client enrichment
|
|
263
286
|
|
|
@@ -273,29 +296,50 @@ These attributes are set automatically on every SERVER span from request metadat
|
|
|
273
296
|
|
|
274
297
|
### AI / LLM observability
|
|
275
298
|
|
|
276
|
-
When your Worker calls an LLM API, `instrument()` automatically attaches [OpenTelemetry gen_ai semantic conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/) to the outbound
|
|
299
|
+
When your Worker calls an LLM API, `instrument()` automatically attaches [OpenTelemetry gen_ai semantic conventions](https://opentelemetry.io/docs/specs/semconv/gen-ai/) to the outbound call. No extra code is needed — detection is based on the target URL. It works on **both tracing planes**:
|
|
300
|
+
|
|
301
|
+
- **Cloudflare native tracing** (`nativeTracing: "auto" | "native"`, the default) — the call becomes a native span named `<operation> <provider>` (e.g. `chat mistral`, `chat google`) in Cloudflare's trace tree, carrying the `gen_ai.*` attributes below plus `server.address` and `http.response.status_code`. Non-LLM subrequests are not touched (Cloudflare records them itself). *(0.14+; before that, native mode emitted no `gen_ai.*` at all.)*
|
|
302
|
+
- **Direct exporter** (`nativeTracing: "direct"`) — the attributes land on the outbound CLIENT span.
|
|
277
303
|
|
|
278
|
-
**Detected providers:**
|
|
304
|
+
**Detected providers (direct hosts):**
|
|
279
305
|
- **OpenAI** — `api.openai.com`
|
|
280
306
|
- **Anthropic** — `api.anthropic.com`
|
|
281
|
-
- **
|
|
307
|
+
- **Mistral** — `api.mistral.ai`
|
|
282
308
|
- **Google** — `generativelanguage.googleapis.com`
|
|
309
|
+
- **Cloudflare AI Gateway** — any host ending in `gateway.ai.cloudflare.com`
|
|
310
|
+
|
|
311
|
+
**AI gateways / proxies (`ai.gateways`):** if you call providers through a gateway such as [Wafer](https://wafersecurity.ai) instead of the provider host, tell the SDK how to read the provider off the URL. Each entry names the gateway host (exact or any subdomain) and a path pattern whose `:provider` segment carries the provider token — one of `openai`, `anthropic`, `google`, `gemini` (→ `google`), `mistral`, `cloudflare`, `workers-ai` (→ `cloudflare`). Literal segments must match; other `:params` match any segment; the provider's own API path may follow. Direct hosts are checked first; a gateway URL whose token is unknown is left untraced.
|
|
312
|
+
|
|
313
|
+
```ts
|
|
314
|
+
export default instrument(worker, {
|
|
315
|
+
service: "tp-api",
|
|
316
|
+
ai: {
|
|
317
|
+
gateways: [{ hostSuffix: "wafersecurity.ai", pathPattern: "/p/:tenant/:provider" }],
|
|
318
|
+
},
|
|
319
|
+
});
|
|
320
|
+
// https://wafersecurity.ai/p/talkpod/mistral/v1/chat/completions
|
|
321
|
+
// → gen_ai.system = "mistral", heystack.ai.gateway = "wafersecurity.ai"
|
|
322
|
+
// https://wafersecurity.ai/p/talkpod/gemini/v1beta/models/gemini-2.5-flash:streamGenerateContent
|
|
323
|
+
// → gen_ai.system = "google", heystack.ai.gateway = "wafersecurity.ai"
|
|
324
|
+
```
|
|
283
325
|
|
|
284
326
|
**Attributes captured automatically (metadata, always on):**
|
|
285
327
|
|
|
286
328
|
| Attribute | Description |
|
|
287
329
|
| --- | --- |
|
|
288
|
-
| `gen_ai.system` | Provider name (`openai`, `anthropic`, `
|
|
330
|
+
| `gen_ai.system` | Provider name (`openai`, `anthropic`, `mistral`, `google`, `cloudflare`) |
|
|
331
|
+
| `gen_ai.operation.name` | `chat`, `embeddings` or `text_completion`, inferred from the request path |
|
|
332
|
+
| `heystack.ai.gateway` | Gateway hostname — only when the provider was resolved via `ai.gateways` |
|
|
289
333
|
| `gen_ai.request.model` | Model from the request body (`body.model`) |
|
|
290
334
|
| `gen_ai.request.max_tokens` | Max tokens from the request (`max_tokens` or `max_completion_tokens`) |
|
|
291
335
|
| `gen_ai.request.temperature` | Temperature from the request |
|
|
292
|
-
| `gen_ai.response.model` | Model from the response
|
|
293
|
-
| `gen_ai.response.id` | Response ID |
|
|
294
|
-
| `gen_ai.usage.input_tokens` | Input/prompt tokens
|
|
295
|
-
| `gen_ai.usage.output_tokens` | Output/completion tokens
|
|
296
|
-
| `gen_ai.response.finish_reason` | Stop reason (`stop`, `end_turn`, etc.) |
|
|
336
|
+
| `gen_ai.response.model` | Model from the response (`model`, or Google's `modelVersion`) |
|
|
337
|
+
| `gen_ai.response.id` | Response ID (`id`, or Google's `responseId`) |
|
|
338
|
+
| `gen_ai.usage.input_tokens` | Input/prompt tokens (`usage.prompt_tokens`, `usage.input_tokens`, or `usageMetadata.promptTokenCount`) |
|
|
339
|
+
| `gen_ai.usage.output_tokens` | Output/completion tokens (`usage.completion_tokens`, `usage.output_tokens`, or `usageMetadata.candidatesTokenCount`) |
|
|
340
|
+
| `gen_ai.response.finish_reason` | Stop reason (`stop`, `end_turn`, `STOP`, etc.) |
|
|
297
341
|
|
|
298
|
-
Streaming responses (`text/event-stream`)
|
|
342
|
+
**Streaming responses (`text/event-stream`)** are enriched too (0.14+). The body is `tee()`d: your handler gets one branch untouched (byte-for-byte, no added latency); the SDK reads the other **without buffering content** — each `data:` line's JSON is inspected only for `usage` / `usageMetadata`, model, id and finish reason, then discarded. That covers Mistral and OpenAI (usage in the final chunk — for OpenAI send `stream_options: { include_usage: true }`), Anthropic (`message_start` input tokens + `message_delta` output tokens) and Google (`usageMetadata` on the last chunk). The span stays open until the stream closes (or errors), so its duration is the true time-to-last-token. Lines over 64 KB are skipped unparsed; a scanner failure never throws into your stream. Content is never captured from streams, even with `captureContent: true`.
|
|
299
343
|
|
|
300
344
|
**Content capture (opt-in, strongly recommended for AI-app RCA):**
|
|
301
345
|
|
|
@@ -324,8 +368,9 @@ When `captureContent` is enabled, two additional attributes appear on the CLIENT
|
|
|
324
368
|
|
|
325
369
|
**Body safety guarantees:**
|
|
326
370
|
- Request body: only read when it is already a plain `string` (the common LLM SDK case). Non-string bodies (streams, FormData, etc.) are never touched.
|
|
327
|
-
- Response body: read only from `response.clone()
|
|
328
|
-
- Parse failures or unexpected shapes degrade silently to the plain
|
|
371
|
+
- Response body: JSON is read only from `response.clone()`; a stream is `tee()`d and your branch is handed back immediately. Either way the response you receive is intact and your handler can call `.json()` / `.text()` / `.body.getReader()` normally.
|
|
372
|
+
- Parse failures or unexpected shapes degrade silently to the plain span — no errors are thrown.
|
|
373
|
+
- Under native tracing the wrapper needs the request's native tracer in the active context, which propagates across `await`s only with `nodejs_compat` (AsyncLocalStorage). Without it an LLM call made after an `await` passes through untraced — the same caveat as `withSpan`. Use `withCloudflareSpan(ctx, …)` + `genAiResponseAttrs` for a manual span if you cannot enable `nodejs_compat`.
|
|
329
374
|
- For a detected provider with a JSON response, the cloned body is parsed before the `fetch()` promise resolves to your handler (the span must close with usage attributes). This adds negligible latency to an already-slow LLM call.
|
|
330
375
|
- The response size guard (512 KB) only applies when the response carries a `content-length` header; a chunked JSON response without one is still read. The known providers bound this via `max_tokens`, so it is safe in practice.
|
|
331
376
|
|
|
@@ -349,10 +394,35 @@ const data = await withSpan("call-llm", async () => {
|
|
|
349
394
|
});
|
|
350
395
|
```
|
|
351
396
|
|
|
352
|
-
`withSpan(name, attrs?, fn)` — runs `fn` inside a new child span parented to the currently-active span. The span is started before `fn` and ended in `finally`; exceptions are recorded on the span and re-thrown. The `fn` receives the live `Span` as its argument.
|
|
397
|
+
`withSpan(name, attrs?, fn)` — runs `fn` inside a new child span parented to the currently-active span. The span is started before `fn` and ended in `finally`; exceptions are recorded on the span and re-thrown. The `fn` receives the live `Span` as its argument, so you can `span.setAttribute(s)` after the work has produced a result. Under Cloudflare native tracing it joins the native tree; otherwise it is an OTel child span.
|
|
353
398
|
|
|
354
399
|
`addEvent(name, attrs?)` — adds a named event to the currently-active span. No-op when no span is active.
|
|
355
400
|
|
|
401
|
+
#### LLM calls the auto-wrapper can't see (`env.AI.run`, SDKs with their own transport)
|
|
402
|
+
|
|
403
|
+
The automatic `gen_ai.*` enrichment hooks `fetch`. Anything that doesn't go through `fetch` — Workers AI (`env.AI.run`), a binding, an SDK with a custom transport — is invisible to it. `withSpan` plus the two pure helpers `genAiRequestAttrs(provider, requestBody)` and `genAiResponseAttrs(provider, result)` (both exported from `/workers`) is the supported path; it works identically under native tracing and the direct exporter. Name the span `<operation> <provider>` so it lines up with the automatic ones:
|
|
404
|
+
|
|
405
|
+
```ts
|
|
406
|
+
import { instrument, withSpan, genAiRequestAttrs, genAiResponseAttrs } from "@heystack/otel/workers";
|
|
407
|
+
|
|
408
|
+
async function chat(env: Env, prompt: string) {
|
|
409
|
+
const model = "@cf/meta/llama-3.1-8b-instruct";
|
|
410
|
+
return withSpan(
|
|
411
|
+
"chat cloudflare",
|
|
412
|
+
{ ...genAiRequestAttrs("cloudflare", { model, max_tokens: 256 }), "gen_ai.operation.name": "chat" },
|
|
413
|
+
async (span) => {
|
|
414
|
+
const result = await env.AI.run(model, { prompt, max_tokens: 256 });
|
|
415
|
+
// Workers AI returns `usage: { prompt_tokens, completion_tokens }` for most text models;
|
|
416
|
+
// genAiResponseAttrs maps it to gen_ai.usage.input_tokens / output_tokens (no-op if absent).
|
|
417
|
+
span.setAttributes(genAiResponseAttrs("cloudflare", result));
|
|
418
|
+
return result;
|
|
419
|
+
},
|
|
420
|
+
);
|
|
421
|
+
}
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
`genAiRequestAttrs` sets `gen_ai.system` + `gen_ai.request.{model,max_tokens,temperature}`; `genAiResponseAttrs` understands OpenAI/Mistral, Anthropic, Google and Workers AI response shapes and returns `gen_ai.response.{model,id,finish_reason}` + `gen_ai.usage.*`. Neither ever throws or captures prompt/completion text. (If `instrumentBindings` is on under the direct exporter, `env.AI.run` is already traced automatically — use the manual form under native tracing or for other call paths.)
|
|
425
|
+
|
|
356
426
|
### Why a ContextManager
|
|
357
427
|
|
|
358
428
|
`context.with(...)` in OpenTelemetry is a **no-op unless a ContextManager is registered** with the global API. Without one, `suppressTracing()` — the primary defence against the self-trace feedback loop — silently does nothing in production. As of **0.3.2** the SDK registers a ContextManager exactly once at init. With `AsyncLocalStorage` (workerd under `nodejs_compat`, Node) you also get **cross-`await` parent→child span linking** and **per-request context isolation** — concurrent requests no longer share or clobber the active span.
|
|
@@ -545,6 +615,8 @@ As belt-and-suspenders the exporter also drops any span whose HTTP target points
|
|
|
545
615
|
|
|
546
616
|
## Migration / versioning
|
|
547
617
|
|
|
618
|
+
- **`0.15.0`** — **direct Workers D1 session and batch coverage.** With `nativeTracing: "direct"` and `instrumentBindings` enabled, prepared D1 statements, database/session `batch`, database `exec`, and statements created through `withSession` now receive child spans. Native Cloudflare OTel remains the recommended Workers path because it preserves Cloudflare's platform trace/log tree; use direct export only where `ctx.tracing` is unavailable. No breaking changes.
|
|
619
|
+
- **`0.14.0`** — **gen_ai enrichment under Cloudflare native tracing, Mistral + AI-gateway detection, streaming usage; OpenTelemetry JS SDK 2.x.** (1) `/workers`: under `nativeTracing: "auto" | "native"` `instrument()` never installed the fetch wrapper, so native-mode Workers emitted **no** `gen_ai.*` telemetry. It now installs a lean LLM-only wrapper that opens a native `<operation> <provider>` span (e.g. `chat mistral`) with request/response `gen_ai.*` for detected providers and passes every other subrequest through untouched. (2) New provider **Mistral** (`api.mistral.ai`) and a new `ai.gateways` option (`[{ hostSuffix, pathPattern }]`, e.g. `{ hostSuffix: "wafersecurity.ai", pathPattern: "/p/:tenant/:provider" }`) that resolves the provider from an AI-gateway URL and stamps `heystack.ai.gateway`; `gemini` → `google`, `workers-ai` → `cloudflare`. New `gen_ai.operation.name`. (3) **Streaming (`text/event-stream`) responses now yield usage**: the body is `tee()`d and scanned line-by-line for `usage`/`usageMetadata`, model, id and finish reason only (never content); the span stays open until the stream closes. Google (`usageMetadata`) and Mistral response shapes added to the JSON path too. (4) New `/workers` exports `genAiRequestAttrs` / `genAiResponseAttrs` for manual `withSpan` spans around `env.AI.run` or any non-`fetch` LLM call. Native `error.type` now keeps the exception class instead of being overwritten with `error`. (5) All `@opentelemetry/*` dependencies move to the 2.x SDK line (`core`/`sdk-trace-base`/`resources` ^2.11, `sdk-node`/`exporter-trace-otlp-http` ^0.222, `auto-instrumentations-node` ^0.80, `semantic-conventions` ^1.43), clearing the downstream Dependabot alerts the 1.x line surfaced through this package (GHSA-8988-4f7v-96qf in `@opentelemetry/core`, GHSA-q7rr-3cgh-j5r3 in `sdk-node` / `auto-instrumentations-node` / `exporter-prometheus`, GHSA-45rx-2jwx-cxfr in `propagator-jaeger`). **Node ≥ 18.19 (or ≥ 20.6) is now required on `/node` and `/next`** — the 2.x SDK dropped Node 14/16. If you pass your own `instrumentations` array to `initHeystack`, upgrade those `@opentelemetry/instrumentation-*` packages to a release that peers on `@opentelemetry/core@^2` (the auto-instrumentations 0.80 set already does). `/workers` is still WinterCG-safe (no `node:*` imports). No other API changes; all new options are optional.
|
|
548
620
|
- **`0.13.0`** — **Cloudflare-native tracing and complete Workers platform coverage.** On runtimes exposing `ctx.tracing`, `/workers` now joins Cloudflare's authoritative invocation trace instead of creating and exporting a duplicate tree. `nativeTracing: "auto"` is the default; `withCloudflareSpan(ctx, ...)` adds async-safe business spans, while fetch, queue, and scheduled handlers are enriched in the native tree. The new `/workers/agents` entry maps Cloudflare Agents observability callbacks and Tail Worker diagnostics to structured, redacted telemetry. Direct OTLP remains available with `nativeTracing: "direct"` for runtimes without the native API. Heystack ingest now preserves full OTLP trace/log fidelity, accepts OTLP metrics, and can import Workers Analytics metrics through the app-scoped Cloudflare connector. Native mode needs no Worker API-key secret and must not be combined with direct export.
|
|
549
621
|
- **`0.11.0`** — **`/web`: browser error + console collection, in-app bug reports, and seekable replay keyframes.** `instrumentWeb` now captures uncaught errors (`window.onerror` + `unhandledrejection`) and `console.error` as OTLP logs by default (`event.name=browser.error` / `browser.console`, with `exception.*` semconv, `url.full`, `session_id`, and the active trace/span ids when `tracing` is on). New options: `errors?: boolean` (default `true`), `captureConsole?: 'error' | 'warn' | false` (default `'error'`). New **`reportBug({ message, email?, context? })`** API — a headless in-app bug reporter that POSTs to `/v1/bug-reports` and auto-attaches the URL, user agent, `session_id`, active `trace_id`, `release`/`build`, and the last ≤20 captured browser errors (also emitted as a `user.bug_report` log); reports triage in the console **Bugs** tab. The `version` / `build` options are now stamped as `service.version` / `service.build` on exported browser logs (release attribution). Console capture is recursion-guarded + rate-capped (no self-export loop, no flood). The recorder also checkpoints a keyframe (~60s) so the console player seeks from the nearest snapshot instead of loading the whole session. No breaking changes; all new options are optional.
|
|
550
622
|
- **`0.10.0`** — **release / commit attribution (`version` + `build`) on every runtime entry.** New optional options: `version` → the `service.version` resource attribute (a release identifier such as `1.4.2` or a git tag), `build` → the `service.build` resource attribute (the commit SHA). They power **release health**, **suspect release**, and **suspect commit** in the console — attributing a regression to the version/commit that introduced it (suspect-commit deep-links to the commit when a repo URL is configured for the app). Wired on `/node`, `/next` (threaded to whichever runtime runs), and `/workers`; accepted on `/web` for API symmetry. `/node` also reads `HEYSTACK_SERVICE_VERSION` / `OTEL_SERVICE_VERSION` and `HEYSTACK_SERVICE_BUILD` as env fallbacks. Both options are optional and only emitted when non-empty. No breaking changes. See [Release & commit attribution](#release--commit-attribution-version--build).
|
|
@@ -576,3 +648,13 @@ As belt-and-suspenders the exporter also drops any span whose HTTP target points
|
|
|
576
648
|
- Short-lived processes: `initHeystack` registers `SIGTERM`/`SIGINT` handlers automatically, so the SDK flushes and shuts down before exit and you don't lose the last batch.
|
|
577
649
|
|
|
578
650
|
Then run your app and make a request — traces appear in your Heystack dashboard within seconds.
|
|
651
|
+
|
|
652
|
+
## Investigate with your coding agent
|
|
653
|
+
|
|
654
|
+
Once telemetry is flowing, connect your coding agent to the hosted **Heystack MCP server** and it can verify the setup (`heystack_verify_setup`), investigate incidents from your traces, sessions and releases, and propose the fix in your code:
|
|
655
|
+
|
|
656
|
+
```bash
|
|
657
|
+
claude mcp add --transport http heystack https://mcp.heystack.dev/mcp
|
|
658
|
+
```
|
|
659
|
+
|
|
660
|
+
One-click links for Cursor and VS Code, commands for Codex/Gemini CLI, personal access tokens for CI, and the full tool reference are in the docs: **https://heystack.dev/docs/mcp**.
|
package/dist/llm-enrich.d.ts
CHANGED
|
@@ -1,6 +1,41 @@
|
|
|
1
|
-
export type LLMProvider = "openai" | "anthropic" | "cloudflare" | "google";
|
|
1
|
+
export type LLMProvider = "openai" | "anthropic" | "cloudflare" | "google" | "mistral";
|
|
2
2
|
/** Return the provider for a known LLM host, else null. Host is lower-case, no port. */
|
|
3
3
|
export declare function detectLLMProvider(host: string): LLMProvider | null;
|
|
4
|
+
export interface LLMGatewayConfig {
|
|
5
|
+
/**
|
|
6
|
+
* Gateway hostname. Matches the exact host or any subdomain of it
|
|
7
|
+
* (`wafersecurity.ai` matches `wafersecurity.ai` and `gw.wafersecurity.ai`,
|
|
8
|
+
* never `notwafersecurity.ai`). A leading dot is tolerated.
|
|
9
|
+
*/
|
|
10
|
+
hostSuffix: string;
|
|
11
|
+
/**
|
|
12
|
+
* Path pattern whose `:provider` segment names the upstream provider, e.g.
|
|
13
|
+
* `/p/:tenant/:provider`. Literal segments must match exactly; other `:param`
|
|
14
|
+
* segments match any single segment; the request path may carry further
|
|
15
|
+
* segments after the pattern (the provider's own API path).
|
|
16
|
+
*/
|
|
17
|
+
pathPattern: string;
|
|
18
|
+
}
|
|
19
|
+
export interface ResolvedLLMProvider {
|
|
20
|
+
provider: LLMProvider;
|
|
21
|
+
/** Set (to the gateway hostname) when the provider was resolved via a gateway. */
|
|
22
|
+
gateway?: string;
|
|
23
|
+
}
|
|
24
|
+
/** Map a gateway path token to a provider. `gemini` → google, `workers-ai` → cloudflare. */
|
|
25
|
+
export declare function providerFromToken(token: string): LLMProvider | null;
|
|
26
|
+
/**
|
|
27
|
+
* Resolve the LLM provider for an outbound URL: direct host table first, then
|
|
28
|
+
* each configured gateway pattern. Returns null when neither matches. Pure and
|
|
29
|
+
* exception-free (a malformed gateway entry is skipped, never thrown).
|
|
30
|
+
*/
|
|
31
|
+
export declare function resolveLLMProvider(url: URL, gateways?: readonly LLMGatewayConfig[]): ResolvedLLMProvider | null;
|
|
32
|
+
/**
|
|
33
|
+
* Best-effort `gen_ai.operation.name` from the request path. Chat-style
|
|
34
|
+
* endpoints (OpenAI/Mistral `chat/completions`, Anthropic `messages`, Google
|
|
35
|
+
* `*generateContent`) → `chat`; `embeddings` → `embeddings`; bare/fim
|
|
36
|
+
* `completions` → `text_completion`; anything else defaults to `chat`.
|
|
37
|
+
*/
|
|
38
|
+
export declare function llmOperationName(pathname: string): "chat" | "embeddings" | "text_completion";
|
|
4
39
|
export interface LLMRequestAttrs {
|
|
5
40
|
[k: string]: string | number;
|
|
6
41
|
}
|
|
@@ -8,6 +43,33 @@ export interface LLMRequestAttrs {
|
|
|
8
43
|
export declare function llmRequestAttrs(provider: LLMProvider, body: unknown): LLMRequestAttrs;
|
|
9
44
|
/** Best-effort gen_ai.response.* + usage from a parsed JSON response body. Never throws. */
|
|
10
45
|
export declare function llmResponseAttrs(provider: LLMProvider, body: unknown): Record<string, string | number>;
|
|
46
|
+
/** Lines longer than this are skipped unparsed (a bound on per-chunk JSON.parse). */
|
|
47
|
+
export declare const SSE_MAX_LINE_BYTES: number;
|
|
48
|
+
/**
|
|
49
|
+
* Metadata attrs from ONE parsed stream chunk. Shares the response mapper and
|
|
50
|
+
* adds the Anthropic envelope (`message.{id,model,usage}` on `message_start`,
|
|
51
|
+
* `delta.stop_reason` on `message_delta`). Never throws.
|
|
52
|
+
*/
|
|
53
|
+
export declare function llmStreamChunkAttrs(provider: LLMProvider, chunk: unknown): Record<string, string | number>;
|
|
54
|
+
export interface SseUsageScanner {
|
|
55
|
+
/** Feed decoded text (any chunk boundary). Never throws. */
|
|
56
|
+
feed(text: string): void;
|
|
57
|
+
/** Flush a trailing partial line and return the accumulated attrs. */
|
|
58
|
+
result(): Record<string, string | number>;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Incremental SSE scanner: buffers at most one partial line, parses complete
|
|
62
|
+
* `data:` lines for usage/model/id/finish_reason and drops everything else
|
|
63
|
+
* immediately. Lines over `SSE_MAX_LINE_BYTES` are skipped without parsing.
|
|
64
|
+
*/
|
|
65
|
+
export declare function createSseUsageScanner(provider: LLMProvider): SseUsageScanner;
|
|
66
|
+
/**
|
|
67
|
+
* Drain a (teed) SSE body through the scanner and resolve with the accumulated
|
|
68
|
+
* metadata attrs when the stream closes. Resolves — never rejects — on a stream
|
|
69
|
+
* error, returning whatever was scanned so far. Reads chunk-by-chunk with a
|
|
70
|
+
* streaming `TextDecoder`, so the body is never buffered.
|
|
71
|
+
*/
|
|
72
|
+
export declare function scanSseStreamForUsage(stream: ReadableStream<Uint8Array>, provider: LLMProvider): Promise<Record<string, string | number>>;
|
|
11
73
|
/** Content attrs, ONLY when captureContent is on. Size-capped per value, redactor applied. */
|
|
12
74
|
export declare function llmContentAttrs(provider: LLMProvider, reqBody: unknown, resBody: unknown, opts: {
|
|
13
75
|
redact?: (text: string) => string;
|