@routier/core 0.3.0 → 0.5.0

package/dist/plugins/TelemetryDbPlugin.d.ts

@@ -0,0 +1,43 @@
+import { BulkPersistResult } from "../collections";
+import { PluginEventCallbackPartialResult, PluginEventCallbackResult } from "../results";
+import { ITranslatedValue } from "./translators";
+import { DbPluginBulkPersistEvent, DbPluginEvent, DbPluginQueryEvent, IDbPlugin } from "./types";
+/**
+ * Measures every operation an inner plugin performs and hands one event per call to a sink.
+ *
+ * ```ts
+ * const store = new MyStore(new TelemetryDbPlugin(new SomeDbPlugin(...)));
+ * ```
+ */
+export type TelemetryEvent = {
+    operation: "query" | "bulkPersist" | "destroy";
+    /** `id` of the plugin event that produced this measurement. */
+    eventId: string;
+    /** The class/component that triggered the operation (`event.source`). */
+    source: string;
+    /** Collection names involved, from `event.schemas`. */
+    schemas: string[];
+    durationMs: number;
+    ok: "success" | "partial" | "error";
+    /** Present when ok is "error" or "partial". */
+    error?: unknown;
+};
+export type TelemetrySink = (e: TelemetryEvent) => void;
+export type TelemetryDbPluginOptions = {
+    /** Where events go. Default: `loggerSink()`. */
+    onEvent?: TelemetrySink;
+};
+/** Default sink: writes through the levelled logger, so ROUTIER_LOG_LEVEL governs it. */
+export declare const loggerSink: () => TelemetrySink;
+/** Pushes every event into `into`. For tests and custom buffering. */
+export declare const collectingSink: (into: TelemetryEvent[]) => TelemetrySink;
+export declare class TelemetryDbPlugin implements IDbPlugin {
+    private readonly plugin;
+    private readonly onEvent;
+    constructor(plugin: IDbPlugin, options?: TelemetryDbPluginOptions);
+    get databaseName(): string;
+    query<TRoot extends {}, TShape extends any = TRoot>(event: DbPluginQueryEvent<TRoot, TShape>, done: PluginEventCallbackResult<ITranslatedValue<TShape>>): void;
+    bulkPersist(event: DbPluginBulkPersistEvent, done: PluginEventCallbackPartialResult<BulkPersistResult>): void;
+    destroy(event: DbPluginEvent, done: PluginEventCallbackResult<never>): void;
+    private emit;
+}