@brizz/sdk 0.1.46 → 0.1.48

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 CHANGED
@@ -106,7 +106,7 @@ Pass the libraries you use to `instrumentModules` and the SDK traces them:
106
106
  - **OpenAI** - `openai` package
107
107
  - **Anthropic** - `@anthropic-ai/sdk` package
108
108
  - **Vercel AI SDK** - `ai` package (generateText, streamText, etc.)
109
- - Captured through `experimental_telemetry: { isEnabled: true }` on each call, not `instrumentModules`
109
+ - Captured through the AI SDK's own telemetry, not `instrumentModules` — on by default on `ai@7` (with `@ai-sdk/otel` installed); on `ai@6` and earlier, pass `experimental_telemetry: { isEnabled: true }` on each call
110
110
  - **LangChain** - `langchain` and `@langchain/*` packages
111
111
  - **LlamaIndex** - `llamaindex` package
112
112
  - **AWS Bedrock** - `@aws-sdk/client-bedrock-runtime`
@@ -135,7 +135,7 @@ On `ai@7` and newer, also install `@ai-sdk/otel` — v7 moved AI SDK span collec
135
135
  into that package, so without it your `generateText` / `streamText` calls produce no
136
136
  spans. It isn't needed on `ai@6`.
137
137
 
138
- For Vercel AI SDK instrumentation, you need to enable telemetry in your function calls:
138
+ On `ai@6` and earlier, telemetry is off by default, so enable it on each call. On `ai@7` it is on by default and the flag is optional:
139
139
 
140
140
  ```typescript
141
141
  import { generateText, streamText } from 'ai';
@@ -145,14 +145,14 @@ import { openai } from '@ai-sdk/openai';
145
145
  const result = await generateText({
146
146
  model: openai('gpt-4'),
147
147
  prompt: 'Hello, world!',
148
- experimental_telemetry: { isEnabled: true }, // Required for instrumentation
148
+ experimental_telemetry: { isEnabled: true }, // Required on ai@6 and earlier
149
149
  });
150
150
 
151
151
  // For streamText
152
152
  const stream = streamText({
153
153
  model: openai('gpt-4'),
154
154
  messages: [{ role: 'user', content: 'Hello!' }],
155
- experimental_telemetry: { isEnabled: true }, // Required for instrumentation
155
+ experimental_telemetry: { isEnabled: true }, // Required on ai@6 and earlier
156
156
  });
157
157
  ```
158
158
 
@@ -532,6 +532,21 @@ recordMetric({
532
532
 
533
533
  `attributes` are flat labels you can slice the metric by. Re-reporting the same metric supersedes the previous value, so a re-score wins over the original.
534
534
 
535
+ An offline evaluation job often scores conversations from several services in one process. Pass `serviceName` to report each metric under the service it belongs to, and `traceId` when you have a trace of the conversation rather than its session id:
536
+
537
+ ```typescript
538
+ for (const row of evalResults) {
539
+ recordMetric({
540
+ name: 'resolved',
541
+ value: row.resolved,
542
+ serviceName: row.service, // e.g. 'support-agent'
543
+ traceId: row.traceId, // 32 hex characters
544
+ });
545
+ }
546
+ ```
547
+
548
+ A metric needs a session id or a trace id to land on a conversation; one with neither is dropped with a warning.
549
+
535
550
  ### Custom Properties
536
551
 
537
552
  Add custom properties to telemetry context:
@@ -870,7 +885,7 @@ Check out the [examples](./examples/) directory for complete working examples:
870
885
  - Ensure `Brizz.initialize()` runs before any AI calls
871
886
  - Pass the libraries you want to trace via `instrumentModules`
872
887
  - Check that `BRIZZ_API_KEY` is set
873
- - For Vercel AI SDK: Add `experimental_telemetry: { isEnabled: true }` to function calls
888
+ - For Vercel AI SDK: on `ai@7`, install `@ai-sdk/otel`; on `ai@6` and earlier, add `experimental_telemetry: { isEnabled: true }` to function calls
874
889
 
875
890
  **CJS/ESM compatibility issues**
876
891
 
@@ -1,6 +1,6 @@
1
1
  import {
2
2
  INTERRUPT_TOOLS
3
- } from "./chunk-AOT5NJDV.js";
3
+ } from "./chunk-FVVRWMPV.js";
4
4
 
5
5
  // src/internal/instrumentation/vercel-ai/interrupt.ts
6
6
  import { trace } from "@opentelemetry/api";
@@ -1,6 +1,6 @@
1
1
  "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }
2
2
 
3
- var _chunk5WBPX342cjs = require('./chunk-5WBPX342.cjs');
3
+ var _chunkGMZQ6N77cjs = require('./chunk-GMZQ6N77.cjs');
4
4
 
5
5
  // src/internal/instrumentation/vercel-ai/interrupt.ts
6
6
  var _api = require('@opentelemetry/api');
@@ -78,7 +78,7 @@ function createInterruptIntegration() {
78
78
  return;
79
79
  }
80
80
  const value = JSON.stringify(names);
81
- span.setAttribute(_chunk5WBPX342cjs.INTERRUPT_TOOLS, value);
81
+ span.setAttribute(_chunkGMZQ6N77cjs.INTERRUPT_TOOLS, value);
82
82
  setPending(span.spanContext().spanId, value);
83
83
  };
84
84
  return {
@@ -94,7 +94,7 @@ var InterruptPropagator = class {
94
94
  const parentSpanId = _optionalChain([span, 'access', _ => _.parentSpanContext, 'optionalAccess', _2 => _2.spanId]);
95
95
  const stashed = parentSpanId && pendingByParentSpanId.get(parentSpanId);
96
96
  if (stashed) {
97
- span.setAttribute(_chunk5WBPX342cjs.INTERRUPT_TOOLS, stashed);
97
+ span.setAttribute(_chunkGMZQ6N77cjs.INTERRUPT_TOOLS, stashed);
98
98
  pendingByParentSpanId.delete(parentSpanId);
99
99
  return;
100
100
  }
@@ -104,7 +104,7 @@ var InterruptPropagator = class {
104
104
  const scoped = parsePromptToolNames(span.attributes["ai.prompt.tools"]);
105
105
  const names = scoped === null ? [...needsApprovalToolNames] : scoped.filter((n) => needsApprovalToolNames.has(n));
106
106
  if (names.length > 0) {
107
- span.setAttribute(_chunk5WBPX342cjs.INTERRUPT_TOOLS, JSON.stringify(names));
107
+ span.setAttribute(_chunkGMZQ6N77cjs.INTERRUPT_TOOLS, JSON.stringify(names));
108
108
  }
109
109
  }
110
110
  onEnd() {
@@ -53,6 +53,7 @@ var METRIC_POLARITY = "brizz.internal.metric.polarity";
53
53
  var METRIC_MIN = "brizz.internal.metric.min";
54
54
  var METRIC_MAX = "brizz.internal.metric.max";
55
55
  var METRIC_TIMESTAMP = "brizz.internal.metric.timestamp";
56
+ var METRIC_TRACE_ID = "brizz.internal.metric.trace_id";
56
57
  var METRIC_ATTRIBUTE_PREFIX = "brizz.internal.metric.attribute.";
57
58
  var RESERVED_METRIC_NAMES = /* @__PURE__ */ new Set([
58
59
  "faithfulness",
@@ -122,6 +123,7 @@ export {
122
123
  METRIC_MIN,
123
124
  METRIC_MAX,
124
125
  METRIC_TIMESTAMP,
126
+ METRIC_TRACE_ID,
125
127
  METRIC_ATTRIBUTE_PREFIX,
126
128
  RESERVED_METRIC_NAMES,
127
129
  METRIC_POLARITY_POSITIVE,
@@ -53,6 +53,7 @@ var METRIC_POLARITY = "brizz.internal.metric.polarity";
53
53
  var METRIC_MIN = "brizz.internal.metric.min";
54
54
  var METRIC_MAX = "brizz.internal.metric.max";
55
55
  var METRIC_TIMESTAMP = "brizz.internal.metric.timestamp";
56
+ var METRIC_TRACE_ID = "brizz.internal.metric.trace_id";
56
57
  var METRIC_ATTRIBUTE_PREFIX = "brizz.internal.metric.attribute.";
57
58
  var RESERVED_METRIC_NAMES = /* @__PURE__ */ new Set([
58
59
  "faithfulness",
@@ -126,4 +127,5 @@ var METRIC_POLARITY_NEGATIVE = "negative";
126
127
 
127
128
 
128
129
 
129
- exports.BRIZZ = BRIZZ; exports.SESSION_ID = SESSION_ID; exports.PROPERTIES_CONTEXT_KEY = PROPERTIES_CONTEXT_KEY; exports.SESSION_OBJECT_CONTEXT_KEY = SESSION_OBJECT_CONTEXT_KEY; exports.SESSION_INPUT = SESSION_INPUT; exports.SESSION_OUTPUT = SESSION_OUTPUT; exports.SESSION_INPUT_CONTEXT = SESSION_INPUT_CONTEXT; exports.SESSION_OUTPUT_CONTEXT = SESSION_OUTPUT_CONTEXT; exports.SESSION_SPAN_NAME = SESSION_SPAN_NAME; exports.MUTE_INPUT = MUTE_INPUT; exports.MUTE_OUTPUT = MUTE_OUTPUT; exports.MUTE_TOOLS = MUTE_TOOLS; exports.USER_ID = USER_ID; exports.USER_EMAIL = USER_EMAIL; exports.USER_NAME = USER_NAME; exports.USER_ROLE = USER_ROLE; exports.USER_PLAN = USER_PLAN; exports.ORGANIZATION_ID = ORGANIZATION_ID; exports.ORGANIZATION_NAME = ORGANIZATION_NAME; exports.ORGANIZATION_PLAN = ORGANIZATION_PLAN; exports.ORGANIZATION_DOMAIN = ORGANIZATION_DOMAIN; exports.MESSAGE_ID = MESSAGE_ID; exports.SERVICE_NAME = SERVICE_NAME; exports.SERVICE_NAME_ATTRIBUTE = SERVICE_NAME_ATTRIBUTE; exports.SESSION_TITLE_SPAN_NAME = SESSION_TITLE_SPAN_NAME; exports.SESSION_TITLE_GENERATION = SESSION_TITLE_GENERATION; exports.SESSION_TITLE = SESSION_TITLE; exports.AGENT_ID = AGENT_ID; exports.AGENT_PARENT_ID = AGENT_PARENT_ID; exports.AGENT_NAME = AGENT_NAME; exports.INTERRUPT_TOOLS = INTERRUPT_TOOLS; exports.INTERNAL_EVENT_PREFIX = INTERNAL_EVENT_PREFIX; exports.EXTERNAL_LINK_EVENT_NAME = EXTERNAL_LINK_EVENT_NAME; exports.EXTERNAL_LINK_URL = EXTERNAL_LINK_URL; exports.EXTERNAL_LINK_TITLE = EXTERNAL_LINK_TITLE; exports.EXTERNAL_LINK_TYPE = EXTERNAL_LINK_TYPE; exports.FEEDBACK_EVENT_NAME = FEEDBACK_EVENT_NAME; exports.FEEDBACK_TYPE = FEEDBACK_TYPE; exports.FEEDBACK_SCORE = FEEDBACK_SCORE; exports.FEEDBACK_REASON = FEEDBACK_REASON; exports.FEEDBACK_COMMENT = FEEDBACK_COMMENT; exports.FEEDBACK_SOURCE = FEEDBACK_SOURCE; exports.FEEDBACK_ATTR_PREFIX = FEEDBACK_ATTR_PREFIX; exports.METRIC_EVENT_NAME = METRIC_EVENT_NAME; exports.METRIC_NAME = METRIC_NAME; exports.METRIC_VALUE = METRIC_VALUE; exports.METRIC_UNIT = METRIC_UNIT; exports.METRIC_COMMENT = METRIC_COMMENT; exports.METRIC_POLARITY = METRIC_POLARITY; exports.METRIC_MIN = METRIC_MIN; exports.METRIC_MAX = METRIC_MAX; exports.METRIC_TIMESTAMP = METRIC_TIMESTAMP; exports.METRIC_ATTRIBUTE_PREFIX = METRIC_ATTRIBUTE_PREFIX; exports.RESERVED_METRIC_NAMES = RESERVED_METRIC_NAMES; exports.METRIC_POLARITY_POSITIVE = METRIC_POLARITY_POSITIVE; exports.METRIC_POLARITY_NEGATIVE = METRIC_POLARITY_NEGATIVE;
130
+
131
+ exports.BRIZZ = BRIZZ; exports.SESSION_ID = SESSION_ID; exports.PROPERTIES_CONTEXT_KEY = PROPERTIES_CONTEXT_KEY; exports.SESSION_OBJECT_CONTEXT_KEY = SESSION_OBJECT_CONTEXT_KEY; exports.SESSION_INPUT = SESSION_INPUT; exports.SESSION_OUTPUT = SESSION_OUTPUT; exports.SESSION_INPUT_CONTEXT = SESSION_INPUT_CONTEXT; exports.SESSION_OUTPUT_CONTEXT = SESSION_OUTPUT_CONTEXT; exports.SESSION_SPAN_NAME = SESSION_SPAN_NAME; exports.MUTE_INPUT = MUTE_INPUT; exports.MUTE_OUTPUT = MUTE_OUTPUT; exports.MUTE_TOOLS = MUTE_TOOLS; exports.USER_ID = USER_ID; exports.USER_EMAIL = USER_EMAIL; exports.USER_NAME = USER_NAME; exports.USER_ROLE = USER_ROLE; exports.USER_PLAN = USER_PLAN; exports.ORGANIZATION_ID = ORGANIZATION_ID; exports.ORGANIZATION_NAME = ORGANIZATION_NAME; exports.ORGANIZATION_PLAN = ORGANIZATION_PLAN; exports.ORGANIZATION_DOMAIN = ORGANIZATION_DOMAIN; exports.MESSAGE_ID = MESSAGE_ID; exports.SERVICE_NAME = SERVICE_NAME; exports.SERVICE_NAME_ATTRIBUTE = SERVICE_NAME_ATTRIBUTE; exports.SESSION_TITLE_SPAN_NAME = SESSION_TITLE_SPAN_NAME; exports.SESSION_TITLE_GENERATION = SESSION_TITLE_GENERATION; exports.SESSION_TITLE = SESSION_TITLE; exports.AGENT_ID = AGENT_ID; exports.AGENT_PARENT_ID = AGENT_PARENT_ID; exports.AGENT_NAME = AGENT_NAME; exports.INTERRUPT_TOOLS = INTERRUPT_TOOLS; exports.INTERNAL_EVENT_PREFIX = INTERNAL_EVENT_PREFIX; exports.EXTERNAL_LINK_EVENT_NAME = EXTERNAL_LINK_EVENT_NAME; exports.EXTERNAL_LINK_URL = EXTERNAL_LINK_URL; exports.EXTERNAL_LINK_TITLE = EXTERNAL_LINK_TITLE; exports.EXTERNAL_LINK_TYPE = EXTERNAL_LINK_TYPE; exports.FEEDBACK_EVENT_NAME = FEEDBACK_EVENT_NAME; exports.FEEDBACK_TYPE = FEEDBACK_TYPE; exports.FEEDBACK_SCORE = FEEDBACK_SCORE; exports.FEEDBACK_REASON = FEEDBACK_REASON; exports.FEEDBACK_COMMENT = FEEDBACK_COMMENT; exports.FEEDBACK_SOURCE = FEEDBACK_SOURCE; exports.FEEDBACK_ATTR_PREFIX = FEEDBACK_ATTR_PREFIX; exports.METRIC_EVENT_NAME = METRIC_EVENT_NAME; exports.METRIC_NAME = METRIC_NAME; exports.METRIC_VALUE = METRIC_VALUE; exports.METRIC_UNIT = METRIC_UNIT; exports.METRIC_COMMENT = METRIC_COMMENT; exports.METRIC_POLARITY = METRIC_POLARITY; exports.METRIC_MIN = METRIC_MIN; exports.METRIC_MAX = METRIC_MAX; exports.METRIC_TIMESTAMP = METRIC_TIMESTAMP; exports.METRIC_TRACE_ID = METRIC_TRACE_ID; exports.METRIC_ATTRIBUTE_PREFIX = METRIC_ATTRIBUTE_PREFIX; exports.RESERVED_METRIC_NAMES = RESERVED_METRIC_NAMES; exports.METRIC_POLARITY_POSITIVE = METRIC_POLARITY_POSITIVE; exports.METRIC_POLARITY_NEGATIVE = METRIC_POLARITY_NEGATIVE;
@@ -5,11 +5,11 @@ var _chunkWC573FCIcjs = require('./chunk-WC573FCI.cjs');
5
5
 
6
6
 
7
7
 
8
- var _chunk5WBPX342cjs = require('./chunk-5WBPX342.cjs');
8
+ var _chunkGMZQ6N77cjs = require('./chunk-GMZQ6N77.cjs');
9
9
 
10
10
  // src/internal/version.ts
11
11
  function getSDKVersion() {
12
- return "0.1.46";
12
+ return "0.1.48";
13
13
  }
14
14
 
15
15
  // src/internal/instrumentation/mcp/session.ts
@@ -42,8 +42,8 @@ function resolveSessionId(protocol, baseContext) {
42
42
  return fromTransport;
43
43
  }
44
44
  try {
45
- const bound = baseContext.getValue(_chunk5WBPX342cjs.PROPERTIES_CONTEXT_KEY);
46
- if (_optionalChain([bound, 'optionalAccess', _3 => _3[_chunk5WBPX342cjs.SESSION_ID]])) {
45
+ const bound = baseContext.getValue(_chunkGMZQ6N77cjs.PROPERTIES_CONTEXT_KEY);
46
+ if (_optionalChain([bound, 'optionalAccess', _3 => _3[_chunkGMZQ6N77cjs.SESSION_ID]])) {
47
47
  return void 0;
48
48
  }
49
49
  } catch (e) {
@@ -57,7 +57,7 @@ function stampAndPropagateSession(span, sessionId, baseContext = _api.context.ac
57
57
  }
58
58
  const properties = {};
59
59
  if (sessionId) {
60
- properties[_chunk5WBPX342cjs.SESSION_ID] = sessionId;
60
+ properties[_chunkGMZQ6N77cjs.SESSION_ID] = sessionId;
61
61
  }
62
62
  if (intent) {
63
63
  properties[INTENT_PROPERTY] = intent;
@@ -65,17 +65,17 @@ function stampAndPropagateSession(span, sessionId, baseContext = _api.context.ac
65
65
  if (span.isRecording()) {
66
66
  for (const [key, value] of Object.entries(properties)) {
67
67
  try {
68
- span.setAttribute(`${_chunk5WBPX342cjs.BRIZZ}.${key}`, value);
68
+ span.setAttribute(`${_chunkGMZQ6N77cjs.BRIZZ}.${key}`, value);
69
69
  } catch (error) {
70
70
  _chunkWC573FCIcjs.logger.warn(`Brizz MCP: failed to stamp ${key} on span: ${String(error)}`);
71
71
  }
72
72
  }
73
73
  }
74
74
  try {
75
- const prev = baseContext.getValue(_chunk5WBPX342cjs.PROPERTIES_CONTEXT_KEY);
75
+ const prev = baseContext.getValue(_chunkGMZQ6N77cjs.PROPERTIES_CONTEXT_KEY);
76
76
  const merged = prev ? { ...prev, ...properties } : properties;
77
77
  return {
78
- context: baseContext.setValue(_chunk5WBPX342cjs.PROPERTIES_CONTEXT_KEY, merged),
78
+ context: baseContext.setValue(_chunkGMZQ6N77cjs.PROPERTIES_CONTEXT_KEY, merged),
79
79
  sessionId: _nullishCoalesce(sessionId, () => ( null))
80
80
  };
81
81
  } catch (error) {
@@ -5,11 +5,11 @@ import {
5
5
  BRIZZ,
6
6
  PROPERTIES_CONTEXT_KEY,
7
7
  SESSION_ID
8
- } from "./chunk-AOT5NJDV.js";
8
+ } from "./chunk-FVVRWMPV.js";
9
9
 
10
10
  // src/internal/version.ts
11
11
  function getSDKVersion() {
12
- return "0.1.46";
12
+ return "0.1.48";
13
13
  }
14
14
 
15
15
  // src/internal/instrumentation/mcp/session.ts