docs(observability): Gravsearch trace runbook, TraceQL + instrumentation recipes (DEV-6636)#4161
Open
mpro7 wants to merge 1 commit into
Open
docs(observability): Gravsearch trace runbook, TraceQL + instrumentation recipes (DEV-6636)#4161mpro7 wants to merge 1 commit into
mpro7 wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4161 +/- ##
=======================================
Coverage 85.98% 85.98%
=======================================
Files 538 538
Lines 30571 30571
Branches 3559 3559
=======================================
Hits 26286 26286
Misses 4285 4285
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
…ntation recipes (DEV-6636) New top-level "Observability" docs section documenting the per-stage Gravsearch tracing from DEV-6635: - Engineer runbook: find a slow trace, read the per-stage time decomposition, interpret each span + root shape attribute, and the four absent-data topologies (empty-result, parse-failure, interruption/timeout, shape-less early interrupt) so none is misread as broken instrumentation. - TraceQL recipes + a Grafana Explore starter for slow Gravsearch queries (threshold parameterised on the baseline p95). - Instrumentation recipe: the abstract-tracing-member pattern, stageSpan helper, span naming, bounded query-shape with cardinality split, and the error->UNSET + sanitized-ERROR + exit_reason handling, enough to instrument a second vertical without re-deriving it. Span/attribute names match the merged DEV-6635 implementation (PR #4155); a final validation pass is due once #4155 lands on main. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
3b0395b to
2403cee
Compare
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
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.
DEV-6636
Summary
Changes
New
docs/observability/section (4 pages, wired into themkdocs.ymlnav under a new top-level "Observability" node):index.md— observability / tracing overview and entry point.gravsearch-trace-runbook.md(REQ-3.3) — find a slow trace, the span tree, per-stage time decomposition, root shape attributes, and the four absent-data topologies (empty-result, parse-failure, interruption/timeout, shape-less early interrupt) so none is misread as broken instrumentation.traceql-recipes.md(REQ-3.1/3.2) — TraceQL queries for slow Gravsearch traces (threshold parameterised on the baseline p95), stage drill-down, query-shape filtering, errors/interrupts, plus a Grafana Explore starter link.instrumentation-recipe.md(REQ-4.1) — the abstract-tracing-member pattern,stageSpanhelper, span naming, boundedgravsearch.query.shapewith the metric-label vs drill-down cardinality split, and theerror → UNSET+ sanitized-ERROR +exit_reason=interruptedhandling — enough to instrument a second vertical without re-deriving it.Test Plan
gravsearch+gravsearch.{parse,type_inspection,prequery.generate,prequery.execute,mainquery.generate,mainquery.execute,result_transform}; attributesgravsearch.query.shape,gravsearch.shape.*,gravsearch.schema_predicates,gravsearch.exit_reason.span:/trace:, dotted custom attributesspan.<key>, structural>>)..markdownlint.yml(nav targets, internal links/anchors, MD033/MD007); localmkdocs/npmwere unavailable, so CImkdocs build --strictis the build gate.main.Screenshots
N/A — docs only (the mermaid span-tree diagram and admonitions render on docs.dasch.swiss).