@mastra/mcp-docs-server 0.13.45 → 0.13.46-alpha.1
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/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +9 -9
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +86 -86
- package/.docs/organized/changelogs/%40mastra%2Fcloud.md +52 -52
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +55 -55
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +23 -23
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +9 -9
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +9 -9
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +9 -9
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +32 -32
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +12 -12
- package/.docs/organized/changelogs/%40mastra%2Flance.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +15 -15
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +9 -9
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +12 -12
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +11 -11
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +26 -26
- package/.docs/organized/changelogs/%40mastra%2Freact.md +15 -15
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +6 -0
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +61 -61
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +12 -12
- package/.docs/organized/changelogs/create-mastra.md +13 -13
- package/.docs/organized/changelogs/mastra.md +26 -26
- package/.docs/raw/observability/otel-tracing.mdx +17 -2
- package/.docs/raw/observability/overview.mdx +12 -2
- package/.docs/raw/rag/vector-databases.mdx +58 -0
- package/.docs/raw/reference/streaming/workflows/timeTravelStream.mdx +170 -0
- package/.docs/raw/reference/workflows/run-methods/restart.mdx +98 -0
- package/.docs/raw/reference/workflows/run-methods/timeTravel.mdx +310 -0
- package/.docs/raw/reference/workflows/run.mdx +21 -0
- package/.docs/raw/reference/workflows/step.mdx +7 -0
- package/.docs/raw/reference/workflows/workflow.mdx +19 -0
- package/.docs/raw/server-db/mastra-server.mdx +1 -1
- package/.docs/raw/workflows/error-handling.mdx +1 -0
- package/.docs/raw/workflows/overview.mdx +56 -44
- package/.docs/raw/workflows/snapshots.mdx +1 -0
- package/.docs/raw/workflows/suspend-and-resume.mdx +2 -0
- package/.docs/raw/workflows/time-travel.mdx +313 -0
- package/.docs/raw/workflows/workflow-state.mdx +191 -0
- package/CHANGELOG.md +14 -0
- package/package.json +3 -3
|
@@ -1,5 +1,65 @@
|
|
|
1
1
|
# @mastra/server
|
|
2
2
|
|
|
3
|
+
## 0.24.7-alpha.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Add timeTravel APIs and add timeTravel feature to studio ([#10757](https://github.com/mastra-ai/mastra/pull/10757))
|
|
8
|
+
|
|
9
|
+
- feat: Add partial response support for agent and workflow list endpoints ([#10906](https://github.com/mastra-ai/mastra/pull/10906))
|
|
10
|
+
|
|
11
|
+
Add optional `partial` query parameter to `/api/agents` and `/api/workflows` endpoints to return minimal data without schemas, reducing payload size for list views:
|
|
12
|
+
- When `partial=true`: tool schemas (inputSchema, outputSchema) are omitted
|
|
13
|
+
- When `partial=true`: workflow steps are replaced with stepCount integer
|
|
14
|
+
- When `partial=true`: workflow root schemas (inputSchema, outputSchema) are omitted
|
|
15
|
+
- Maintains backward compatibility when partial parameter is not provided
|
|
16
|
+
|
|
17
|
+
## Server Endpoint Usage
|
|
18
|
+
|
|
19
|
+
```http
|
|
20
|
+
# Get partial agent data (no tool schemas)
|
|
21
|
+
GET /api/agents?partial=true
|
|
22
|
+
|
|
23
|
+
# Get full agent data (default behavior)
|
|
24
|
+
GET /api/agents
|
|
25
|
+
|
|
26
|
+
# Get partial workflow data (stepCount instead of steps, no schemas)
|
|
27
|
+
GET /api/workflows?partial=true
|
|
28
|
+
|
|
29
|
+
# Get full workflow data (default behavior)
|
|
30
|
+
GET /api/workflows
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Client SDK Usage
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
import { MastraClient } from '@mastra/client-js';
|
|
37
|
+
|
|
38
|
+
const client = new MastraClient({ baseUrl: 'http://localhost:4111' });
|
|
39
|
+
|
|
40
|
+
// Get partial agent list (smaller payload)
|
|
41
|
+
const partialAgents = await client.listAgents({ partial: true });
|
|
42
|
+
|
|
43
|
+
// Get full agent list with tool schemas
|
|
44
|
+
const fullAgents = await client.listAgents();
|
|
45
|
+
|
|
46
|
+
// Get partial workflow list (smaller payload)
|
|
47
|
+
const partialWorkflows = await client.listWorkflows({ partial: true });
|
|
48
|
+
|
|
49
|
+
// Get full workflow list with steps and schemas
|
|
50
|
+
const fullWorkflows = await client.listWorkflows();
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
- Updated dependencies [[`5cc85aa`](https://github.com/mastra-ai/mastra/commit/5cc85aa4329773cac8314f3aa0146227b6b158e4), [`c53f8e6`](https://github.com/mastra-ai/mastra/commit/c53f8e68df42464935f9a63eb0fc765a65aacb83), [`386ab43`](https://github.com/mastra-ai/mastra/commit/386ab4350cf2a814fb4ac0a5fc6983ca93158ffe), [`2b62302`](https://github.com/mastra-ai/mastra/commit/2b623027a9d65c1dbc963bf651e9e6a9d09da1fa), [`7d85da4`](https://github.com/mastra-ai/mastra/commit/7d85da42a5fab56009a959a9c20328558d14f4b5), [`3d7c5bd`](https://github.com/mastra-ai/mastra/commit/3d7c5bdbee1b2693cd45bf207b960dd9b7277680), [`31b381e`](https://github.com/mastra-ai/mastra/commit/31b381efb48e031c0ecc46bc6e410ae6e67b88e5), [`e77a5f9`](https://github.com/mastra-ai/mastra/commit/e77a5f9718dc418e29e3c8a389299ed6dc0a6401), [`b069af5`](https://github.com/mastra-ai/mastra/commit/b069af514c4dcfc4fdcb164303569bfff1c26e3d), [`7dc8304`](https://github.com/mastra-ai/mastra/commit/7dc830420296db516b86dcec663e54d0309b8fb8), [`6942109`](https://github.com/mastra-ai/mastra/commit/694210903c70e3c26b5ce8ca4f4637ca2d9eb369), [`62d13f4`](https://github.com/mastra-ai/mastra/commit/62d13f4d1db1c16742831f210fe4c2caf8a26d57), [`358ab98`](https://github.com/mastra-ai/mastra/commit/358ab98024c388e383aca15616e8988bf4a5b66e)]:
|
|
54
|
+
- @mastra/core@0.24.7-alpha.1
|
|
55
|
+
|
|
56
|
+
## 0.24.7-alpha.0
|
|
57
|
+
|
|
58
|
+
### Patch Changes
|
|
59
|
+
|
|
60
|
+
- Updated dependencies [[`54cc99c`](https://github.com/mastra-ai/mastra/commit/54cc99cb99483b9e08ec41fa1502f43b71b4c351)]:
|
|
61
|
+
- @mastra/core@0.24.7-alpha.0
|
|
62
|
+
|
|
3
63
|
## 0.24.6
|
|
4
64
|
|
|
5
65
|
### Patch Changes
|
|
@@ -439,64 +499,4 @@
|
|
|
439
499
|
- Updated dependencies [[`a6d69c5`](https://github.com/mastra-ai/mastra/commit/a6d69c5fb50c0875b46275811fece5862f03c6a0), [`84199af`](https://github.com/mastra-ai/mastra/commit/84199af8673f6f9cb59286ffb5477a41932775de), [`7f431af`](https://github.com/mastra-ai/mastra/commit/7f431afd586b7d3265075e73106eb73167edbb86)]:
|
|
440
500
|
- @mastra/core@0.20.1-alpha.3
|
|
441
501
|
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
### Patch Changes
|
|
445
|
-
|
|
446
|
-
- Updated dependencies [[`ee9108f`](https://github.com/mastra-ai/mastra/commit/ee9108fa29bb8368fc23df158c9f0645b2d7b65c)]:
|
|
447
|
-
- @mastra/core@0.20.1-alpha.2
|
|
448
|
-
|
|
449
|
-
## 0.20.1-alpha.1
|
|
450
|
-
|
|
451
|
-
### Patch Changes
|
|
452
|
-
|
|
453
|
-
- Mutable shared workflow run state ([#8545](https://github.com/mastra-ai/mastra/pull/8545))
|
|
454
|
-
|
|
455
|
-
- Updated dependencies [[`c621613`](https://github.com/mastra-ai/mastra/commit/c621613069173c69eb2c3ef19a5308894c6549f0), [`12b1189`](https://github.com/mastra-ai/mastra/commit/12b118942445e4de0dd916c593e33ec78dc3bc73), [`4783b30`](https://github.com/mastra-ai/mastra/commit/4783b3063efea887825514b783ba27f67912c26d), [`076b092`](https://github.com/mastra-ai/mastra/commit/076b0924902ff0f49d5712d2df24c4cca683713f), [`2aee9e7`](https://github.com/mastra-ai/mastra/commit/2aee9e7d188b8b256a4ddc203ccefb366b4867fa), [`c582906`](https://github.com/mastra-ai/mastra/commit/c5829065a346260f96c4beb8af131b94804ae3ad), [`fa2eb96`](https://github.com/mastra-ai/mastra/commit/fa2eb96af16c7d433891a73932764960d3235c1d), [`4783b30`](https://github.com/mastra-ai/mastra/commit/4783b3063efea887825514b783ba27f67912c26d), [`a739d0c`](https://github.com/mastra-ai/mastra/commit/a739d0c8b37cd89569e04a6ca0827083c6167e19), [`603e927`](https://github.com/mastra-ai/mastra/commit/603e9279db8bf8a46caf83881c6b7389ccffff7e), [`cd45982`](https://github.com/mastra-ai/mastra/commit/cd4598291cda128a88738734ae6cbef076ebdebd), [`874f74d`](https://github.com/mastra-ai/mastra/commit/874f74da4b1acf6517f18132d035612c3ecc394a), [`0baf2ba`](https://github.com/mastra-ai/mastra/commit/0baf2bab8420277072ef1f95df5ea7b0a2f61fe7), [`26e968d`](https://github.com/mastra-ai/mastra/commit/26e968db2171ded9e4d47aa1b4f19e1e771158d0), [`cbd3fb6`](https://github.com/mastra-ai/mastra/commit/cbd3fb65adb03a7c0df193cb998aed5ac56675ee)]:
|
|
456
|
-
- @mastra/core@0.20.1-alpha.1
|
|
457
|
-
|
|
458
|
-
## 0.20.1-alpha.0
|
|
459
|
-
|
|
460
|
-
### Patch Changes
|
|
461
|
-
|
|
462
|
-
- Updated dependencies [[`10e633a`](https://github.com/mastra-ai/mastra/commit/10e633a07d333466d9734c97acfc3dbf757ad2d0)]:
|
|
463
|
-
- @mastra/core@0.20.1-alpha.0
|
|
464
|
-
|
|
465
|
-
## 0.20.0
|
|
466
|
-
|
|
467
|
-
### Minor Changes
|
|
468
|
-
|
|
469
|
-
- Breaking change to move the agent.streamVNext/generateVNext implementation to the default stream/generate. The old stream/generate have now been moved to streamLegacy and generateLegacy ([#8097](https://github.com/mastra-ai/mastra/pull/8097))
|
|
470
|
-
|
|
471
|
-
### Patch Changes
|
|
472
|
-
|
|
473
|
-
- Add approve and decline tool calls to mastra server pkg ([#8360](https://github.com/mastra-ai/mastra/pull/8360))
|
|
474
|
-
|
|
475
|
-
- Fix/8219 preserve resourceid on resume ([#8359](https://github.com/mastra-ai/mastra/pull/8359))
|
|
476
|
-
|
|
477
|
-
- Add observe strean to get streans after workflow has been interrupted ([#8318](https://github.com/mastra-ai/mastra/pull/8318))
|
|
478
|
-
|
|
479
|
-
- Updated dependencies [[`00cb6bd`](https://github.com/mastra-ai/mastra/commit/00cb6bdf78737c0fac14a5a0c7b532a11e38558a), [`869ba22`](https://github.com/mastra-ai/mastra/commit/869ba222e1d6b58fc1b65e7c9fd55ca4e01b8c2f), [`1b73665`](https://github.com/mastra-ai/mastra/commit/1b73665e8e23f5c09d49fcf3e7d709c75259259e), [`f7d7475`](https://github.com/mastra-ai/mastra/commit/f7d747507341aef60ed39e4b49318db1f86034a6), [`084b77b`](https://github.com/mastra-ai/mastra/commit/084b77b2955960e0190af8db3f77138aa83ed65c), [`a93ff84`](https://github.com/mastra-ai/mastra/commit/a93ff84b5e1af07ee236ac8873dac9b49aa5d501), [`bc5aacb`](https://github.com/mastra-ai/mastra/commit/bc5aacb646d468d325327e36117129f28cd13bf6), [`6b5af12`](https://github.com/mastra-ai/mastra/commit/6b5af12ce9e09066e0c32e821c203a6954498bea), [`bf60e4a`](https://github.com/mastra-ai/mastra/commit/bf60e4a89c515afd9570b7b79f33b95e7d07c397), [`d41aee5`](https://github.com/mastra-ai/mastra/commit/d41aee526d124e35f42720a08e64043229193679), [`e8fe13c`](https://github.com/mastra-ai/mastra/commit/e8fe13c4b4c255a42520127797ec394310f7c919), [`3ca833d`](https://github.com/mastra-ai/mastra/commit/3ca833dc994c38e3c9b4f9b4478a61cd8e07b32a), [`1edb8d1`](https://github.com/mastra-ai/mastra/commit/1edb8d1cfb963e72a12412990fb9170936c9904c), [`fbf6e32`](https://github.com/mastra-ai/mastra/commit/fbf6e324946332d0f5ed8930bf9d4d4479cefd7a), [`4753027`](https://github.com/mastra-ai/mastra/commit/4753027ee889288775c6958bdfeda03ff909af67)]:
|
|
480
|
-
- @mastra/core@0.20.0
|
|
481
|
-
|
|
482
|
-
## 0.20.0-alpha.0
|
|
483
|
-
|
|
484
|
-
### Minor Changes
|
|
485
|
-
|
|
486
|
-
- Breaking change to move the agent.streamVNext/generateVNext implementation to the default stream/generate. The old stream/generate have now been moved to streamLegacy and generateLegacy ([#8097](https://github.com/mastra-ai/mastra/pull/8097))
|
|
487
|
-
|
|
488
|
-
### Patch Changes
|
|
489
|
-
|
|
490
|
-
- Add approve and decline tool calls to mastra server pkg ([#8360](https://github.com/mastra-ai/mastra/pull/8360))
|
|
491
|
-
|
|
492
|
-
- Fix/8219 preserve resourceid on resume ([#8359](https://github.com/mastra-ai/mastra/pull/8359))
|
|
493
|
-
|
|
494
|
-
- Add observe strean to get streans after workflow has been interrupted ([#8318](https://github.com/mastra-ai/mastra/pull/8318))
|
|
495
|
-
|
|
496
|
-
- Updated dependencies [[`00cb6bd`](https://github.com/mastra-ai/mastra/commit/00cb6bdf78737c0fac14a5a0c7b532a11e38558a), [`869ba22`](https://github.com/mastra-ai/mastra/commit/869ba222e1d6b58fc1b65e7c9fd55ca4e01b8c2f), [`1b73665`](https://github.com/mastra-ai/mastra/commit/1b73665e8e23f5c09d49fcf3e7d709c75259259e), [`f7d7475`](https://github.com/mastra-ai/mastra/commit/f7d747507341aef60ed39e4b49318db1f86034a6), [`084b77b`](https://github.com/mastra-ai/mastra/commit/084b77b2955960e0190af8db3f77138aa83ed65c), [`a93ff84`](https://github.com/mastra-ai/mastra/commit/a93ff84b5e1af07ee236ac8873dac9b49aa5d501), [`bc5aacb`](https://github.com/mastra-ai/mastra/commit/bc5aacb646d468d325327e36117129f28cd13bf6), [`6b5af12`](https://github.com/mastra-ai/mastra/commit/6b5af12ce9e09066e0c32e821c203a6954498bea), [`bf60e4a`](https://github.com/mastra-ai/mastra/commit/bf60e4a89c515afd9570b7b79f33b95e7d07c397), [`d41aee5`](https://github.com/mastra-ai/mastra/commit/d41aee526d124e35f42720a08e64043229193679), [`e8fe13c`](https://github.com/mastra-ai/mastra/commit/e8fe13c4b4c255a42520127797ec394310f7c919), [`3ca833d`](https://github.com/mastra-ai/mastra/commit/3ca833dc994c38e3c9b4f9b4478a61cd8e07b32a), [`1edb8d1`](https://github.com/mastra-ai/mastra/commit/1edb8d1cfb963e72a12412990fb9170936c9904c), [`fbf6e32`](https://github.com/mastra-ai/mastra/commit/fbf6e324946332d0f5ed8930bf9d4d4479cefd7a), [`4753027`](https://github.com/mastra-ai/mastra/commit/4753027ee889288775c6958bdfeda03ff909af67)]:
|
|
497
|
-
- @mastra/core@0.20.0-alpha.0
|
|
498
|
-
|
|
499
|
-
## 0.19.1
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
... 3853 more lines hidden. See full changelog in package directory.
|
|
502
|
+
... 3913 more lines hidden. See full changelog in package directory.
|
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
# @mastra/upstash
|
|
2
2
|
|
|
3
|
+
## 0.15.10-alpha.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Add restart method to workflow run that allows restarting an active workflow run ([#10703](https://github.com/mastra-ai/mastra/pull/10703))
|
|
8
|
+
Add status filter to `getWorkflowRuns`
|
|
9
|
+
Add automatic restart to restart active workflow runs when server starts
|
|
10
|
+
- Updated dependencies [[`5cc85aa`](https://github.com/mastra-ai/mastra/commit/5cc85aa4329773cac8314f3aa0146227b6b158e4), [`c53f8e6`](https://github.com/mastra-ai/mastra/commit/c53f8e68df42464935f9a63eb0fc765a65aacb83), [`386ab43`](https://github.com/mastra-ai/mastra/commit/386ab4350cf2a814fb4ac0a5fc6983ca93158ffe), [`2b62302`](https://github.com/mastra-ai/mastra/commit/2b623027a9d65c1dbc963bf651e9e6a9d09da1fa), [`7d85da4`](https://github.com/mastra-ai/mastra/commit/7d85da42a5fab56009a959a9c20328558d14f4b5), [`3d7c5bd`](https://github.com/mastra-ai/mastra/commit/3d7c5bdbee1b2693cd45bf207b960dd9b7277680), [`31b381e`](https://github.com/mastra-ai/mastra/commit/31b381efb48e031c0ecc46bc6e410ae6e67b88e5), [`e77a5f9`](https://github.com/mastra-ai/mastra/commit/e77a5f9718dc418e29e3c8a389299ed6dc0a6401), [`b069af5`](https://github.com/mastra-ai/mastra/commit/b069af514c4dcfc4fdcb164303569bfff1c26e3d), [`7dc8304`](https://github.com/mastra-ai/mastra/commit/7dc830420296db516b86dcec663e54d0309b8fb8), [`6942109`](https://github.com/mastra-ai/mastra/commit/694210903c70e3c26b5ce8ca4f4637ca2d9eb369), [`62d13f4`](https://github.com/mastra-ai/mastra/commit/62d13f4d1db1c16742831f210fe4c2caf8a26d57), [`358ab98`](https://github.com/mastra-ai/mastra/commit/358ab98024c388e383aca15616e8988bf4a5b66e)]:
|
|
11
|
+
- @mastra/core@0.24.7-alpha.1
|
|
12
|
+
|
|
3
13
|
## 0.15.9
|
|
4
14
|
|
|
5
15
|
### Patch Changes
|
|
@@ -488,15 +498,5 @@
|
|
|
488
498
|
- Updated dependencies [ad0a58b]
|
|
489
499
|
- Updated dependencies [254a36b]
|
|
490
500
|
- Updated dependencies [2ecf658]
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
- Updated dependencies [e0f73c6]
|
|
494
|
-
- Updated dependencies [0b89602]
|
|
495
|
-
- Updated dependencies [4d37822]
|
|
496
|
-
- Updated dependencies [23a6a7c]
|
|
497
|
-
- Updated dependencies [cda801d]
|
|
498
|
-
- Updated dependencies [a77c823]
|
|
499
|
-
- Updated dependencies [ff9c125]
|
|
500
|
-
- Updated dependencies [09bca64]
|
|
501
|
-
|
|
502
|
-
... 2042 more lines hidden. See full changelog in package directory.
|
|
501
|
+
|
|
502
|
+
... 2052 more lines hidden. See full changelog in package directory.
|
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# create-mastra
|
|
2
2
|
|
|
3
|
+
## 0.18.7-alpha.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Fix select options overflow when list is long by adding maximum height ([#10833](https://github.com/mastra-ai/mastra/pull/10833))
|
|
8
|
+
|
|
9
|
+
- Add timeTravel APIs and add timeTravel feature to studio ([#10757](https://github.com/mastra-ai/mastra/pull/10757))
|
|
10
|
+
|
|
11
|
+
- Fix discriminatedUnion schema information lost when json schema is converted to zod ([#10764](https://github.com/mastra-ai/mastra/pull/10764))
|
|
12
|
+
|
|
13
|
+
## 0.18.7-alpha.0
|
|
14
|
+
|
|
3
15
|
## 0.18.6
|
|
4
16
|
|
|
5
17
|
## 0.18.6-alpha.0
|
|
@@ -487,16 +499,4 @@
|
|
|
487
499
|
- dependencies updates: ([#7544](https://github.com/mastra-ai/mastra/pull/7544))
|
|
488
500
|
- Updated dependency [`fs-extra@^11.3.1` ↗︎](https://www.npmjs.com/package/fs-extra/v/11.3.1) (from `^11.3.0`, in `dependencies`)
|
|
489
501
|
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
- Fix template slug when getting template environment variables ([#7650](https://github.com/mastra-ai/mastra/pull/7650))
|
|
493
|
-
|
|
494
|
-
- Update cli dev copy from "Local" - ([#7579](https://github.com/mastra-ai/mastra/pull/7579))
|
|
495
|
-
|
|
496
|
-
## 0.12.1-alpha.2
|
|
497
|
-
|
|
498
|
-
### Patch Changes
|
|
499
|
-
|
|
500
|
-
- Fix template slug when getting template environment variables ([#7650](https://github.com/mastra-ai/mastra/pull/7650))
|
|
501
|
-
|
|
502
|
-
... 1648 more lines hidden. See full changelog in package directory.
|
|
502
|
+
... 1660 more lines hidden. See full changelog in package directory.
|
|
@@ -1,5 +1,30 @@
|
|
|
1
1
|
# mastra
|
|
2
2
|
|
|
3
|
+
## 0.18.7-alpha.1
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Fix select options overflow when list is long by adding maximum height ([#10833](https://github.com/mastra-ai/mastra/pull/10833))
|
|
8
|
+
|
|
9
|
+
- Add timeTravel APIs and add timeTravel feature to studio ([#10757](https://github.com/mastra-ai/mastra/pull/10757))
|
|
10
|
+
|
|
11
|
+
- Fix discriminatedUnion schema information lost when json schema is converted to zod ([#10764](https://github.com/mastra-ai/mastra/pull/10764))
|
|
12
|
+
|
|
13
|
+
- Add restart method to workflow run that allows restarting an active workflow run ([#10703](https://github.com/mastra-ai/mastra/pull/10703))
|
|
14
|
+
Add status filter to `getWorkflowRuns`
|
|
15
|
+
Add automatic restart to restart active workflow runs when server starts
|
|
16
|
+
- Updated dependencies [[`5cc85aa`](https://github.com/mastra-ai/mastra/commit/5cc85aa4329773cac8314f3aa0146227b6b158e4), [`c901d6d`](https://github.com/mastra-ai/mastra/commit/c901d6db4ddb069ccba91071b49635bdf79c6049), [`64fba3c`](https://github.com/mastra-ai/mastra/commit/64fba3c672418d9c1ca505703221a50b3ad286a9), [`c53f8e6`](https://github.com/mastra-ai/mastra/commit/c53f8e68df42464935f9a63eb0fc765a65aacb83), [`35c172e`](https://github.com/mastra-ai/mastra/commit/35c172e42c804e6bdc1e5d75435516229ffc0203), [`386ab43`](https://github.com/mastra-ai/mastra/commit/386ab4350cf2a814fb4ac0a5fc6983ca93158ffe), [`2b62302`](https://github.com/mastra-ai/mastra/commit/2b623027a9d65c1dbc963bf651e9e6a9d09da1fa), [`7d85da4`](https://github.com/mastra-ai/mastra/commit/7d85da42a5fab56009a959a9c20328558d14f4b5), [`3d7c5bd`](https://github.com/mastra-ai/mastra/commit/3d7c5bdbee1b2693cd45bf207b960dd9b7277680), [`31b381e`](https://github.com/mastra-ai/mastra/commit/31b381efb48e031c0ecc46bc6e410ae6e67b88e5), [`e77a5f9`](https://github.com/mastra-ai/mastra/commit/e77a5f9718dc418e29e3c8a389299ed6dc0a6401), [`b069af5`](https://github.com/mastra-ai/mastra/commit/b069af514c4dcfc4fdcb164303569bfff1c26e3d), [`7dc8304`](https://github.com/mastra-ai/mastra/commit/7dc830420296db516b86dcec663e54d0309b8fb8), [`6942109`](https://github.com/mastra-ai/mastra/commit/694210903c70e3c26b5ce8ca4f4637ca2d9eb369), [`62d13f4`](https://github.com/mastra-ai/mastra/commit/62d13f4d1db1c16742831f210fe4c2caf8a26d57), [`358ab98`](https://github.com/mastra-ai/mastra/commit/358ab98024c388e383aca15616e8988bf4a5b66e)]:
|
|
17
|
+
- @mastra/core@0.24.7-alpha.1
|
|
18
|
+
- @mastra/deployer@0.24.7-alpha.1
|
|
19
|
+
|
|
20
|
+
## 0.18.7-alpha.0
|
|
21
|
+
|
|
22
|
+
### Patch Changes
|
|
23
|
+
|
|
24
|
+
- Updated dependencies [[`ba9a5ad`](https://github.com/mastra-ai/mastra/commit/ba9a5ad3482e941ca8599104448a7c412f41757c), [`54cc99c`](https://github.com/mastra-ai/mastra/commit/54cc99cb99483b9e08ec41fa1502f43b71b4c351)]:
|
|
25
|
+
- @mastra/deployer@0.24.7-alpha.0
|
|
26
|
+
- @mastra/core@0.24.7-alpha.0
|
|
27
|
+
|
|
3
28
|
## 0.18.6
|
|
4
29
|
|
|
5
30
|
### Patch Changes
|
|
@@ -473,30 +498,5 @@
|
|
|
473
498
|
|
|
474
499
|
- Mutable shared workflow run state ([#8545](https://github.com/mastra-ai/mastra/pull/8545))
|
|
475
500
|
|
|
476
|
-
- streamLegacy/generateLegacy clarification in playground ([#8468](https://github.com/mastra-ai/mastra/pull/8468))
|
|
477
|
-
|
|
478
|
-
- avoid refetching memory threads and messages on window focus ([#8519](https://github.com/mastra-ai/mastra/pull/8519))
|
|
479
|
-
|
|
480
|
-
- add tripwire reason in playground ([#8568](https://github.com/mastra-ai/mastra/pull/8568))
|
|
481
|
-
|
|
482
|
-
- Save waiting step status in snapshot ([#8576](https://github.com/mastra-ai/mastra/pull/8576))
|
|
483
|
-
|
|
484
|
-
- Added AI SDK provider packages to model router for anthropic/google/openai/openrouter/xai ([#8559](https://github.com/mastra-ai/mastra/pull/8559))
|
|
485
|
-
|
|
486
|
-
- Convert WorkflowWatchResult to WorkflowResult in workflow graph ([#8541](https://github.com/mastra-ai/mastra/pull/8541))
|
|
487
|
-
|
|
488
|
-
- add new deploy to cloud button ([#8549](https://github.com/mastra-ai/mastra/pull/8549))
|
|
489
|
-
|
|
490
|
-
- remove icons in entity lists ([#8520](https://github.com/mastra-ai/mastra/pull/8520))
|
|
491
|
-
|
|
492
|
-
- add client search to all entities ([#8523](https://github.com/mastra-ai/mastra/pull/8523))
|
|
493
|
-
|
|
494
|
-
- Fixed an issue where model router was adding /chat/completions to API urls when it shouldn't. ([#8589](https://github.com/mastra-ai/mastra/pull/8589))
|
|
495
|
-
fixed an issue with provider ID rendering in playground UI
|
|
496
|
-
|
|
497
|
-
- Fix useStreamWorkflow unmounting breaking stream call ([#8449](https://github.com/mastra-ai/mastra/pull/8449))
|
|
498
|
-
|
|
499
|
-
- Remove shell from dev ([#8466](https://github.com/mastra-ai/mastra/pull/8466))
|
|
500
|
-
|
|
501
501
|
|
|
502
|
-
...
|
|
502
|
+
... 6354 more lines hidden. See full changelog in package directory.
|
|
@@ -1,9 +1,24 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "OTEL Tracing | Observability"
|
|
2
|
+
title: "OTEL Tracing (Deprecated) | Observability"
|
|
3
3
|
description: "Set up OpenTelemetry tracing for Mastra applications"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
# OTEL Tracing
|
|
6
|
+
# OTEL Tracing (Deprecated)
|
|
7
|
+
|
|
8
|
+
:::warning[Deprecation Notice]
|
|
9
|
+
The `telemetry` configuration for OTEL Tracing is deprecated and will be removed in a future release. For OpenTelemetry-compatible tracing, use [AI Tracing](/docs/observability/ai-tracing/overview) with the [OpenTelemetry exporter](/docs/observability/ai-tracing/exporters/otel) instead.
|
|
10
|
+
|
|
11
|
+
**Important:** If you are not using this telemetry system, you must explicitly disable it to suppress deprecation warnings:
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
export const mastra = new Mastra({
|
|
15
|
+
// ... other config
|
|
16
|
+
telemetry: {
|
|
17
|
+
enabled: false,
|
|
18
|
+
},
|
|
19
|
+
});
|
|
20
|
+
```
|
|
21
|
+
:::
|
|
7
22
|
|
|
8
23
|
Mastra supports the OpenTelemetry Protocol (OTLP) for tracing and monitoring your application. When telemetry is enabled, Mastra automatically traces all core primitives including agent operations, LLM interactions, tool executions, integration calls, workflow runs, and database operations. Your telemetry data can then be exported to any OTEL collector.
|
|
9
24
|
|
|
@@ -25,7 +25,17 @@ Specialized tracing for AI operations that captures:
|
|
|
25
25
|
- **Workflow steps**: Branching logic, parallel execution, and step outputs
|
|
26
26
|
- **Automatic instrumentation**: Zero-configuration tracing with decorators
|
|
27
27
|
|
|
28
|
-
### OTEL Tracing
|
|
28
|
+
### OTEL Tracing (Deprecated)
|
|
29
|
+
|
|
30
|
+
:::warning
|
|
31
|
+
OTEL Tracing via the `telemetry` configuration is deprecated and will be removed in a future release. Use [AI Tracing](/docs/observability/ai-tracing/overview) with the [OpenTelemetry exporter](/docs/observability/ai-tracing/exporters/otel) instead for OTLP-compatible tracing.
|
|
32
|
+
|
|
33
|
+
If you are not using the old `telemetry` system, you should explicitly disable it to suppress deprecation warnings:
|
|
34
|
+
|
|
35
|
+
```typescript
|
|
36
|
+
telemetry: { enabled: false }
|
|
37
|
+
```
|
|
38
|
+
:::
|
|
29
39
|
|
|
30
40
|
Traditional distributed tracing with OpenTelemetry:
|
|
31
41
|
|
|
@@ -53,7 +63,7 @@ export const mastra = new Mastra({
|
|
|
53
63
|
url: "file:./mastra.db", // Storage is required for tracing
|
|
54
64
|
}),
|
|
55
65
|
telemetry: {
|
|
56
|
-
enabled:
|
|
66
|
+
enabled: false, // Disable deprecated OTEL Tracing to suppress warnings
|
|
57
67
|
},
|
|
58
68
|
});
|
|
59
69
|
```
|
|
@@ -530,6 +530,64 @@ Key metadata considerations:
|
|
|
530
530
|
- Only include fields you plan to filter or sort by - extra fields add overhead
|
|
531
531
|
- Add timestamps (e.g., 'createdAt', 'lastUpdated') to track content freshness
|
|
532
532
|
|
|
533
|
+
## Deleting Vectors
|
|
534
|
+
|
|
535
|
+
When building RAG applications, you often need to clean up stale vectors when documents are deleted or updated. Mastra provides the `deleteVectors` method that supports deleting vectors by metadata filters, making it easy to remove all embeddings associated with a specific document.
|
|
536
|
+
|
|
537
|
+
### Delete by Metadata Filter
|
|
538
|
+
|
|
539
|
+
The most common use case is deleting all vectors for a specific document when a user deletes it:
|
|
540
|
+
|
|
541
|
+
```ts title="delete-vectors.ts" showLineNumbers copy
|
|
542
|
+
// Delete all vectors for a specific document
|
|
543
|
+
await store.deleteVectors({
|
|
544
|
+
indexName: "myCollection",
|
|
545
|
+
filter: { docId: "document-123" },
|
|
546
|
+
});
|
|
547
|
+
```
|
|
548
|
+
|
|
549
|
+
This is particularly useful when:
|
|
550
|
+
- A user deletes a document and you need to remove all its chunks
|
|
551
|
+
- You're re-indexing a document and want to remove old vectors first
|
|
552
|
+
- You need to clean up vectors for a specific user or tenant
|
|
553
|
+
|
|
554
|
+
### Delete Multiple Documents
|
|
555
|
+
|
|
556
|
+
You can also use complex filters to delete vectors matching multiple conditions:
|
|
557
|
+
|
|
558
|
+
```ts title="delete-vectors-advanced.ts" showLineNumbers copy
|
|
559
|
+
// Delete all vectors for multiple documents
|
|
560
|
+
await store.deleteVectors({
|
|
561
|
+
indexName: "myCollection",
|
|
562
|
+
filter: {
|
|
563
|
+
docId: { $in: ["doc-1", "doc-2", "doc-3"] },
|
|
564
|
+
},
|
|
565
|
+
});
|
|
566
|
+
|
|
567
|
+
// Delete vectors for a specific user's documents
|
|
568
|
+
await store.deleteVectors({
|
|
569
|
+
indexName: "myCollection",
|
|
570
|
+
filter: {
|
|
571
|
+
$and: [
|
|
572
|
+
{ userId: "user-123" },
|
|
573
|
+
{ status: "archived" },
|
|
574
|
+
],
|
|
575
|
+
},
|
|
576
|
+
});
|
|
577
|
+
```
|
|
578
|
+
|
|
579
|
+
### Delete by Vector IDs
|
|
580
|
+
|
|
581
|
+
If you have specific vector IDs to delete, you can pass them directly:
|
|
582
|
+
|
|
583
|
+
```ts title="delete-by-ids.ts" showLineNumbers copy
|
|
584
|
+
// Delete specific vectors by their IDs
|
|
585
|
+
await store.deleteVectors({
|
|
586
|
+
indexName: "myCollection",
|
|
587
|
+
ids: ["vec-1", "vec-2", "vec-3"],
|
|
588
|
+
});
|
|
589
|
+
```
|
|
590
|
+
|
|
533
591
|
## Best Practices
|
|
534
592
|
|
|
535
593
|
- Create indexes before bulk insertions
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Reference: Run.timeTravelStream() | Streaming"
|
|
3
|
+
description: Documentation for the `Run.timeTravelStream()` method for streaming workflow time travel execution.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Run.timeTravelStream()
|
|
7
|
+
|
|
8
|
+
The `.timeTravelStream()` method re-executes a workflow starting from any specific step with streaming events. This allows you to receive real-time updates during time travel execution while maintaining full visibility into each step's progress.
|
|
9
|
+
|
|
10
|
+
## Usage example
|
|
11
|
+
|
|
12
|
+
```typescript showLineNumbers copy
|
|
13
|
+
const run = await workflow.createRunAsync();
|
|
14
|
+
|
|
15
|
+
const output = run.timeTravelStream({
|
|
16
|
+
step: "step2",
|
|
17
|
+
inputData: { value: 10 },
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
// Process events as they arrive
|
|
21
|
+
for await (const event of output.fullStream) {
|
|
22
|
+
console.log(event.type, event.payload);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
// Get the final result
|
|
26
|
+
const result = await output.result;
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Parameters
|
|
30
|
+
|
|
31
|
+
All parameters are the same as [`Run.timeTravel()`](../../workflows/run-methods/timeTravel#parameters). See the [timeTravel reference](../../workflows/run-methods/timeTravel#parameters) for detailed parameter documentation.
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
<PropertiesTable
|
|
36
|
+
content={[
|
|
37
|
+
{
|
|
38
|
+
name: "output",
|
|
39
|
+
type: "WorkflowRunOutput<WorkflowResult<TState, TInput, TOutput, TSteps>>",
|
|
40
|
+
description:
|
|
41
|
+
"An object containing both the stream and result promise",
|
|
42
|
+
},
|
|
43
|
+
{
|
|
44
|
+
name: "output.fullStream",
|
|
45
|
+
type: "ReadableStream<WorkflowStreamEvent>",
|
|
46
|
+
description:
|
|
47
|
+
"A readable stream that emits workflow events as execution progresses",
|
|
48
|
+
},
|
|
49
|
+
{
|
|
50
|
+
name: "output.result",
|
|
51
|
+
type: "Promise<WorkflowResult<TState, TInput, TOutput, TSteps>>",
|
|
52
|
+
description:
|
|
53
|
+
"A promise that resolves to the final workflow execution result",
|
|
54
|
+
},
|
|
55
|
+
{
|
|
56
|
+
name: "output.traceId",
|
|
57
|
+
type: "string",
|
|
58
|
+
isOptional: true,
|
|
59
|
+
description:
|
|
60
|
+
"The trace ID associated with this execution when Tracing is enabled",
|
|
61
|
+
},
|
|
62
|
+
]}
|
|
63
|
+
/>
|
|
64
|
+
|
|
65
|
+
## Stream events
|
|
66
|
+
|
|
67
|
+
The stream emits various workflow events during execution:
|
|
68
|
+
|
|
69
|
+
- `workflow-step-start`: Emitted when a step begins execution
|
|
70
|
+
- `workflow-step-finish`: Emitted when a step completes successfully
|
|
71
|
+
- `workflow-step-error`: Emitted when a step encounters an error
|
|
72
|
+
- `workflow-step-suspended`: Emitted when a step suspends
|
|
73
|
+
- Additional events depending on step types (agents, tools, etc.)
|
|
74
|
+
|
|
75
|
+
## Extended usage examples
|
|
76
|
+
|
|
77
|
+
### Processing events during time travel
|
|
78
|
+
|
|
79
|
+
```typescript showLineNumbers copy
|
|
80
|
+
const run = await workflow.createRunAsync();
|
|
81
|
+
|
|
82
|
+
const output = run.timeTravelStream({
|
|
83
|
+
step: "step2",
|
|
84
|
+
inputData: { value: 10 },
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
for await (const event of output.fullStream) {
|
|
88
|
+
switch (event.type) {
|
|
89
|
+
case "workflow-step-start":
|
|
90
|
+
console.log(`Starting step: ${event.payload.stepName}`);
|
|
91
|
+
break;
|
|
92
|
+
case "workflow-step-finish":
|
|
93
|
+
console.log(`Completed step: ${event.payload.stepName}`);
|
|
94
|
+
break;
|
|
95
|
+
case "workflow-step-error":
|
|
96
|
+
console.error(`Error in step: ${event.payload.stepName}`, event.payload.error);
|
|
97
|
+
break;
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
const result = await output.result;
|
|
102
|
+
console.log("Time travel completed:", result);
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
### Time travel stream with context
|
|
106
|
+
|
|
107
|
+
```typescript showLineNumbers copy
|
|
108
|
+
const output = run.timeTravelStream({
|
|
109
|
+
step: "step2",
|
|
110
|
+
context: {
|
|
111
|
+
step1: {
|
|
112
|
+
status: "success",
|
|
113
|
+
payload: { value: 0 },
|
|
114
|
+
output: { step1Result: 2 },
|
|
115
|
+
startedAt: Date.now(),
|
|
116
|
+
endedAt: Date.now(),
|
|
117
|
+
},
|
|
118
|
+
},
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
for await (const event of output.fullStream) {
|
|
122
|
+
// Handle events
|
|
123
|
+
console.log(event);
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
const result = await output.result;
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
### Time travel stream with nested workflows
|
|
130
|
+
|
|
131
|
+
```typescript showLineNumbers copy
|
|
132
|
+
const output = run.timeTravelStream({
|
|
133
|
+
step: ["nestedWorkflow", "step3"],
|
|
134
|
+
inputData: { value: 10 },
|
|
135
|
+
nestedStepsContext: {
|
|
136
|
+
nestedWorkflow: {
|
|
137
|
+
step2: {
|
|
138
|
+
status: "success",
|
|
139
|
+
payload: { step1Result: 2 },
|
|
140
|
+
output: { step2Result: 3 },
|
|
141
|
+
startedAt: Date.now(),
|
|
142
|
+
endedAt: Date.now(),
|
|
143
|
+
},
|
|
144
|
+
},
|
|
145
|
+
},
|
|
146
|
+
});
|
|
147
|
+
|
|
148
|
+
for await (const event of output.fullStream) {
|
|
149
|
+
console.log(event.type, event.payload);
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
const result = await output.result;
|
|
153
|
+
```
|
|
154
|
+
|
|
155
|
+
## Notes
|
|
156
|
+
|
|
157
|
+
- The stream closes automatically when time travel execution completes or encounters an error
|
|
158
|
+
- You can process events from the stream while the workflow is still executing
|
|
159
|
+
- The `result` promise resolves only after all steps have completed
|
|
160
|
+
- Stream events follow the same format as regular workflow streaming
|
|
161
|
+
- Time travel streaming requires storage to be configured since it relies on persisted workflow snapshots
|
|
162
|
+
|
|
163
|
+
## Related
|
|
164
|
+
|
|
165
|
+
- [Run.timeTravel()](../../workflows/run-methods/timeTravel)
|
|
166
|
+
- [Time Travel](/docs/workflows/time-travel)
|
|
167
|
+
- [Workflow Streaming](/docs/streaming/workflow-streaming)
|
|
168
|
+
- [Run.streamVNext()](./streamVNext)
|
|
169
|
+
- [Run.resumeStreamVNext()](./resumeStreamVNext)
|
|
170
|
+
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Reference: Run.restart() | Workflows"
|
|
3
|
+
description: Documentation for the `Run.restart()` method in workflows, which restarts an active workflow run that lost connection to the server.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Run.restart()
|
|
7
|
+
|
|
8
|
+
The `.restart()` method restarts an active workflow run that lost connection to the server, allowing you to continue execution from the moment it lost connection (the last active step).
|
|
9
|
+
|
|
10
|
+
## Usage example
|
|
11
|
+
|
|
12
|
+
```typescript showLineNumbers copy
|
|
13
|
+
const run = await workflow.createRun();
|
|
14
|
+
|
|
15
|
+
const result = await run.start({ inputData: { value: "initial data" } });
|
|
16
|
+
|
|
17
|
+
//.. server connection lost,
|
|
18
|
+
|
|
19
|
+
const restartedResult = await run.restart();
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Parameters
|
|
23
|
+
|
|
24
|
+
<PropertiesTable
|
|
25
|
+
content={[
|
|
26
|
+
{
|
|
27
|
+
name: "requestContext",
|
|
28
|
+
type: "RequestContext",
|
|
29
|
+
description: "Request Context data to use when resuming",
|
|
30
|
+
isOptional: true,
|
|
31
|
+
},
|
|
32
|
+
{
|
|
33
|
+
name: "tracingContext",
|
|
34
|
+
type: "TracingContext",
|
|
35
|
+
isOptional: true,
|
|
36
|
+
description:
|
|
37
|
+
"Tracing context for creating child spans and adding metadata. Automatically injected when using Mastra's tracing system.",
|
|
38
|
+
properties: [
|
|
39
|
+
{
|
|
40
|
+
parameters: [
|
|
41
|
+
{
|
|
42
|
+
name: "currentSpan",
|
|
43
|
+
type: "Span",
|
|
44
|
+
isOptional: true,
|
|
45
|
+
description:
|
|
46
|
+
"Current span for creating child spans and adding metadata. Use this to create custom child spans or update span attributes during execution.",
|
|
47
|
+
},
|
|
48
|
+
],
|
|
49
|
+
},
|
|
50
|
+
],
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
name: "tracingOptions",
|
|
54
|
+
type: "TracingOptions",
|
|
55
|
+
isOptional: true,
|
|
56
|
+
description: "Options for Tracing configuration.",
|
|
57
|
+
properties: [
|
|
58
|
+
{
|
|
59
|
+
parameters: [
|
|
60
|
+
{
|
|
61
|
+
name: "metadata",
|
|
62
|
+
type: "Record<string, any>",
|
|
63
|
+
isOptional: true,
|
|
64
|
+
description:
|
|
65
|
+
"Metadata to add to the root trace span. Useful for adding custom attributes like user IDs, session IDs, or feature flags.",
|
|
66
|
+
},
|
|
67
|
+
],
|
|
68
|
+
},
|
|
69
|
+
],
|
|
70
|
+
},
|
|
71
|
+
]}
|
|
72
|
+
/>
|
|
73
|
+
|
|
74
|
+
## Returns
|
|
75
|
+
|
|
76
|
+
<PropertiesTable
|
|
77
|
+
content={[
|
|
78
|
+
{
|
|
79
|
+
name: "result",
|
|
80
|
+
type: "Promise<WorkflowResult<TState, TOutput, TSteps>>",
|
|
81
|
+
description:
|
|
82
|
+
"A promise that resolves to the workflow execution result containing step outputs and status",
|
|
83
|
+
},
|
|
84
|
+
{
|
|
85
|
+
name: "traceId",
|
|
86
|
+
type: "string",
|
|
87
|
+
isOptional: true,
|
|
88
|
+
description:
|
|
89
|
+
"The trace ID associated with this execution when Tracing is enabled. Use this to correlate logs and debug execution flow.",
|
|
90
|
+
},
|
|
91
|
+
]}
|
|
92
|
+
/>
|
|
93
|
+
|
|
94
|
+
## Related
|
|
95
|
+
|
|
96
|
+
- [Workflows overview](/docs/workflows/overview#running-workflows)
|
|
97
|
+
- [Restart workflows](/docs/workflows/overview#restarting-active-workflow-runs)
|
|
98
|
+
- [Workflow.createRun()](../workflow-methods/create-run)
|