Skip to content

docs(observability): Gravsearch trace runbook, TraceQL + instrumentation recipes (DEV-6636)#4161

Open
mpro7 wants to merge 1 commit into
mainfrom
docs/dev-6636-gravsearch-observability
Open

docs(observability): Gravsearch trace runbook, TraceQL + instrumentation recipes (DEV-6636)#4161
mpro7 wants to merge 1 commit into
mainfrom
docs/dev-6636-gravsearch-observability

Conversation

@mpro7

@mpro7 mpro7 commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

DEV-6636

Summary

Changes

New docs/observability/ section (4 pages, wired into the mkdocs.yml nav 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, stageSpan helper, span naming, bounded gravsearch.query.shape with the metric-label vs drill-down cardinality split, and the error → UNSET + sanitized-ERROR + exit_reason=interrupted handling — enough to instrument a second vertical without re-deriving it.

Test Plan

Screenshots

N/A — docs only (the mermaid span-tree diagram and admonitions render on docs.dasch.swiss).

@linear-code

linear-code Bot commented Jun 23, 2026

Copy link
Copy Markdown

DEV-6636

@mpro7 mpro7 self-assigned this Jun 23, 2026
@codecov

codecov Bot commented Jun 23, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 85.98%. Comparing base (a978c50) to head (2403cee).

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           
Flag Coverage Δ
e2e 85.98% <ø> (ø)
integration 85.98% <ø> (ø)
unit 85.98% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

…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>
@mpro7 mpro7 force-pushed the docs/dev-6636-gravsearch-observability branch from 3b0395b to 2403cee Compare June 23, 2026 07:50
@mpro7 mpro7 requested a review from BalduinLandolt June 23, 2026 15:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant