Skip to content

Update from code changes: document OpenTelemetry metrics bridge - #302

Merged
prrao87 merged 2 commits into
mainfrom
mintlify/f238ba30
Jul 24, 2026
Merged

Update from code changes: document OpenTelemetry metrics bridge#302
prrao87 merged 2 commits into
mainfrom
mintlify/f238ba30

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Summary

Adds a new Monitoring guide covering instrument_lancedb_metrics() (Python) and instrumentLanceDbMetrics() (TypeScript), which register LanceDB's object store request, latency, byte, error, and throttle metrics as OpenTelemetry observable instruments. The page explains the metric catalog, Prometheus-style histogram export, setup for both SDKs, and what to alert on.

Changes

  • New page docs/storage/monitoring.mdx with Python and TypeScript setup, metric catalog, histogram export notes, and dashboarding starting points.
  • docs.json: added storage/monitoring to the Storage group (under Guides).

Notes

  • The page lives in the Storage group rather than Support, since every metric it documents is an object-store metric and it cross-links to storage/configuration and performance.
  • Prose was given a light humanizer pass (removed em dashes, softened forced rule-of-three); metric names, code, and technical claims are unchanged.

Context

Triggered by lancedb/lancedb#3609, which ships the OpenTelemetry bridge in the Python (lancedb[otel] extra) and Node SDKs.

@mintlify

mintlify Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
lancedb-bcbb4faf 🟢 Ready View Preview Jul 9, 2026, 10:44 PM

Relocate the OpenTelemetry monitoring guide from the Support group to
the Storage group, matching its object-store focus and its cross-links
to storage/configuration and performance. Also apply a light humanizer
pass (remove em dashes, soften forced rule-of-three) without touching
metric names, code, or technical claims.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@prrao87
prrao87 merged commit 6759edc into main Jul 24, 2026
2 checks passed
@prrao87
prrao87 deleted the mintlify/f238ba30 branch July 24, 2026 16:28
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