docs: refactor telemetry docs into dedicated tracing, metrics, and logging pages#662
Open
ajbozarth wants to merge 1 commit intogenerative-computing:mainfrom
Open
docs: refactor telemetry docs into dedicated tracing, metrics, and logging pages#662ajbozarth wants to merge 1 commit intogenerative-computing:mainfrom
ajbozarth wants to merge 1 commit intogenerative-computing:mainfrom
Conversation
…gging pages Absorb all content from docs/dev/telemetry.md into the public docs and restructure the Evaluation and Observability section: - Replace metrics-and-telemetry.md with telemetry.md (balanced overview hub) - Replace opentelemetry-tracing.md with tracing.md (add Mellea-specific backend span attributes, gen_ai.response.model) - Create metrics.md (token usage, backend support matrix, three exporters, custom metrics API, programmatic access, troubleshooting) - Create logging.md (FancyLogger console logging, OTLP log export, get_otlp_log_handler() API, collector setup) - Move handling-exceptions.md from eval-observability to how-to section - Reorder sidebar: LLM-as-a-Judge first, then Telemetry subgroup - Delete docs/dev/telemetry.md (all content migrated) - Update all cross-references across 10+ files - Fix mintlify dev command in CONTRIBUTING.md and README.md Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
Contributor
|
The PR description has been updated. Please fill out the template for your PR to be reviewed. |
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
ajbozarth
changed the title
planetf1
approved these changes
Mar 17, 2026
Contributor
planetf1
left a comment
planetf1
left a comment
There was a problem hiding this comment.
Great addition!
- just spotted a broken link
- obv need the PR merged for this to be accurate
- consider if you want to add any glossary entries. Nothing particularly stood out to me
- there's a broken link in an orphan index.md (used for a static index before the mintlify pipeline but I'm removing in #645
|
|
||
| For structured telemetry across all calls, see | ||
| [Metrics and Telemetry](./metrics-and-telemetry). | ||
| [Telemetry](./telemetry). |
Contributor
There was a problem hiding this comment.
Suggested change
| [Telemetry](./telemetry). | |
| [Telemetry](../evaluation-and-observability/telemetry). |
Contributor
There was a problem hiding this comment.
needed as this doc was moved into howtos, so now the telemetry is back in the other directory
9 tasks
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Misc PR
Type of PR
Description
Refactor the telemetry documentation from two pages into a four-page structure with dedicated pages for each telemetry pillar. Absorbs all content from the internal dev doc (
docs/dev/telemetry.md) into public docs, then deletes it.New structure:
get_otlp_log_handler()APIOther changes:
mint dev→mintlify devin CONTRIBUTING.md and README.mdNote: The metrics and token usage documentation reflects the hooks/plugins architecture introduced in #653. Merge #653 first.
Testing