mirror of
https://github.com/lancedb/lancedb.git
synced 2026-08-16 11:08:24 +00:00
Will Jones
285add40dd
Bridges Lance's internal `metrics`-crate instrumentation (object store request counts, bytes, latency, errors, and throttles) into OpenTelemetry, in both the Python and Node bindings, with a shared adapter in the Rust core. This is the LanceDB counterpart to lance-format/lance#7537. ## Rust core (`rust/lancedb`) Two new, **off-by-default** features: - `metrics` — re-exports the [`metrics`](https://docs.rs/metrics) crate as `lancedb::metrics` and turns on Lance's object-store instrumentation. Install any `metrics`-compatible recorder to collect them. - `metrics-otel` — adds `lancedb::metrics_otel`, a pull-based adapter that installs a process-global recorder aggregating into lock-free cumulative storage and exposes a snapshot/catalog API (`register_metrics_recorder`, `metrics_catalog`, `snapshot_metrics`, `MetricPoint`/`MetricValue`/`MetricKind`/`MetricDescription`). Both bindings build on this. ## Python `lancedb.otel.instrument_lancedb_metrics()` registers each metric as an OpenTelemetry observable instrument on the given (or global) `MeterProvider`. Available via the `otel` extra (`pip install lancedb[otel]`), which pulls in only `opentelemetry-api` — the application supplies and configures the SDK. ## Node `instrumentLanceDbMetrics()` provides the equivalent wiring against `@opentelemetry/api`. This is the only public entry point; the underlying recorder/catalog/snapshot functions stay internal. Because OpenTelemetry has no asynchronous histogram instrument, histograms are exported Prometheus-style as `<name>_bucket` (with an `le` attribute), `<name>_count`, and `<name>_sum`. Only `_sum` carries the histogram's unit; `_bucket` and `_count` observe cumulative counts and are unitless. The adapter is enabled by default in the Python and Node builds, and off by default in the Rust crate. ## Notes - Requires Lance ≥ `v9.0.0-beta.19`, which ships the object-store metrics APIs (upstream lance-format/lance#7537, now merged). `main` is already on beta.19, so this is a single feature commit with no dependency bump. - Tests: 8 Rust unit tests, 3 Python tests, 2 Node tests, all covering the end-to-end object-store-metrics → OpenTelemetry path. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
107 lines
3.4 KiB
JSON
107 lines
3.4 KiB
JSON
{
|
|
"name": "@lancedb/lancedb",
|
|
"description": "LanceDB: A serverless, low-latency vector database for AI applications",
|
|
"keywords": [
|
|
"database",
|
|
"lance",
|
|
"lancedb",
|
|
"search",
|
|
"vector",
|
|
"vector database",
|
|
"ann"
|
|
],
|
|
"private": false,
|
|
"version": "0.31.0-beta.6",
|
|
"main": "dist/index.js",
|
|
"exports": {
|
|
".": "./dist/index.js",
|
|
"./embedding": "./dist/embedding/index.js",
|
|
"./embedding/openai": "./dist/embedding/openai.js",
|
|
"./embedding/transformers": "./dist/embedding/transformers.js"
|
|
},
|
|
"types": "dist/index.d.ts",
|
|
"napi": {
|
|
"binaryName": "lancedb",
|
|
"targets": [
|
|
"aarch64-apple-darwin",
|
|
"x86_64-unknown-linux-gnu",
|
|
"aarch64-unknown-linux-gnu",
|
|
"x86_64-unknown-linux-musl",
|
|
"aarch64-unknown-linux-musl",
|
|
"x86_64-pc-windows-msvc",
|
|
"aarch64-pc-windows-msvc"
|
|
]
|
|
},
|
|
"license": "Apache-2.0",
|
|
"repository": {
|
|
"type": "git",
|
|
"url": "https://github.com/lancedb/lancedb"
|
|
},
|
|
"devDependencies": {
|
|
"@aws-sdk/client-dynamodb": "3.1003.0",
|
|
"@aws-sdk/client-kms": "3.1003.0",
|
|
"@aws-sdk/client-s3": "3.1003.0",
|
|
"@biomejs/biome": "^1.7.3",
|
|
"@jest/globals": "^29.7.0",
|
|
"@napi-rs/cli": "3.7.0",
|
|
"@opentelemetry/sdk-metrics": "^1.30.0",
|
|
"@types/axios": "^0.14.0",
|
|
"@types/jest": "^29.1.2",
|
|
"@types/node": "22.7.4",
|
|
"@types/tmp": "^0.2.6",
|
|
"apache-arrow-15": "npm:apache-arrow@15.0.0",
|
|
"apache-arrow-16": "npm:apache-arrow@16.0.0",
|
|
"apache-arrow-17": "npm:apache-arrow@17.0.0",
|
|
"apache-arrow-18": "npm:apache-arrow@18.0.0",
|
|
"eslint": "^8.57.0",
|
|
"jest": "^29.7.0",
|
|
"shx": "^0.3.4",
|
|
"tmp": "^0.2.3",
|
|
"ts-jest": "^29.1.2",
|
|
"typedoc": "0.26.4",
|
|
"typedoc-plugin-markdown": "4.2.1",
|
|
"typescript": "5.5.4",
|
|
"typescript-eslint": "^7.1.0"
|
|
},
|
|
"ava": {
|
|
"timeout": "3m"
|
|
},
|
|
"engines": {
|
|
"node": ">= 18"
|
|
},
|
|
"packageManager": "pnpm@11.1.1",
|
|
"cpu": ["x64", "arm64"],
|
|
"os": ["darwin", "linux", "win32"],
|
|
"scripts": {
|
|
"artifacts": "napi artifacts",
|
|
"build:debug": "napi build --platform --dts ../lancedb/native.d.ts --js ../lancedb/native.js --output-dir lancedb",
|
|
"postbuild:debug": "shx mkdir -p dist && shx cp lancedb/*.node dist/ && node -e \"require('fs').writeFileSync('dist/package.json', JSON.stringify({name:'@lancedb/lancedb',type:'commonjs'}))\"",
|
|
"build:release": "napi build --platform --release --dts ../lancedb/native.d.ts --js ../lancedb/native.js --output-dir dist",
|
|
"build": "pnpm build:debug && pnpm tsc",
|
|
"build-release": "pnpm build:release && pnpm tsc",
|
|
"tsc": "tsc -b",
|
|
"posttsc": "shx cp lancedb/native.d.ts dist/native.d.ts",
|
|
"lint-ci": "biome ci .",
|
|
"docs": "typedoc --plugin typedoc-plugin-markdown --treatWarningsAsErrors --out ../docs/src/js lancedb/index.ts",
|
|
"postdocs": "node typedoc_post_process.js",
|
|
"lint": "biome check . && biome format .",
|
|
"lint-fix": "biome check --write . && biome format --write .",
|
|
"prepublishOnly": "napi prepublish -t npm",
|
|
"test": "jest --verbose",
|
|
"integration": "S3_TEST=1 pnpm test",
|
|
"universal": "napi universalize",
|
|
"version": "napi version"
|
|
},
|
|
"dependencies": {
|
|
"@opentelemetry/api": "^1.9.0",
|
|
"reflect-metadata": "^0.2.2"
|
|
},
|
|
"optionalDependencies": {
|
|
"@huggingface/transformers": "3.0.2",
|
|
"openai": "4.29.2"
|
|
},
|
|
"peerDependencies": {
|
|
"apache-arrow": ">=15.0.0 <=18.1.0"
|
|
}
|
|
}
|