-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs: update observability overview #1070
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
2ebe31e
feat(docs): restructure observability getting started pages
necatiozmen bae119f
feat(docs): tighten observability overview copy
necatiozmen 6ccc464
feat(docs): simplify observability setup guide
necatiozmen 4b50d86
feat(ui): hide docs toc on smaller screens
necatiozmen 552c324
feat(docs): replace "First Trace" with "Mental Model" in documentatio…
necatiozmen 9375a84
feat(docs): remove "Next" section and related links from mental model…
necatiozmen f58de7f
feat(docs): remove "Next Step" section from setup guide
necatiozmen File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| --- | ||
| title: Mental Model | ||
| hide_table_of_contents: true | ||
| --- | ||
|
|
||
| # Mental Model | ||
|
|
||
| This page shows the minimum mental model you need to open a VoltOps trace and understand what happened. | ||
| AI agents are hard to debug if you only look at final output. | ||
| VoltOps solves this by showing each run as a trace with step-level spans. | ||
|
|
||
| ## One Request, One Trace | ||
|
|
||
| ```mermaid | ||
| sequenceDiagram | ||
| participant U as User | ||
| participant T as Trace (traceId) | ||
| participant A as Agent span | ||
| participant L as LLM span | ||
| participant O as Tool span | ||
|
|
||
| U->>T: Send request | ||
| T->>A: Start agent step | ||
| A->>L: Generate response | ||
| L->>O: Call tool (if needed) | ||
| O-->>A: Return tool result | ||
| A-->>T: Complete execution | ||
| T-->>U: Final response | ||
| ``` | ||
|
|
||
| In VoltOps: | ||
|
|
||
| - A **trace** is one end-to-end execution. | ||
| - A **span** is one operation inside that execution. | ||
| - Spans are connected by parent-child relationships and rendered as nodes. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.