@h-ai/vecdb 1.0.0-beta.21 → 1.0.0-beta.22

package/README.en.md

@@ -164,10 +164,12 @@ path: ./data/vecdb
 operationLog:
   read: false # collection.exists/info/list, vector.search/count
   write: false # collection.create/drop, vector.insert/upsert/delete
-  maxLength: 1000 # 参数序列化后的最大输出长度，超出会截断
-  level: debug # info | debug | trace，默认 debug
+  maxLength: 1000 # Maximum summary length in characters. Use 0 to omit the summary.
+  level: debug # info | debug | trace, defaults to debug
 ```
 
+Logs include the operation and a summary such as document counts, dimensions, topK, and whether a filter was supplied.
+
 ```ts
 await vecdb.init({
   type: 'lancedb',

package/README.ja.md

@@ -164,10 +164,12 @@ path: ./data/vecdb
 operationLog:
   read: false # collection.exists/info/list, vector.search/count
   write: false # collection.create/drop, vector.insert/upsert/delete
-  maxLength: 1000 # 参数序列化后的最大输出长度，超出会截断
-  level: debug # info | debug | trace，默认 debug
+  maxLength: 1000 # 概要の最大文字数。0 で概要を省略します。
+  level: debug # info | debug | trace、既定値は debug
 ```
 
+ログには操作名と件数、次元数、topK、フィルターの有無などの概要だけを記録します。
+
 ```ts
 await vecdb.init({
   type: 'lancedb',

package/README.md

@@ -164,10 +164,12 @@ path: ./data/vecdb
 operationLog:
   read: false # collection.exists/info/list, vector.search/count
   write: false # collection.create/drop, vector.insert/upsert/delete
-  maxLength: 1000 # 参数序列化后的最大输出长度，超出会截断
+  maxLength: 1000 # 安全摘要的最大字符数，0 省略摘要
   level: debug # info | debug | trace，默认 debug
 ```
 
+日志只记录操作类型和条数、维度、topK、是否有过滤条件等摘要。
+
 ```ts
 await vecdb.init({
   type: 'lancedb',

package/dist/index.js

@@ -122,6 +122,7 @@ var DistanceMetricSchema = z.enum(["cosine", "euclidean", "dot"]).default("cosin
 var VecdbOperationLogConfigSchema = z.object({
   read: z.boolean().default(false),
   write: z.boolean().default(false),
+  /** 安全摘要的最大字符数，0 省略摘要。 */
   maxLength: z.number().int().min(0).default(1e3),
   level: z.enum(["info", "debug", "trace"]).default("debug")
 });
@@ -230,36 +231,14 @@ function vectorScoreFromDistance(distance, metric) {
     return 1 / (1 + Math.exp(distance));
   return 1 / (1 + Math.max(0, distance));
 }
-function stringifyOperationPayload(payload, maxLength) {
-  if (maxLength <= 0) {
-    return "";
-  }
-  try {
-    const text = JSON.stringify(payload, (_key, value) => {
-      if (typeof value === "bigint") {
-        return value.toString();
-      }
-      if (typeof value === "function") {
-        return "[Function]";
-      }
-      return value;
-    });
-    return text.length > maxLength ? `${text.slice(0, maxLength)}...` : text;
-  } catch {
-    const text = String(payload);
-    return text.length > maxLength ? `${text.slice(0, maxLength)}...` : text;
-  }
-}
-function logVecdbOperation(ctx, category, operation, payload) {
+function logVecdbOperation(ctx, category, operation, summary = {}) {
   const config = ctx.operationLog?.();
   if (!config?.[category]) {
     return;
   }
-  ctx.logger[config.level]("VecDB operation executed", {
-    category,
-    operation,
-    payload: stringifyOperationPayload(payload, config.maxLength)
-  });
+  const fields = Object.entries(summary).filter(([, value]) => typeof value === "number" || typeof value === "boolean");
+  const payload = config.maxLength > 0 ? JSON.stringify(Object.fromEntries(fields)).slice(0, config.maxLength) : "";
+  ctx.logger[config.level]("VecDB operation started", { category, operation, payload });
 }
 function errorMsgFromCode(def, errorStr) {
   switch (def) {
@@ -281,14 +260,17 @@ function errorMsgFromCode(def, errorStr) {
       });
   }
 }
-async function wrapOp(ctx, fn, errorDef, errorLabel, errorMeta) {
+async function wrapOp(ctx, fn, errorDef, errorLabel) {
   if (!ctx.isConnected()) {
     return err(HaiVecdbError.NOT_INITIALIZED, vecdbM("vecdb_notInitialized"));
   }
   try {
     return await fn();
   } catch (error) {
-    ctx.logger.error(errorLabel, { ...errorMeta, error });
+    ctx.logger.error(errorLabel, {
+      errorCode: errorDef.code,
+      causeName: error instanceof Error ? error.name : void 0
+    });
     return err(errorDef, errorMsgFromCode(errorDef, String(error)), error);
   }
 }
@@ -305,47 +287,43 @@ function createBaseCollectionOps(ctx, driver) {
           })
         );
       }
-      logVecdbOperation(ctx, "write", "collection.create", { name, options });
+      logVecdbOperation(ctx, "write", "collection.create", { dimension: options.dimension });
       return wrapOp(
         ctx,
         () => driver.create(name, options),
         HaiVecdbError.QUERY_FAILED,
-        "Failed to create collection",
-        { name }
+        "Failed to create collection"
       );
     },
     drop: (name) => {
-      logVecdbOperation(ctx, "write", "collection.drop", { name });
+      logVecdbOperation(ctx, "write", "collection.drop");
       return wrapOp(
         ctx,
         () => driver.drop(name),
         HaiVecdbError.DELETE_FAILED,
-        "Failed to drop collection",
-        { name }
+        "Failed to drop collection"
       );
     },
     exists: (name) => {
-      logVecdbOperation(ctx, "read", "collection.exists", { name });
+      logVecdbOperation(ctx, "read", "collection.exists");
       return wrapOp(
         ctx,
         () => driver.exists(name),
         HaiVecdbError.QUERY_FAILED,
-        "Failed to check collection",
-        { name }
+        "Failed to check collection"
       );
     },
     info: (name) => {
-      logVecdbOperation(ctx, "read", "collection.info", { name });
+      logVecdbOperation(ctx, "read", "collection.info");
       return wrapOp(
         ctx,
         () => driver.info(name),
         HaiVecdbError.QUERY_FAILED,
-        "Failed to get collection info",
-        { name }
+        "Failed to get collection info"
       );
     },
     list: () => {
-      logVecdbOperation(ctx, "read", "collection.list", {});
+      logVecdbOperation(ctx, "read", "collection.list");
       return wrapOp(
         ctx,
         () => driver.list(),
@@ -358,53 +336,52 @@ function createBaseCollectionOps(ctx, driver) {
 function createBaseVectorOps(ctx, driver) {
   return {
     insert: (collection, documents) => {
-      logVecdbOperation(ctx, "write", "vector.insert", { collection, count: documents.length, documents });
+      logVecdbOperation(ctx, "write", "vector.insert", { count: documents?.length, dimension: documents?.[0]?.vector?.length });
       return wrapOp(
         ctx,
         () => documents.length === 0 ? Promise.resolve(ok(void 0)) : driver.insert(collection, documents),
         HaiVecdbError.INSERT_FAILED,
-        "Failed to insert vectors",
-        { collection }
+        "Failed to insert vectors"
       );
     },
     upsert: (collection, documents) => {
-      logVecdbOperation(ctx, "write", "vector.upsert", { collection, count: documents.length, documents });
+      logVecdbOperation(ctx, "write", "vector.upsert", { count: documents?.length, dimension: documents?.[0]?.vector?.length });
       return wrapOp(
         ctx,
         () => documents.length === 0 ? Promise.resolve(ok(void 0)) : driver.upsert(collection, documents),
         HaiVecdbError.UPDATE_FAILED,
-        "Failed to upsert vectors",
-        { collection }
+        "Failed to upsert vectors"
       );
     },
     delete: (collection, ids) => {
-      logVecdbOperation(ctx, "write", "vector.delete", { collection, count: ids.length, ids });
+      logVecdbOperation(ctx, "write", "vector.delete", { count: ids?.length });
       return wrapOp(
         ctx,
         () => ids.length === 0 ? Promise.resolve(ok(void 0)) : driver.delete(collection, ids),
         HaiVecdbError.DELETE_FAILED,
-        "Failed to delete vectors",
-        { collection }
+        "Failed to delete vectors"
       );
     },
     search: (collection, vector, options) => {
-      logVecdbOperation(ctx, "read", "vector.search", { collection, vector, options });
+      logVecdbOperation(ctx, "read", "vector.search", {
+        dimension: vector?.length,
+        topK: options?.topK,
+        hasFilter: Boolean(options?.filter)
+      });
       return wrapOp(
         ctx,
         () => driver.search(collection, vector, options),
         HaiVecdbError.QUERY_FAILED,
-        "Failed to search vectors",
-        { collection }
+        "Failed to search vectors"
       );
     },
     count: (collection) => {
-      logVecdbOperation(ctx, "read", "vector.count", { collection });
+      logVecdbOperation(ctx, "read", "vector.count");
       return wrapOp(
         ctx,
         () => driver.count(collection),
         HaiVecdbError.QUERY_FAILED,
-        "Failed to count vectors",
-        { collection }
+        "Failed to count vectors"
       );
     }
   };