@wtfalch/reporting 0.3.0 → 0.4.0

package/dist/tables.d.ts

@@ -113,6 +113,23 @@ export declare const reportingEvents: import("drizzle-orm/pg-core").PgTableWithC
             identity: undefined;
             generated: undefined;
         }, {}, {}>;
+        environment: import("drizzle-orm/pg-core").PgColumn<{
+            name: "environment";
+            tableName: "reporting_events";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
         tenantId: import("drizzle-orm/pg-core").PgColumn<{
             name: "tenant_id";
             tableName: "reporting_events";
@@ -506,6 +523,99 @@ export declare const reportingSettings: import("drizzle-orm/pg-core").PgTableWit
     };
     dialect: "pg";
 }>;
+/** A tenant's own override of a retention setting; mirrored from migrations/0006_tenant_settings.sql. */
+export declare const reportingTenantSettings: import("drizzle-orm/pg-core").PgTableWithColumns<{
+    name: "reporting_tenant_settings";
+    schema: undefined;
+    columns: {
+        tenantId: import("drizzle-orm/pg-core").PgColumn<{
+            name: "tenant_id";
+            tableName: "reporting_tenant_settings";
+            dataType: "string";
+            columnType: "PgUUID";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        key: import("drizzle-orm/pg-core").PgColumn<{
+            name: "key";
+            tableName: "reporting_tenant_settings";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        value: import("drizzle-orm/pg-core").PgColumn<{
+            name: "value";
+            tableName: "reporting_tenant_settings";
+            dataType: "json";
+            columnType: "PgJsonb";
+            data: unknown;
+            driverParam: unknown;
+            notNull: true;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        updatedAt: import("drizzle-orm/pg-core").PgColumn<{
+            name: "updated_at";
+            tableName: "reporting_tenant_settings";
+            dataType: "date";
+            columnType: "PgTimestamp";
+            data: Date;
+            driverParam: string;
+            notNull: true;
+            hasDefault: true;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: undefined;
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+        updatedBy: import("drizzle-orm/pg-core").PgColumn<{
+            name: "updated_by";
+            tableName: "reporting_tenant_settings";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
+    };
+    dialect: "pg";
+}>;
 /** Raw analytics rows, a window's worth; mirrored from migrations/0002_analytics.sql. */
 export declare const reportingAnalytics: import("drizzle-orm/pg-core").PgTableWithColumns<{
     name: "reporting_analytics";
@@ -1282,6 +1392,23 @@ export declare const reportingErrors: import("drizzle-orm/pg-core").PgTableWithC
             identity: undefined;
             generated: undefined;
         }, {}, {}>;
+        environment: import("drizzle-orm/pg-core").PgColumn<{
+            name: "environment";
+            tableName: "reporting_errors";
+            dataType: "string";
+            columnType: "PgText";
+            data: string;
+            driverParam: string;
+            notNull: false;
+            hasDefault: false;
+            isPrimaryKey: false;
+            isAutoincrement: false;
+            hasRuntimeDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+            identity: undefined;
+            generated: undefined;
+        }, {}, {}>;
         kind: import("drizzle-orm/pg-core").PgColumn<{
             name: "kind";
             tableName: "reporting_errors";
@@ -1512,6 +1639,7 @@ export type ReportingAnalyticsDailyRow = typeof reportingAnalyticsDaily.$inferSe
 export type ReportingAnalyticsWeeklyRow = typeof reportingAnalyticsWeekly.$inferSelect;
 export type ReportingTaskRow = typeof reportingTasks.$inferSelect;
 export type ReportingSettingRow = typeof reportingSettings.$inferSelect;
+export type ReportingTenantSettingRow = typeof reportingTenantSettings.$inferSelect;
 export type ReportingErrorRow = typeof reportingErrors.$inferSelect;
 export declare const tables: {
     events: import("drizzle-orm/pg-core").PgTableWithColumns<{
@@ -1622,6 +1750,23 @@ export declare const tables: {
                 identity: undefined;
                 generated: undefined;
             }, {}, {}>;
+            environment: import("drizzle-orm/pg-core").PgColumn<{
+                name: "environment";
+                tableName: "reporting_events";
+                dataType: "string";
+                columnType: "PgText";
+                data: string;
+                driverParam: string;
+                notNull: false;
+                hasDefault: false;
+                isPrimaryKey: false;
+                isAutoincrement: false;
+                hasRuntimeDefault: false;
+                enumValues: [string, ...string[]];
+                baseColumn: never;
+                identity: undefined;
+                generated: undefined;
+            }, {}, {}>;
             tenantId: import("drizzle-orm/pg-core").PgColumn<{
                 name: "tenant_id";
                 tableName: "reporting_events";
@@ -2015,6 +2160,98 @@ export declare const tables: {
         };
         dialect: "pg";
     }>;
+    tenantSettings: import("drizzle-orm/pg-core").PgTableWithColumns<{
+        name: "reporting_tenant_settings";
+        schema: undefined;
+        columns: {
+            tenantId: import("drizzle-orm/pg-core").PgColumn<{
+                name: "tenant_id";
+                tableName: "reporting_tenant_settings";
+                dataType: "string";
+                columnType: "PgUUID";
+                data: string;
+                driverParam: string;
+                notNull: true;
+                hasDefault: false;
+                isPrimaryKey: false;
+                isAutoincrement: false;
+                hasRuntimeDefault: false;
+                enumValues: undefined;
+                baseColumn: never;
+                identity: undefined;
+                generated: undefined;
+            }, {}, {}>;
+            key: import("drizzle-orm/pg-core").PgColumn<{
+                name: "key";
+                tableName: "reporting_tenant_settings";
+                dataType: "string";
+                columnType: "PgText";
+                data: string;
+                driverParam: string;
+                notNull: true;
+                hasDefault: false;
+                isPrimaryKey: false;
+                isAutoincrement: false;
+                hasRuntimeDefault: false;
+                enumValues: [string, ...string[]];
+                baseColumn: never;
+                identity: undefined;
+                generated: undefined;
+            }, {}, {}>;
+            value: import("drizzle-orm/pg-core").PgColumn<{
+                name: "value";
+                tableName: "reporting_tenant_settings";
+                dataType: "json";
+                columnType: "PgJsonb";
+                data: unknown;
+                driverParam: unknown;
+                notNull: true;
+                hasDefault: false;
+                isPrimaryKey: false;
+                isAutoincrement: false;
+                hasRuntimeDefault: false;
+                enumValues: undefined;
+                baseColumn: never;
+                identity: undefined;
+                generated: undefined;
+            }, {}, {}>;
+            updatedAt: import("drizzle-orm/pg-core").PgColumn<{
+                name: "updated_at";
+                tableName: "reporting_tenant_settings";
+                dataType: "date";
+                columnType: "PgTimestamp";
+                data: Date;
+                driverParam: string;
+                notNull: true;
+                hasDefault: true;
+                isPrimaryKey: false;
+                isAutoincrement: false;
+                hasRuntimeDefault: false;
+                enumValues: undefined;
+                baseColumn: never;
+                identity: undefined;
+                generated: undefined;
+            }, {}, {}>;
+            updatedBy: import("drizzle-orm/pg-core").PgColumn<{
+                name: "updated_by";
+                tableName: "reporting_tenant_settings";
+                dataType: "string";
+                columnType: "PgText";
+                data: string;
+                driverParam: string;
+                notNull: false;
+                hasDefault: false;
+                isPrimaryKey: false;
+                isAutoincrement: false;
+                hasRuntimeDefault: false;
+                enumValues: [string, ...string[]];
+                baseColumn: never;
+                identity: undefined;
+                generated: undefined;
+            }, {}, {}>;
+        };
+        dialect: "pg";
+    }>;
     analytics: import("drizzle-orm/pg-core").PgTableWithColumns<{
         name: "reporting_analytics";
         schema: undefined;
@@ -2787,6 +3024,23 @@ export declare const tables: {
                 identity: undefined;
                 generated: undefined;
             }, {}, {}>;
+            environment: import("drizzle-orm/pg-core").PgColumn<{
+                name: "environment";
+                tableName: "reporting_errors";
+                dataType: "string";
+                columnType: "PgText";
+                data: string;
+                driverParam: string;
+                notNull: false;
+                hasDefault: false;
+                isPrimaryKey: false;
+                isAutoincrement: false;
+                hasRuntimeDefault: false;
+                enumValues: [string, ...string[]];
+                baseColumn: never;
+                identity: undefined;
+                generated: undefined;
+            }, {}, {}>;
             kind: import("drizzle-orm/pg-core").PgColumn<{
                 name: "kind";
                 tableName: "reporting_errors";

package/dist/tables.js

@@ -14,6 +14,7 @@ export const reportingEvents = pgTable('reporting_events', {
     kind: text('kind').notNull(),
     kindNs: text('kind_ns').generatedAlwaysAs(sql `split_part(kind, '.', 1)`),
     site: text('site').notNull(),
+    environment: text('environment'),
     tenantId: uuid('tenant_id'),
     actorClass: text('actor_class'),
     actorId: text('actor_id'),
@@ -57,6 +58,19 @@ export const reportingSettings = pgTable('reporting_settings', {
     updatedAt: timestamp('updated_at', { withTimezone: true }).notNull().default(sql `now()`),
     updatedBy: text('updated_by'),
 });
+/** A tenant's own override of a retention setting; mirrored from migrations/0006_tenant_settings.sql. */
+export const reportingTenantSettings = pgTable('reporting_tenant_settings', {
+    tenantId: uuid('tenant_id').notNull(),
+    key: text('key').notNull(),
+    value: jsonb('value').notNull(),
+    updatedAt: timestamp('updated_at', { withTimezone: true }).notNull().default(sql `now()`),
+    updatedBy: text('updated_by'),
+}, (t) => [
+    primaryKey({
+        name: 'reporting_tenant_settings_pkey',
+        columns: [t.tenantId, t.key],
+    }),
+]);
 /** Raw analytics rows, a window's worth; mirrored from migrations/0002_analytics.sql. */
 export const reportingAnalytics = pgTable('reporting_analytics', {
     id: bigint('id', { mode: 'number' }).generatedAlwaysAsIdentity().primaryKey(),
@@ -142,6 +156,7 @@ export const reportingAnalyticsWeekly = pgTable('reporting_analytics_weekly', {
 export const reportingErrors = pgTable('reporting_errors', {
     fingerprint: text('fingerprint').primaryKey(),
     site: text('site').notNull(),
+    environment: text('environment'),
     kind: text('kind').notNull(),
     message: text('message').notNull(),
     stack: text('stack'),
@@ -165,6 +180,7 @@ export const tables = {
     events: reportingEvents,
     tasks: reportingTasks,
     settings: reportingSettings,
+    tenantSettings: reportingTenantSettings,
     analytics: reportingAnalytics,
     analyticsDaily: reportingAnalyticsDaily,
     analyticsWeekly: reportingAnalyticsWeekly,

package/dist/types.d.ts

@@ -2,6 +2,7 @@ import type { PgDatabase, PgQueryResultHKT } from 'drizzle-orm/pg-core';
 import type { RecentEvent, RecentOptions, SeriesOptions, SeriesPoint, WeeklyPoint } from './analytics/reader.js';
 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';
 /**
  * The host's drizzle handle, whatever driver it runs on. postgres-js in the
@@ -41,6 +42,15 @@ export interface ReportingOptions {
     log: Logger;
     /** This host's id, stamped on every row: `^[a-z][a-z0-9-]{0,63}$`. */
     site: string;
+    /**
+     * The deploy target, stamped on every row the same way `site` is:
+     * `production`, `stage`, a per-PR `preview`, or the host's own scheme
+     * (`^[a-z][a-z0-9_-]{0,31}$`). A factory app runs prod, stage and one
+     * preview per PR under the same `site`; without this there is no way to
+     * keep preview noise out of a production view. Optional and unset by
+     * default, same as `release`.
+     */
+    environment?: string | null;
     /**
      * Runs a flush after the current unit of work. The `./next` entry passes
      * `after()`; the default is `setTimeout(0)`, which a script keeps until it
@@ -56,6 +66,15 @@ export interface ReportingOptions {
     audit?: (change: SettingsChange) => Promise<void>;
     /** The host's route normalisation for analytics paths (addendum A7); the package's default otherwise. */
     normalisePath?: (pathname: string) => string;
+    /**
+     * Extra environment variable names to redact from a captured error's
+     * `message` and `stack`, beyond the estate's own `KEYSTORE_KEK`/
+     * `KEYSTORE_KEK_PREVIOUS`. Each is read the same way
+     * `KEYSTORE_KEK_PREVIOUS` is: comma-separated values allowed, each
+     * trimmed. A company app the factory stamps may hold secret env vars the
+     * estate's own convention does not name.
+     */
+    redactEnvVars?: readonly string[];
     /** Queue bound; past it rows go to the logger only. Default 1,000. */
     queueLimit?: number;
     /** Rows per insert. Default 500. */
@@ -74,6 +93,7 @@ export interface EventsPageOptions {
     readonly tenantId?: string;
     readonly site?: string;
     readonly requestId?: string;
+    readonly environment?: string;
 }
 export interface EventsPage {
     readonly items: readonly ReportingEventRow[];
@@ -91,6 +111,9 @@ 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. */
+    readonly search?: string;
+    readonly environment?: string;
 }
 export interface ErrorsPage {
     readonly items: readonly ReportingErrorRow[];
@@ -163,6 +186,12 @@ export interface Reporting {
         get(): Promise<Settings>;
         set(patch: Partial<Settings>, by: Actor): Promise<SettingsChange>;
     };
+    /** A per-tenant override of a retention setting (gap issue #11); a key a tenant has not set falls back to `settings`. */
+    readonly tenantSettings: {
+        get(tenantId: string): Promise<Partial<Record<TenantRetentionKey, number>>>;
+        /** `days: null` clears the override, falling back to the site-wide default. Throws on an out-of-bounds value. */
+        set(tenantId: string, key: TenantRetentionKey, days: number | null, by: Actor): Promise<void>;
+    };
     readonly tables: typeof tables;
     readonly site: string;
     readonly log: Logger;

package/dist/writer.d.ts

@@ -3,6 +3,7 @@ export interface WriterOptions {
     db: Db;
     log: Logger;
     site: string;
+    environment: string | null;
     mode: Mode;
     now: () => Date;
     defer: (fn: () => Promise<void>) => void;

package/dist/writer.js

@@ -54,6 +54,7 @@ export class Writer {
             level: v.level,
             kind: v.kind,
             site: this.o.site,
+            environment: this.o.environment,
             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.3.0",
+  "version": "0.4.0",
   "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",