@dotdo/postgres 0.1.0

package/dist/observability/cost-metrics.d.ts

@@ -0,0 +1,269 @@
+/**
+ * Cost Metrics Collector
+ *
+ * Tracks Cloudflare Workers costs including:
+ * - Durable Object storage reads/writes
+ * - R2 operations (Class A/B)
+ * - Cache API usage (free but tracked for optimization)
+ * - CPU time consumption
+ * - Subrequest counts
+ *
+ * Provides cost estimation based on current Cloudflare pricing.
+ */
+import type { MetricSnapshot } from './types';
+/**
+ * Cloudflare pricing constants
+ * These are the standard pay-as-you-go prices
+ */
+export declare const CloudflarePricing: {
+    /**
+     * Durable Object storage pricing
+     * - Storage: $0.20/GB-month
+     * - Reads: $0.20/million
+     * - Writes: $1.00/million
+     * - Deletes: $1.00/million
+     */
+    readonly DO_STORAGE_PER_GB_MONTH: 0.2;
+    readonly DO_READ_PER_MILLION: 0.2;
+    readonly DO_WRITE_PER_MILLION: 1;
+    readonly DO_DELETE_PER_MILLION: 1;
+    /**
+     * R2 storage pricing
+     * - Storage: $0.015/GB-month
+     * - Class A operations (mutate): $4.50/million
+     * - Class B operations (read): $0.36/million
+     * - Egress: Free
+     */
+    readonly R2_STORAGE_PER_GB_MONTH: 0.015;
+    readonly R2_CLASS_A_PER_MILLION: 4.5;
+    readonly R2_CLASS_B_PER_MILLION: 0.36;
+    /**
+     * Workers pricing
+     * - Requests: $0.50/million (after free tier of 10M)
+     * - CPU time: $0.02/million ms (after free tier)
+     * - Duration: Based on plan
+     */
+    readonly WORKERS_REQUESTS_PER_MILLION: 0.5;
+    readonly WORKERS_CPU_PER_MILLION_MS: 0.02;
+    /**
+     * Free tier limits (per month)
+     */
+    readonly FREE_TIER: {
+        readonly WORKERS_REQUESTS: 10000000;
+        readonly DO_STORAGE_GB: 1;
+        readonly DO_READS: 1000000;
+        readonly DO_WRITES: 1000000;
+        readonly R2_STORAGE_GB: 10;
+        readonly R2_CLASS_A: 1000000;
+        readonly R2_CLASS_B: 10000000;
+    };
+};
+/**
+ * Operation types for Durable Object storage
+ */
+export type DOStorageOperation = 'read' | 'write' | 'delete' | 'list';
+/**
+ * R2 operation classes
+ * Class A: PUT, POST, COPY, LIST, CREATE_MULTIPART, UPLOAD_PART, COMPLETE_MULTIPART, ABORT_MULTIPART
+ * Class B: GET, HEAD
+ */
+export type R2OperationClass = 'A' | 'B';
+/**
+ * R2 operation types
+ */
+export type R2Operation = 'put' | 'get' | 'delete' | 'list' | 'head' | 'copy' | 'multipartUpload' | 'multipartComplete' | 'multipartAbort';
+/**
+ * Cache operation types
+ */
+export type CacheOperation = 'get' | 'put' | 'delete' | 'match';
+/**
+ * Subrequest types
+ */
+export type SubrequestType = 'fetch' | 'kv' | 'do' | 'r2' | 'cache' | 'other';
+/**
+ * Cost breakdown by service
+ */
+export interface CostBreakdown {
+    /** Durable Object costs */
+    durableObjects: {
+        storage: number;
+        reads: number;
+        writes: number;
+        deletes: number;
+        total: number;
+    };
+    /** R2 costs */
+    r2: {
+        storage: number;
+        classA: number;
+        classB: number;
+        total: number;
+    };
+    /** Workers costs */
+    workers: {
+        requests: number;
+        cpuTime: number;
+        total: number;
+    };
+    /** Cache API usage (always 0 cost but tracked) */
+    cache: {
+        hits: number;
+        misses: number;
+        puts: number;
+        savedCost: number;
+    };
+    /** Total estimated cost */
+    totalCost: number;
+    /** Percentage breakdown */
+    percentages: {
+        durableObjects: number;
+        r2: number;
+        workers: number;
+    };
+}
+/**
+ * Cost metrics summary
+ */
+export interface CostMetricsSummary {
+    /** Period start timestamp */
+    periodStart: number;
+    /** Period end timestamp */
+    periodEnd: number;
+    /** Raw metrics */
+    metrics: {
+        doReads: number;
+        doWrites: number;
+        doDeletes: number;
+        doStorageBytes: number;
+        r2ClassA: number;
+        r2ClassB: number;
+        r2StorageBytes: number;
+        cacheHits: number;
+        cacheMisses: number;
+        cachePuts: number;
+        cpuTimeMs: number;
+        subrequests: number;
+        requests: number;
+    };
+    /** Cost breakdown */
+    costs: CostBreakdown;
+    /** OpenTelemetry-compatible attributes */
+    otelAttributes: Record<string, string | number | boolean>;
+}
+/**
+ * Cost metrics collector interface
+ */
+export interface CostMetricsCollector {
+    /** Track a Durable Object storage operation */
+    trackDOOperation(operation: DOStorageOperation, count?: number, bytes?: number): void;
+    /** Track an R2 operation */
+    trackR2Operation(operation: R2Operation, count?: number, bytes?: number): void;
+    /** Track a Cache API operation */
+    trackCacheOperation(operation: CacheOperation, hit?: boolean, bytes?: number): void;
+    /** Track CPU time consumption */
+    trackCPUTime(milliseconds: number): void;
+    /** Track a subrequest */
+    trackSubrequest(type?: SubrequestType): void;
+    /** Track a request */
+    trackRequest(): void;
+    /** Set storage usage (for cost estimation) */
+    setDOStorageUsage(bytes: number): void;
+    /** Set R2 storage usage (for cost estimation) */
+    setR2StorageUsage(bytes: number): void;
+    /** Get cost metrics summary */
+    getSummary(): CostMetricsSummary;
+    /** Get cost breakdown */
+    getCostBreakdown(): CostBreakdown;
+    /** Export metrics in OpenTelemetry format */
+    exportOTel(): MetricSnapshot[];
+    /** Reset all metrics */
+    reset(): void;
+}
+/**
+ * Cost metrics collector implementation
+ */
+export declare class CostMetricsCollectorImpl implements CostMetricsCollector {
+    private periodStart;
+    private doReads;
+    private doWrites;
+    private doDeletes;
+    private doStorageBytes;
+    private r2ClassA;
+    private r2ClassB;
+    private r2StorageBytes;
+    private cacheHits;
+    private cacheMisses;
+    private cachePuts;
+    private cpuTimeMs;
+    private subrequests;
+    private subrequestsByType;
+    private requests;
+    constructor();
+    trackDOOperation(operation: DOStorageOperation, count?: number, bytes?: number): void;
+    trackR2Operation(operation: R2Operation, count?: number, bytes?: number): void;
+    trackCacheOperation(operation: CacheOperation, hit?: boolean, _bytes?: number): void;
+    trackCPUTime(milliseconds: number): void;
+    trackSubrequest(type?: SubrequestType): void;
+    trackRequest(): void;
+    setDOStorageUsage(bytes: number): void;
+    setR2StorageUsage(bytes: number): void;
+    getCostBreakdown(): CostBreakdown;
+    getSummary(): CostMetricsSummary;
+    /**
+     * Get OpenTelemetry-compatible attributes
+     */
+    private getOTelAttributes;
+    exportOTel(): MetricSnapshot[];
+    reset(): void;
+}
+/**
+ * Create a new cost metrics collector
+ */
+export declare function createCostMetricsCollector(): CostMetricsCollector;
+/**
+ * No-op cost metrics collector
+ */
+export declare class NoOpCostMetricsCollector implements CostMetricsCollector {
+    trackDOOperation(): void;
+    trackR2Operation(): void;
+    trackCacheOperation(): void;
+    trackCPUTime(): void;
+    trackSubrequest(): void;
+    trackRequest(): void;
+    setDOStorageUsage(): void;
+    setR2StorageUsage(): void;
+    getSummary(): CostMetricsSummary;
+    getCostBreakdown(): CostBreakdown;
+    exportOTel(): MetricSnapshot[];
+    reset(): void;
+}
+/**
+ * Create a no-op cost metrics collector
+ */
+export declare function createNoOpCostMetricsCollector(): CostMetricsCollector;
+/**
+ * Standard cost metric names
+ */
+export declare const CostMetricNames: {
+    readonly DO_READS: "cloudflare.do.reads";
+    readonly DO_WRITES: "cloudflare.do.writes";
+    readonly DO_DELETES: "cloudflare.do.deletes";
+    readonly DO_STORAGE_BYTES: "cloudflare.do.storage_bytes";
+    readonly DO_COST_USD: "cloudflare.cost.do_usd";
+    readonly R2_CLASS_A: "cloudflare.r2.class_a_operations";
+    readonly R2_CLASS_B: "cloudflare.r2.class_b_operations";
+    readonly R2_STORAGE_BYTES: "cloudflare.r2.storage_bytes";
+    readonly R2_COST_USD: "cloudflare.cost.r2_usd";
+    readonly CACHE_HITS: "cloudflare.cache.hits";
+    readonly CACHE_MISSES: "cloudflare.cache.misses";
+    readonly CACHE_PUTS: "cloudflare.cache.puts";
+    readonly CACHE_HIT_RATIO: "cloudflare.cache.hit_ratio";
+    readonly CACHE_SAVED_USD: "cloudflare.cost.cache_saved_usd";
+    readonly WORKERS_CPU_TIME_MS: "cloudflare.workers.cpu_time_ms";
+    readonly WORKERS_SUBREQUESTS: "cloudflare.workers.subrequests";
+    readonly WORKERS_REQUESTS: "cloudflare.workers.requests";
+    readonly WORKERS_COST_USD: "cloudflare.cost.workers_usd";
+    readonly TOTAL_COST_USD: "cloudflare.cost.total_usd";
+};
+export type CostMetricName = (typeof CostMetricNames)[keyof typeof CostMetricNames];
+//# sourceMappingURL=cost-metrics.d.ts.map

package/dist/observability/cost-metrics.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cost-metrics.d.ts","sourceRoot":"","sources":["../../src/observability/cost-metrics.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAA;AAM7C;;;GAGG;AACH,eAAO,MAAM,iBAAiB;IAC5B;;;;;;OAMG;;;;;IAMH;;;;;;OAMG;;;;IAKH;;;;;OAKG;;;IAIH;;OAEG;;;;;;;;;;CAUK,CAAA;AAMV;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,CAAA;AAErE;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,GAAG,GAAG,GAAG,CAAA;AAExC;;GAEG;AACH,MAAM,MAAM,WAAW,GACnB,KAAK,GACL,KAAK,GACL,QAAQ,GACR,MAAM,GACN,MAAM,GACN,MAAM,GACN,iBAAiB,GACjB,mBAAmB,GACnB,gBAAgB,CAAA;AAEpB;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAA;AAE/D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,OAAO,GAAG,OAAO,CAAA;AAE7E;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,2BAA2B;IAC3B,cAAc,EAAE;QACd,OAAO,EAAE,MAAM,CAAA;QACf,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;QACd,OAAO,EAAE,MAAM,CAAA;QACf,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,eAAe;IACf,EAAE,EAAE;QACF,OAAO,EAAE,MAAM,CAAA;QACf,MAAM,EAAE,MAAM,CAAA;QACd,MAAM,EAAE,MAAM,CAAA;QACd,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,oBAAoB;IACpB,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAA;QAChB,OAAO,EAAE,MAAM,CAAA;QACf,KAAK,EAAE,MAAM,CAAA;KACd,CAAA;IACD,kDAAkD;IAClD,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAA;QACZ,MAAM,EAAE,MAAM,CAAA;QACd,IAAI,EAAE,MAAM,CAAA;QACZ,SAAS,EAAE,MAAM,CAAA;KAClB,CAAA;IACD,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,2BAA2B;IAC3B,WAAW,EAAE;QACX,cAAc,EAAE,MAAM,CAAA;QACtB,EAAE,EAAE,MAAM,CAAA;QACV,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,6BAA6B;IAC7B,WAAW,EAAE,MAAM,CAAA;IACnB,2BAA2B;IAC3B,SAAS,EAAE,MAAM,CAAA;IACjB,kBAAkB;IAClB,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAA;QACf,QAAQ,EAAE,MAAM,CAAA;QAChB,SAAS,EAAE,MAAM,CAAA;QACjB,cAAc,EAAE,MAAM,CAAA;QACtB,QAAQ,EAAE,MAAM,CAAA;QAChB,QAAQ,EAAE,MAAM,CAAA;QAChB,cAAc,EAAE,MAAM,CAAA;QACtB,SAAS,EAAE,MAAM,CAAA;QACjB,WAAW,EAAE,MAAM,CAAA;QACnB,SAAS,EAAE,MAAM,CAAA;QACjB,SAAS,EAAE,MAAM,CAAA;QACjB,WAAW,EAAE,MAAM,CAAA;QACnB,QAAQ,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,qBAAqB;IACrB,KAAK,EAAE,aAAa,CAAA;IACpB,0CAA0C;IAC1C,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAA;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,+CAA+C;IAC/C,gBAAgB,CAAC,SAAS,EAAE,kBAAkB,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrF,4BAA4B;IAC5B,gBAAgB,CAAC,SAAS,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC9E,kCAAkC;IAClC,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,GAAG,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACnF,iCAAiC;IACjC,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IACxC,yBAAyB;IACzB,eAAe,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,IAAI,CAAA;IAC5C,sBAAsB;IACtB,YAAY,IAAI,IAAI,CAAA;IACpB,8CAA8C;IAC9C,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,iDAAiD;IACjD,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACtC,+BAA+B;IAC/B,UAAU,IAAI,kBAAkB,CAAA;IAChC,yBAAyB;IACzB,gBAAgB,IAAI,aAAa,CAAA;IACjC,6CAA6C;IAC7C,UAAU,IAAI,cAAc,EAAE,CAAA;IAC9B,wBAAwB;IACxB,KAAK,IAAI,IAAI,CAAA;CACd;AA2BD;;GAEG;AACH,qBAAa,wBAAyB,YAAW,oBAAoB;IACnE,OAAO,CAAC,WAAW,CAAQ;IAC3B,OAAO,CAAC,OAAO,CAAI;IACnB,OAAO,CAAC,QAAQ,CAAI;IACpB,OAAO,CAAC,SAAS,CAAI;IACrB,OAAO,CAAC,cAAc,CAAI;IAC1B,OAAO,CAAC,QAAQ,CAAI;IACpB,OAAO,CAAC,QAAQ,CAAI;IACpB,OAAO,CAAC,cAAc,CAAI;IAC1B,OAAO,CAAC,SAAS,CAAI;IACrB,OAAO,CAAC,WAAW,CAAI;IACvB,OAAO,CAAC,SAAS,CAAI;IACrB,OAAO,CAAC,SAAS,CAAI;IACrB,OAAO,CAAC,WAAW,CAAI;IACvB,OAAO,CAAC,iBAAiB,CAAyC;IAClE,OAAO,CAAC,QAAQ,CAAI;;IAMpB,gBAAgB,CACd,SAAS,EAAE,kBAAkB,EAC7B,KAAK,SAAI,EACT,KAAK,CAAC,EAAE,MAAM,GACb,IAAI;IAsBP,gBAAgB,CAAC,SAAS,EAAE,WAAW,EAAE,KAAK,SAAI,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;IAazE,mBAAmB,CACjB,SAAS,EAAE,cAAc,EACzB,GAAG,CAAC,EAAE,OAAO,EACb,MAAM,CAAC,EAAE,MAAM,GACd,IAAI;IAmBP,YAAY,CAAC,YAAY,EAAE,MAAM,GAAG,IAAI;IAIxC,eAAe,CAAC,IAAI,GAAE,cAAwB,GAAG,IAAI;IAMrD,YAAY,IAAI,IAAI;IAIpB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAItC,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAItC,gBAAgB,IAAI,aAAa;IAiFjC,UAAU,IAAI,kBAAkB;IA2BhC;;OAEG;IACH,OAAO,CAAC,iBAAiB;IA8CzB,UAAU,IAAI,cAAc,EAAE;IA+K9B,KAAK,IAAI,IAAI;CAiBd;AAED;;GAEG;AACH,wBAAgB,0BAA0B,IAAI,oBAAoB,CAEjE;AAED;;GAEG;AACH,qBAAa,wBAAyB,YAAW,oBAAoB;IACnE,gBAAgB,IAAI,IAAI;IACxB,gBAAgB,IAAI,IAAI;IACxB,mBAAmB,IAAI,IAAI;IAC3B,YAAY,IAAI,IAAI;IACpB,eAAe,IAAI,IAAI;IACvB,YAAY,IAAI,IAAI;IACpB,iBAAiB,IAAI,IAAI;IACzB,iBAAiB,IAAI,IAAI;IAEzB,UAAU,IAAI,kBAAkB;IAwBhC,gBAAgB,IAAI,aAAa;IAWjC,UAAU,IAAI,cAAc,EAAE;IAI9B,KAAK,IAAI,IAAI;CACd;AAED;;GAEG;AACH,wBAAgB,8BAA8B,IAAI,oBAAoB,CAErE;AAMD;;GAEG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;;;;;;;;;;CA6BlB,CAAA;AAEV,MAAM,MAAM,cAAc,GAAG,CAAC,OAAO,eAAe,CAAC,CAAC,MAAM,OAAO,eAAe,CAAC,CAAA"}