react-render-pulse 0.0.0-stage → 1.0.1

package/dist/export/console.d.cts

@@ -0,0 +1,3 @@
+import type { Exporter } from "../types.cjs";
+/** Logs each batch as a table, slowest areas first. Used by default when no `endpoint` is set, for local testing. */
+export declare function createConsoleExporter(): Exporter;

package/dist/export/console.d.ts

@@ -0,0 +1,4 @@
+import type { Exporter } from "../types.js";
+/** Logs each batch as a table, slowest areas first. Used by default when no `endpoint` is set, for local testing. */
+export declare function createConsoleExporter(): Exporter;
+//# sourceMappingURL=console.d.ts.map

package/dist/export/console.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"console.d.ts","sourceRoot":"","sources":["../../src/export/console.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,qHAAqH;AACrH,wBAAgB,qBAAqB,IAAI,QAAQ,CA2BhD"}

package/dist/export/otel.d.cts

@@ -0,0 +1,34 @@
+import type { Exporter } from "../types.cjs";
+type Attributes = Record<string, string | number | boolean>;
+/**
+ * The parts of an OpenTelemetry `Meter` this exporter uses. Structurally
+ * compatible with `@opentelemetry/api`'s `Meter`, so there's no dependency on it.
+ */
+export interface OtelMeterLike {
+    createHistogram: (name: string, options?: {
+        description?: string;
+        unit?: string;
+    }) => {
+        record: (value: number, attributes?: Attributes) => void;
+    };
+    createCounter: (name: string, options?: {
+        description?: string;
+        unit?: string;
+    }) => {
+        add: (value: number, attributes?: Attributes) => void;
+    };
+}
+export interface OtelExporterOptions {
+    /** e.g. `metrics.getMeter("my-app")` from `@opentelemetry/api`. */
+    meter: OtelMeterLike;
+    /** Renders slower than this also increment `render_pulse.render.slow`. Defaults to 16. */
+    slowRenderMs?: number | undefined;
+}
+/**
+ * Records every measurement as OpenTelemetry metrics:
+ * - `render_pulse.render.duration` (histogram, ms) with `render_pulse.area`, `render_pulse.route`, `render_pulse.phase`, `render_pulse.mode`
+ * - `render_pulse.render.slow` (counter) with the same attributes
+ * - `render_pulse.longtask.duration` (histogram, ms) with `render_pulse.area`, `render_pulse.route`, `render_pulse.kind`
+ */
+export declare function createOtelExporter(options: OtelExporterOptions): Exporter;
+export {};

package/dist/export/otel.d.ts

@@ -0,0 +1,35 @@
+import type { Exporter } from "../types.js";
+type Attributes = Record<string, string | number | boolean>;
+/**
+ * The parts of an OpenTelemetry `Meter` this exporter uses. Structurally
+ * compatible with `@opentelemetry/api`'s `Meter`, so there's no dependency on it.
+ */
+export interface OtelMeterLike {
+    createHistogram: (name: string, options?: {
+        description?: string;
+        unit?: string;
+    }) => {
+        record: (value: number, attributes?: Attributes) => void;
+    };
+    createCounter: (name: string, options?: {
+        description?: string;
+        unit?: string;
+    }) => {
+        add: (value: number, attributes?: Attributes) => void;
+    };
+}
+export interface OtelExporterOptions {
+    /** e.g. `metrics.getMeter("my-app")` from `@opentelemetry/api`. */
+    meter: OtelMeterLike;
+    /** Renders slower than this also increment `render_pulse.render.slow`. Defaults to 16. */
+    slowRenderMs?: number | undefined;
+}
+/**
+ * Records every measurement as OpenTelemetry metrics:
+ * - `render_pulse.render.duration` (histogram, ms) with `render_pulse.area`, `render_pulse.route`, `render_pulse.phase`, `render_pulse.mode`
+ * - `render_pulse.render.slow` (counter) with the same attributes
+ * - `render_pulse.longtask.duration` (histogram, ms) with `render_pulse.area`, `render_pulse.route`, `render_pulse.kind`
+ */
+export declare function createOtelExporter(options: OtelExporterOptions): Exporter;
+export {};
+//# sourceMappingURL=otel.d.ts.map

package/dist/export/otel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"otel.d.ts","sourceRoot":"","sources":["../../src/export/otel.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,KAAK,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,eAAe,EAAE,CACf,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAC9C;QAAE,MAAM,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,KAAK,IAAI,CAAA;KAAE,CAAC;IAClE,aAAa,EAAE,CACb,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,KAC9C;QAAE,GAAG,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,KAAK,IAAI,CAAA;KAAE,CAAC;CAChE;AAED,MAAM,WAAW,mBAAmB;IAClC,mEAAmE;IACnE,KAAK,EAAE,aAAa,CAAC;IACrB,0FAA0F;IAC1F,YAAY,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,mBAAmB,GAAG,QAAQ,CAkCzE"}

package/dist/hooks/useRenderMonitor.d.cts

@@ -0,0 +1,9 @@
+/**
+ * Tracks the renders of the component that calls it, reported under `id`.
+ *
+ * Render counts are exact. The duration runs from the hook's call to the
+ * commit, so it also includes anything React renders after this component
+ * in the same update: an upper bound. Wrap the component in `<RenderMonitor>`
+ * when you need its own render time.
+ */
+export declare function useRenderMonitor(id: string): void;

package/dist/hooks/useRenderMonitor.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Tracks the renders of the component that calls it, reported under `id`.
+ *
+ * Render counts are exact. The duration runs from the hook's call to the
+ * commit, so it also includes anything React renders after this component
+ * in the same update: an upper bound. Wrap the component in `<RenderMonitor>`
+ * when you need its own render time.
+ */
+export declare function useRenderMonitor(id: string): void;
+//# sourceMappingURL=useRenderMonitor.d.ts.map

package/dist/hooks/useRenderMonitor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useRenderMonitor.d.ts","sourceRoot":"","sources":["../../src/hooks/useRenderMonitor.ts"],"names":[],"mappings":"AAOA;;;;;;;GAOG;AACH,wBAAgB,gBAAgB,CAAC,EAAE,EAAE,MAAM,GAAG,IAAI,CAgBjD"}