rivetkit 2.1.5 → 2.1.6-rc.1

package/dist/tsup/{config-BiNoIHRs.d.ts → config-DROwzBLT.d.cts}

@@ -1,4 +1,77 @@
-import { SqliteVfs } from '@rivetkit/sqlite-vfs';
+import { ISqliteVfs } from '@rivetkit/sqlite-vfs';
+
+/**
+ * Lightweight in-memory metrics for actor instances.
+ *
+ * Metrics are collected per actor wake cycle and are NOT persisted. They reset
+ * when the actor sleeps and wakes again.
+ */
+interface CounterMetric {
+    type: "counter";
+    help: string;
+    value: number;
+}
+interface GaugeMetric {
+    type: "gauge";
+    help: string;
+    value: number;
+}
+interface LabeledCounterMetric {
+    type: "labeled_counter";
+    help: string;
+    values: Record<string, number>;
+}
+interface LabeledTimingMetric {
+    type: "labeled_timing";
+    help: string;
+    values: Record<string, {
+        calls: number;
+        totalMs: number;
+        keys: number;
+    }>;
+}
+type Metric = CounterMetric | GaugeMetric | LabeledCounterMetric | LabeledTimingMetric;
+type MetricsSnapshot = Record<string, Metric>;
+declare class ActorMetrics {
+    kvGet: {
+        calls: number;
+        keys: number;
+        totalMs: number;
+    };
+    kvGetBatch: {
+        calls: number;
+        keys: number;
+        totalMs: number;
+    };
+    kvPut: {
+        calls: number;
+        keys: number;
+        totalMs: number;
+    };
+    kvPutBatch: {
+        calls: number;
+        keys: number;
+        totalMs: number;
+    };
+    kvDeleteBatch: {
+        calls: number;
+        keys: number;
+        totalMs: number;
+    };
+    sqlSelects: number;
+    sqlInserts: number;
+    sqlUpdates: number;
+    sqlDeletes: number;
+    sqlOther: number;
+    sqlTotalMs: number;
+    actionCalls: number;
+    actionErrors: number;
+    actionTotalMs: number;
+    connectionsOpened: number;
+    connectionsClosed: number;
+    trackSql(query: string, durationMs: number): void;
+    snapshot(): MetricsSnapshot;
+}
 
 type AnyDatabaseProvider = DatabaseProvider<any> | undefined;
 /**
@@ -28,11 +101,14 @@ interface DatabaseProviderContext {
         batchDelete: (keys: Uint8Array[]) => Promise<void>;
     };
     /**
-     * SQLite VFS instance for creating KV-backed databases.
-     * This should be actor-scoped because @rivetkit/sqlite is not re-entrant per
-     * module instance.
+     * SQLite VFS handle for creating KV-backed databases.
+     * May be a standalone VFS or a pooled handle from SqliteVfsPool.
+     */
+    sqliteVfs?: ISqliteVfs;
+    /**
+     * Actor metrics instance. When provided, KV and SQL operations are tracked.
      */
-    sqliteVfs?: SqliteVfs;
+    metrics?: ActorMetrics;
 }
 type DatabaseProvider<DB extends RawAccess> = {
     /**
@@ -77,4 +153,4 @@ type RawAccess = {
     close: () => Promise<void>;
 };
 
-export type { AnyDatabaseProvider as A, DatabaseProvider as D, RawAccess as R, RawDatabaseClient as a };
+export { type AnyDatabaseProvider as A, type DatabaseProvider as D, type RawAccess as R, type RawDatabaseClient as a, ActorMetrics as b };

package/dist/tsup/{config-BiNoIHRs.d.cts → config-DROwzBLT.d.ts}

@@ -1,4 +1,77 @@
-import { SqliteVfs } from '@rivetkit/sqlite-vfs';
+import { ISqliteVfs } from '@rivetkit/sqlite-vfs';
+
+/**
+ * Lightweight in-memory metrics for actor instances.
+ *
+ * Metrics are collected per actor wake cycle and are NOT persisted. They reset
+ * when the actor sleeps and wakes again.
+ */
+interface CounterMetric {
+    type: "counter";
+    help: string;
+    value: number;
+}
+interface GaugeMetric {
+    type: "gauge";
+    help: string;
+    value: number;
+}
+interface LabeledCounterMetric {
+    type: "labeled_counter";
+    help: string;
+    values: Record<string, number>;
+}
+interface LabeledTimingMetric {
+    type: "labeled_timing";
+    help: string;
+    values: Record<string, {
+        calls: number;
+        totalMs: number;
+        keys: number;
+    }>;
+}
+type Metric = CounterMetric | GaugeMetric | LabeledCounterMetric | LabeledTimingMetric;
+type MetricsSnapshot = Record<string, Metric>;
+declare class ActorMetrics {
+    kvGet: {
+        calls: number;
+        keys: number;
+        totalMs: number;
+    };
+    kvGetBatch: {
+        calls: number;
+        keys: number;
+        totalMs: number;
+    };
+    kvPut: {
+        calls: number;
+        keys: number;
+        totalMs: number;
+    };
+    kvPutBatch: {
+        calls: number;
+        keys: number;
+        totalMs: number;
+    };
+    kvDeleteBatch: {
+        calls: number;
+        keys: number;
+        totalMs: number;
+    };
+    sqlSelects: number;
+    sqlInserts: number;
+    sqlUpdates: number;
+    sqlDeletes: number;
+    sqlOther: number;
+    sqlTotalMs: number;
+    actionCalls: number;
+    actionErrors: number;
+    actionTotalMs: number;
+    connectionsOpened: number;
+    connectionsClosed: number;
+    trackSql(query: string, durationMs: number): void;
+    snapshot(): MetricsSnapshot;
+}
 
 type AnyDatabaseProvider = DatabaseProvider<any> | undefined;
 /**
@@ -28,11 +101,14 @@ interface DatabaseProviderContext {
         batchDelete: (keys: Uint8Array[]) => Promise<void>;
     };
     /**
-     * SQLite VFS instance for creating KV-backed databases.
-     * This should be actor-scoped because @rivetkit/sqlite is not re-entrant per
-     * module instance.
+     * SQLite VFS handle for creating KV-backed databases.
+     * May be a standalone VFS or a pooled handle from SqliteVfsPool.
+     */
+    sqliteVfs?: ISqliteVfs;
+    /**
+     * Actor metrics instance. When provided, KV and SQL operations are tracked.
      */
-    sqliteVfs?: SqliteVfs;
+    metrics?: ActorMetrics;
 }
 type DatabaseProvider<DB extends RawAccess> = {
     /**
@@ -77,4 +153,4 @@ type RawAccess = {
     close: () => Promise<void>;
 };
 
-export type { AnyDatabaseProvider as A, DatabaseProvider as D, RawAccess as R, RawDatabaseClient as a };
+export { type AnyDatabaseProvider as A, type DatabaseProvider as D, type RawAccess as R, type RawDatabaseClient as a, ActorMetrics as b };