@glassflow-ai/rius 0.5.0 → 0.6.1

package/README.md

@@ -39,7 +39,8 @@ await client.ready;
 
 // 1. Function wrapper — trace a whole call. Use a named function expression
 //    (or pass { name }): an arrow function has no inferrable name and its
-//    span would fall back to "anonymous".
+//    span would fall back to "anonymous". The wrapper always returns a
+//    Promise, even for a synchronous function.
 const handle = observe(async function handle(query: string) {
   return await callModel(query);
 });
@@ -232,12 +233,13 @@ variables, then the defaults below.
 | `disabled`         | `RIUS_DISABLED`          | `false`                                       |
 | `sampleRate`       | `RIUS_SAMPLE_RATE`       | `1.0`                                         |
 | `captureContent`   | `RIUS_CAPTURE_CONTENT`   | `true`                                        |
-| `mask`             | (options only)           | none                                          |
+| `mask`             | (options only)           | none (`(value, { key }) => unknown`; the return value is stored, JSON-encoded if not a primitive; return `""` to blank) |
 | `heartbeat`        | `RIUS_HEARTBEAT`         | `true`                                        |
 | `heartbeatInterval` | `RIUS_HEARTBEAT_INTERVAL` | `15` (seconds; clamped 5-300)               |
 | `agentName`        | `RIUS_AGENT_NAME`        | `serviceName`                                 |
 | `partialSpans`     | `RIUS_PARTIAL_SPANS`     | `false`                                       |
 | `partialSpansDelay` | `RIUS_PARTIAL_SPANS_DELAY` | `0` (seconds; clamped 0-60)                |
+| `sessionId`        | `RIUS_SESSION_ID`        | none (process-wide session default; `withSession` overrides it) |
 
 Traces are posted to `<endpoint>/v1/traces`.
 
@@ -245,15 +247,20 @@ Traces are posted to `<endpoint>/v1/traces`.
 completions, tool arguments) is attached to spans. It defaults to
 `true`. Set it to `false`, or supply a `mask` function, if your spans
 must not carry raw content. Both apply to span attributes and to the
-attributes of span events and links. With `captureContent: false` the
+attributes of span events and links, including the `metadata.*` copies the
+Vercel AI SDK transform makes of attributes it does not translate: a
+`metadata.<key>` is content exactly when `<key>` is. With `captureContent: false` the
 message and stacktrace of a recorded exception are stripped as well,
 since provider errors routinely echo the request back; the exception
 event and its `exception.type` are kept, so failures stay visible.
-`mask` does not extend that far: with `captureContent: true`, a `mask`
-function scrubs content attributes on spans, events and links, but
-exception messages, stacktraces and the status message pass through
-unmasked, so a raw provider error can still reach your backend. Disable
-`captureContent` if you need those scrubbed too.
+The span's ERROR status message carries the same string, so it is
+blanked too; the status code stays. A `mask` function scrubs content
+attributes on spans, events and links, and runs over the status message
+as well (its `key` is `status.description`). It does not reach the
+exception event: with `captureContent: true`, exception messages and
+stacktraces pass through unmasked, so a raw provider error can still
+reach your backend that way. Disable `captureContent` if you need those
+scrubbed too.
 
 `disabled` turns the SDK off completely: nothing is exported, and no
 optional integration is loaded, so no third-party module is patched in your