@wtfalch/reporting 0.5.1 → 0.8.1

package/dist/tables.js

@@ -15,6 +15,8 @@ export const reportingEvents = pgTable('reporting_events', {
     kindNs: text('kind_ns').generatedAlwaysAs(sql `split_part(kind, '.', 1)`),
     site: text('site').notNull(),
     environment: text('environment'),
+    release: text('release'),
+    color: text('color'),
     tenantId: uuid('tenant_id'),
     actorClass: text('actor_class'),
     actorId: text('actor_id'),
@@ -91,6 +93,8 @@ export const reportingAnalytics = pgTable('reporting_analytics', {
         .notNull()
         .default(sql `'{}'::jsonb`),
     schemaVersion: smallint('schema_version').notNull().default(1),
+    release: text('release'),
+    color: text('color'),
 }, (t) => [
     index('reporting_analytics_site_time_idx').on(t.site, t.occurredAt.desc(), t.id.desc()),
     index('reporting_analytics_tenant_time_idx')
@@ -162,6 +166,7 @@ export const reportingErrors = pgTable('reporting_errors', {
     stack: text('stack'),
     runtime: text('runtime').notNull(),
     release: text('release'),
+    color: text('color'),
     firstSeenAt: timestamp('first_seen_at', { withTimezone: true }).notNull(),
     lastSeenAt: timestamp('last_seen_at', { withTimezone: true }).notNull(),
     occurrences: bigint('occurrences', { mode: 'number' }).notNull().default(1),
@@ -176,6 +181,31 @@ export const reportingErrors = pgTable('reporting_errors', {
         .where(sql `${t.state} = 'open'`),
     index('reporting_errors_state_idx').on(t.state, t.lastSeenAt.desc()),
 ]);
+/** One row per (fingerprint, tenant): that tenant's own occurrences of a shared error group; mirrored from migrations/0008_error_tenants.sql. */
+export const reportingErrorTenants = pgTable('reporting_error_tenants', {
+    fingerprint: text('fingerprint').notNull(),
+    tenantId: uuid('tenant_id').notNull(),
+    occurrences: bigint('occurrences', { mode: 'number' }).notNull().default(1),
+    firstSeenAt: timestamp('first_seen_at', { withTimezone: true }).notNull(),
+    lastSeenAt: timestamp('last_seen_at', { withTimezone: true }).notNull(),
+}, (t) => [
+    primaryKey({ name: 'reporting_error_tenants_pkey', columns: [t.fingerprint, t.tenantId] }),
+    index('reporting_error_tenants_tenant_idx').on(t.tenantId, t.lastSeenAt.desc()),
+]);
+/** Request and 5xx counts per minute, color and release; mirrored from migrations/0010_requests.sql. */
+export const reportingRequests = pgTable('reporting_requests', {
+    bucket: timestamp('bucket', { withTimezone: true }).notNull(),
+    site: text('site').notNull(),
+    color: text('color').notNull().default(''),
+    release: text('release').notNull().default(''),
+    requests: bigint('requests', { mode: 'number' }).notNull().default(0),
+    errors: bigint('errors', { mode: 'number' }).notNull().default(0),
+}, (t) => [
+    primaryKey({
+        name: 'reporting_requests_pkey',
+        columns: [t.bucket, t.site, t.color, t.release],
+    }),
+]);
 export const tables = {
     events: reportingEvents,
     tasks: reportingTasks,
@@ -185,4 +215,6 @@ export const tables = {
     analyticsDaily: reportingAnalyticsDaily,
     analyticsWeekly: reportingAnalyticsWeekly,
     errors: reportingErrors,
+    errorTenants: reportingErrorTenants,
+    requests: reportingRequests,
 };

package/dist/types.d.ts

@@ -3,7 +3,7 @@ import type { RecentEvent, RecentOptions, SeriesOptions, SeriesPoint, WeeklyPoin
 import type { Device } from './analytics/schema.js';
 import type { Actor, ErrorRuntime, ErrorState, EventInput, FlatData, Level } from './schema.js';
 import type { TenantRetentionKey } from './settings.js';
-import type { ReportingErrorRow, ReportingEventRow, tables } from './tables.js';
+import type { ReportingErrorRow, ReportingEventRow, TenantErrorRow, tables } from './tables.js';
 /**
  * The host's drizzle handle, whatever driver it runs on. postgres-js in the
  * apps, PGlite in this package's own tests; the queries here use nothing
@@ -81,6 +81,8 @@ export interface ReportingOptions {
     batchSize?: number;
     /** Timer flush interval, ms. Default 1,000. */
     flushEveryMs?: number;
+    /** How often counted requests are written, ms. Default 10,000. */
+    requestFlushEveryMs?: number;
 }
 export interface EventsPageOptions {
     readonly limit?: number;
@@ -111,12 +113,14 @@ export interface ErrorsPageOptions {
     readonly site?: string;
     readonly state?: ErrorState;
     readonly runtime?: ErrorRuntime;
-    /** A case-insensitive substring match against `message` or `stack`, for triaging an incident by grepping the group list. Capped at 200 characters. */
+    /** A case-insensitive substring match against `message` or `stack`, for triaging an incident by grepping the group list. Capped at 200 characters. With `tenantId`, it matches `kind` only: the shared message and stack are not the tenant's to search. */
     readonly search?: string;
     readonly environment?: string;
+    /** Only groups this tenant hit, as `TenantErrorRow`s: `occurrences`, `firstSeenAt`, `lastSeenAt` and `tenantId` come from the tenant's own record (migration 0008), and `message`, `stack`, `runtime`, `release`, `requestId`, `resolvedBy`, `state` and `resolvedAt` are null, because the shared group holds them from whichever tenant hit it last. `state` is ignored as a filter in tenant scope. Scope is decided by presence: an absent key is unscoped, any present value, `undefined` included, must be a uuid or the call throws. */
+    readonly tenantId?: string;
 }
-export interface ErrorsPage {
-    readonly items: readonly ReportingErrorRow[];
+export interface ErrorsPage<Row = ReportingErrorRow | TenantErrorRow> {
+    readonly items: readonly Row[];
     readonly next: {
         readonly lastSeenAt: Date;
         readonly fingerprint: string;
@@ -196,6 +200,10 @@ export interface Reporting {
     readonly site: string;
     readonly log: Logger;
     readonly analytics: Analytics;
+    /** Counts one response for the release-health read; `flush` writes the counts. Never throws. */
+    readonly requests: {
+        record(status: number): void;
+    };
     stats(): Stats;
 }
 export type { Actor, EventInput, FlatData, Level };

package/dist/writer.js

@@ -1,3 +1,4 @@
+import { deployTags } from './deploy.js';
 import { eventInputSchema } from './schema.js';
 import { reportingEvents } from './tables.js';
 export class Writer {
@@ -55,6 +56,7 @@ export class Writer {
             kind: v.kind,
             site: this.o.site,
             environment: this.o.environment,
+            ...deployTags(),
             tenantId: v.tenantId ?? null,
             actorClass: v.actor?.class ?? null,
             actorId: v.actor?.id ?? null,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wtfalch/reporting",
-  "version": "0.5.1",
+  "version": "0.8.1",
   "description": "The estate's operational event log and housekeeping tick: a writer that never fails a request, a claim protocol that needs no scheduler, and the readers an operator opens. Per-app Postgres, host-supplied logger, framework-neutral core with a Next entry.",
   "repository": {
     "type": "git",
@@ -26,10 +26,6 @@
       "types": "./dist/next/index.d.ts",
       "default": "./dist/next/index.js"
     },
-    "./fake": {
-      "types": "./dist/fake/index.d.ts",
-      "default": "./dist/fake/index.js"
-    },
     "./browser": {
       "types": "./dist/browser/index.d.ts",
       "default": "./dist/browser/index.js"
@@ -46,6 +42,10 @@
       "types": "./dist/react/errors.d.ts",
       "default": "./dist/react/errors.js"
     },
+    "./migrations-dir": {
+      "types": "./dist/migrations-dir.d.ts",
+      "default": "./dist/migrations-dir.js"
+    },
     "./migrations/*.sql": "./dist/migrations/*.sql",
     "./package.json": "./package.json"
   },
@@ -63,7 +63,7 @@
     "test": "vitest run"
   },
   "peerDependencies": {
-    "drizzle-orm": ">=0.39.0",
+    "drizzle-orm": ">=0.39.3 <1.0.0",
     "next": ">=16.0.0",
     "react": ">=19.0.0",
     "zod": "^4.0.0"
@@ -77,9 +77,9 @@
     "@electric-sql/pglite": "^0.5.8",
     "@types/node": "^22",
     "@types/react": "^19",
-    "drizzle-orm": "^0.39.3",
+    "@wtfalch/db": "0.5.2",
+    "drizzle-orm": "0.39.3",
     "next": "^16.2.4",
-    "postgres": "^3.4.5",
     "react": "^19",
     "react-dom": "^19",
     "typescript": "^5.9.0",

package/dist/fake/index.d.ts

@@ -1,22 +0,0 @@
-import type { ReportingEventRow } from '../tables.js';
-import type { AlertFinding, Logger, Reporting, TrackInput } from '../types.js';
-/**
- * An in-memory `Reporting` for a host's unit tests: same validation, same
- * shape, no database. `rows` is the table; `alerts` is what `onAlert` would
- * have received. Validation failures throw, as in development.
- */
-export interface FakeReporting extends Reporting {
-    readonly rows: ReportingEventRow[];
-    readonly alerts: AlertFinding[];
-    /** What `analytics.track` received. */
-    readonly tracked: (TrackInput & {
-        site: string;
-    })[];
-    reset(): void;
-}
-export declare function createFakeReporting(opts?: {
-    site?: string;
-    log?: Logger;
-    redactEnvVars?: readonly string[];
-    environment?: string | null;
-}): FakeReporting;

package/dist/fake/index.js

@@ -1,157 +0,0 @@
-import { alertRow } from '../alerts.js';
-import { createCapture } from '../errors/capture.js';
-import { eventInputSchema } from '../schema.js';
-import { DEFAULT_SETTINGS, RETENTION_BOUNDS } from '../settings.js';
-import { tables } from '../tables.js';
-const silent = { info() { }, warn() { }, error() { } };
-export function createFakeReporting(opts = {}) {
-    const site = opts.site ?? 'test';
-    const environment = opts.environment ?? null;
-    const log = opts.log ?? silent;
-    const rows = [];
-    const alerts = [];
-    const tracked = [];
-    let settings = { ...DEFAULT_SETTINGS };
-    const tenantRetention = new Map();
-    let id = 0;
-    // No group table to fake, so the upsert never runs (`defer` is a no-op);
-    // the timeline row through `fake.event` is what a host's test asserts on.
-    const capture = createCapture({
-        db: undefined,
-        log,
-        site,
-        now: () => new Date(),
-        defer: () => { },
-        event: (input) => fake.event(input),
-        redactEnvVars: opts.redactEnvVars,
-    });
-    const fake = {
-        site,
-        log,
-        tables,
-        rows,
-        alerts,
-        tracked,
-        event(input) {
-            const v = eventInputSchema.parse(input);
-            id += 1;
-            rows.push({
-                id,
-                occurredAt: v.occurredAt ?? new Date(),
-                level: v.level,
-                kind: v.kind,
-                kindNs: v.kind.split('.')[0] ?? '',
-                site,
-                environment,
-                tenantId: v.tenantId ?? null,
-                actorClass: v.actor?.class ?? null,
-                actorId: v.actor?.id ?? null,
-                requestId: v.requestId ?? null,
-                targetType: v.target?.type ?? null,
-                targetId: v.target?.id ?? null,
-                message: v.message,
-                data: v.data,
-                schemaVersion: 1,
-            });
-        },
-        alert(finding) {
-            fake.event(alertRow(finding));
-            alerts.push(finding);
-        },
-        captureError: (error, context) => capture(error, context),
-        async flush() { },
-        events: {
-            async page(o = {}) {
-                const limit = Math.max(1, Math.min(o.limit ?? 50, 200));
-                let list = [...rows].sort((a, b) => b.occurredAt.getTime() - a.occurredAt.getTime() || b.id - a.id);
-                if (o.level)
-                    list = list.filter((r) => r.level === o.level);
-                if (o.kindNs)
-                    list = list.filter((r) => r.kindNs === o.kindNs);
-                if (o.tenantId)
-                    list = list.filter((r) => r.tenantId === o.tenantId);
-                if (o.site)
-                    list = list.filter((r) => r.site === o.site);
-                if (o.requestId)
-                    list = list.filter((r) => r.requestId === o.requestId);
-                if (o.environment)
-                    list = list.filter((r) => r.environment === o.environment);
-                if (o.after) {
-                    const { occurredAt, id: afterId } = o.after;
-                    list = list.filter((r) => r.occurredAt.getTime() < occurredAt.getTime() ||
-                        (r.occurredAt.getTime() === occurredAt.getTime() && r.id < afterId));
-                }
-                const items = list.slice(0, limit);
-                const last = items.at(-1);
-                return {
-                    items,
-                    next: list.length > limit && last ? { occurredAt: last.occurredAt, id: last.id } : null,
-                };
-            },
-        },
-        settings: {
-            async get() {
-                return settings;
-            },
-            async set(patch, by) {
-                const before = settings;
-                for (const [key, value] of Object.entries(patch)) {
-                    if (typeof value !== 'number' ||
-                        !Number.isInteger(value) ||
-                        value < RETENTION_BOUNDS.min ||
-                        value > RETENTION_BOUNDS.max) {
-                        throw new Error(`reporting.settings: ${key} out of bounds`);
-                    }
-                }
-                settings = { ...settings, ...patch };
-                const changed = Object.keys(patch).filter((k) => before[k] !== settings[k]);
-                return { before, after: settings, by, changed };
-            },
-        },
-        tenantSettings: {
-            async get(tenantId) {
-                const out = {};
-                for (const key of ['events.retention_days', 'analytics.retention_days']) {
-                    const value = tenantRetention.get(`${tenantId}:${key}`);
-                    if (value !== undefined)
-                        out[key] = value;
-                }
-                return out;
-            },
-            async set(tenantId, key, days) {
-                const mapKey = `${tenantId}:${key}`;
-                if (days === null) {
-                    tenantRetention.delete(mapKey);
-                    return;
-                }
-                if (!Number.isInteger(days) || days < RETENTION_BOUNDS.min || days > RETENTION_BOUNDS.max) {
-                    throw new Error(`reporting.tenantSettings: ${key} out of bounds`);
-                }
-                tenantRetention.set(mapKey, days);
-            },
-        },
-        analytics: {
-            async track(input) {
-                tracked.push({ ...input, site });
-            },
-            async series() {
-                return [];
-            },
-            async weekly() {
-                return [];
-            },
-            async recent() {
-                return [];
-            },
-        },
-        stats: () => ({ queued: 0, dropped: 0, invalid: 0, flushed: rows.length }),
-        reset() {
-            rows.length = 0;
-            alerts.length = 0;
-            settings = { ...DEFAULT_SETTINGS };
-            tenantRetention.clear();
-            id = 0;
-        },
-    };
-    return fake;
-}