tapimo 0.10.1 → 0.11.0

package/src/internal/Log.ts

@@ -10,10 +10,14 @@ import type * as Timing from './Timing.js'
 
 /** Hono variables read by the request logger and written by other layers. */
 export type Variables = {
+  /** Tempo chain selected for the request. */
+  chainId?: number | undefined
   /** Whether the original request exception was already reported. */
   errorCaptured?: boolean | undefined
   /** Stable error code recorded by `Response.error` for the request log entry. */
   errorCode?: string | undefined
+  /** Whether the optional funding deposit count query failed. */
+  fundingDepositCountFailed?: true | undefined
   /** Bounded MPP relay outcome emitted by the credential routes. */
   mpp?: Entry['mpp'] | undefined
   /** Bounded outcomes for funding providers attempted by the request. */
@@ -125,12 +129,16 @@ export type Sponsorship = {
 export type Entry = {
   /** `'hit'` when the edge response cache served the request without reaching the origin handlers. */
   cache?: 'hit' | undefined
+  /** Tempo chain selected for the request. */
+  chainId?: number | undefined
   /** Total request duration in milliseconds. */
   duration: number
   /** Whether the original request exception was already reported. */
   errorCaptured?: boolean | undefined
   /** Stable error code when the response is a JSON error envelope (e.g. `not_found`, `api_key_invalid`). */
   errorCode?: string | undefined
+  /** Whether the optional funding deposit count query failed. */
+  fundingDepositCountFailed?: true | undefined
   /** Bounded funding provider attempts made while serving the request. */
   fundingProviderAttempts?: readonly FundingProviderAttempt[] | undefined
   /** Whether the optional funding transfer count query failed. */
@@ -253,7 +261,11 @@ export function middleware<environment extends Environment = Environment>(
     const error = c.error as ErrorMetadata | undefined
     const principal = c.get('principal' as never) as Auth.Principal | undefined
     const errorCaptured = c.get('errorCaptured' as never) as boolean | undefined
+    const chainId = c.get('chainId' as never) as number | undefined
     const errorCode = c.get('errorCode' as never) as string | undefined
+    const fundingDepositCountFailed = c.get('fundingDepositCountFailed' as never) as
+      | true
+      | undefined
     const fundingProviderAttempts =
       error?.fundingProviderAttempts ??
       (c.get('fundingProviderAttempts' as never) as Entry['fundingProviderAttempts'] | undefined)
@@ -300,9 +312,11 @@ export function middleware<environment extends Environment = Environment>(
 
     const result = fn({
       ...(c.get('edgeCacheStatus' as never) === 'hit' ? { cache: 'hit' as const } : {}),
+      ...(chainId === undefined ? {} : { chainId }),
       duration: round(duration),
       ...(errorCaptured === undefined ? {} : { errorCaptured }),
       ...(errorCode === undefined ? {} : { errorCode }),
+      ...(fundingDepositCountFailed === undefined ? {} : { fundingDepositCountFailed }),
       ...(fundingProviderAttempts === undefined ? {} : { fundingProviderAttempts }),
       ...(fundingTransferCountFailed === undefined ? {} : { fundingTransferCountFailed }),
       level:

package/src/internal/MetricSink.test.ts

@@ -11,7 +11,7 @@ type MetricEvent = {
 }
 
 describe('requests', () => {
-  test('records optional funding transfer count failures on successful pages', () => {
+  test('records optional funding count failures on successful pages', () => {
     const events: MetricEvent[] = []
     const metrics = Metrics.from({
       count(name, value, tags) {
@@ -25,6 +25,7 @@ describe('requests', () => {
 
     record({
       duration: 10,
+      fundingDepositCountFailed: true,
       fundingTransferCountFailed: true,
       level: 'info',
       method: 'GET',
@@ -34,6 +35,22 @@ describe('requests', () => {
       status: 200,
     })
 
+    expect(events.find((event) => event.name === 'funding_deposit_count_failure_count'))
+      .toMatchInlineSnapshot(`
+      {
+        "name": "funding_deposit_count_failure_count",
+        "tags": {
+          "cache": "miss",
+          "method": "GET",
+          "principal_environment": "none",
+          "principal_type": "unknown",
+          "route": "/v1/funding/transfers",
+        },
+        "type": "count",
+        "value": 1,
+      }
+    `)
+
     expect(events.find((event) => event.name === 'funding_transfer_count_failure_count'))
       .toMatchInlineSnapshot(`
       {
@@ -456,7 +473,7 @@ describe('requests', () => {
 })
 
 describe('webhooks', () => {
-  test('records recovery, poll-cycle, poll-stage, and failed-tick telemetry with bounded tags', () => {
+  test('records scan pipeline blocks, backlog, and finality lag', () => {
     const events: MetricEvent[] = []
     const metrics = Metrics.from({
       count(name, value, tags) {
@@ -466,175 +483,69 @@ describe('webhooks', () => {
       gauge(name, value, tags) {
         events.push({ name, tags, type: 'gauge', value })
       },
+      histogram() {},
+    })
+    const sink = MetricSink.webhooks(metrics)
+
+    sink.record({ chainId: 42431, deferred: false, matches: 3, origin: 'socket', outcome: 'dispatched', type: 'webhook:scan-block', workMs: 12 }) // prettier-ignore
+    sink.record({ chainId: 42431, deferred: true, matches: 0, origin: 'poll', outcome: 'deferred', type: 'webhook:scan-block', workMs: 3 }) // prettier-ignore
+    sink.record({ chainId: 42431, oldestPendingAgeMs: 5_000, pendingCount: 2, type: 'webhook:scan-backlog', watermarkLagBlocks: 7 }) // prettier-ignore
+    sink.record({ chainId: 42431, lagBlocks: 1, type: 'webhook:scan-finality' })
+
+    expect(events.map(({ name, tags, value }) => `${name}=${value} ${JSON.stringify(tags)}`))
+      .toMatchInlineSnapshot(`
+        [
+          "webhook_scan_block_count=1 {"chain_id":"42431","origin":"socket","outcome":"dispatched"}",
+          "webhook_scan_match_count=3 {"chain_id":"42431","origin":"socket","outcome":"dispatched"}",
+          "webhook_scan_block_count=1 {"chain_id":"42431","origin":"poll","outcome":"deferred"}",
+          "webhook_scan_pending_count=2 {"chain_id":"42431"}",
+          "webhook_scan_oldest_pending_age_ms=5000 {"chain_id":"42431"}",
+          "webhook_scan_watermark_lag_blocks=7 {"chain_id":"42431"}",
+          "webhook_scan_finality_lag_blocks=1 {"chain_id":"42431"}",
+        ]
+      `)
+  })
+
+  test('records scan timing spans and per-step attribution', () => {
+    const events: MetricEvent[] = []
+    const metrics = Metrics.from({
+      count(name, value, tags) {
+        events.push({ name, tags, type: 'count', value })
+      },
+      flush() {},
+      gauge() {},
       histogram(name, value, tags) {
         events.push({ name, tags, type: 'histogram', value })
       },
     })
     const sink = MetricSink.webhooks(metrics)
 
-    sink.record({
-      chainId: 4217,
-      dequeuedAt: 1_300,
-      enqueuedAt: 1_100,
-      trigger: 'alarm',
-      type: 'webhook:head-recovery',
-    })
-    sink.record({
-      chainId: 4217,
-      lagBlocks: 2,
-      type: 'webhook:head-progress',
-    })
-    sink.record({
-      chainId: 4217,
-      delayMs: 200,
-      trigger: 'direct',
-      type: 'webhook:poll-start',
-    })
-    sink.record({
-      chainId: 4217,
-      outcome: 'ok',
-      requestedBoundaryAdvanceBlocks: 10,
-      trigger: 'direct',
-      type: 'webhook:poll-cycle',
-    })
-    sink.record({
-      chainId: 4217,
-      failure: 'remote',
-      stage: 'finish',
-      trigger: 'direct',
-      type: 'webhook:poll-failure',
-    })
-    sink.record({
-      chainId: 4217,
-      durationMs: 42,
-      eventType: 'token:transfer',
-      outcome: 'ok',
-      stage: 'scan',
-      type: 'webhook:poll',
-    })
-    sink.record({
-      cursorLagBlocks: 7,
-      meta: { chainId: 4217, durationMs: 50, outcome: 'error' },
-      result: undefined,
-      type: 'webhook:tick',
-    })
+    sink.record({ chainId: 42431, deferred: false, matches: 1, observationLagMs: 600, origin: 'socket', outcome: 'dispatched', queueWaitMs: 900, scanLagMs: 1_500, type: 'webhook:scan-block', workMs: 400 }) // prettier-ignore
+    // A replay carries no observation, so only the block-derived spans exist.
+    sink.record({ chainId: 42431, deferred: false, matches: 0, origin: 'replay', outcome: 'empty', scanLagMs: 30_000_000, type: 'webhook:scan-block', workMs: 250 }) // prettier-ignore
+    // Batch totals: the count is what makes 180ms across two calls readable
+    // as a per-invocation mean rather than a slow single read.
+    sink.record({ chainId: 42431, count: 2, durationMs: 180, step: 'finalized_rpc', type: 'webhook:scan-step' }) // prettier-ignore
+    sink.record({ chainId: 42431, count: 1, durationMs: 95, step: 'subscription_read', type: 'webhook:scan-step' }) // prettier-ignore
 
-    expect(events).toMatchInlineSnapshot(`
-      [
-        {
-          "name": "webhook_head_recovery_queue_count",
-          "tags": {
-            "chain_id": "4217",
-            "trigger": "alarm",
-          },
-          "type": "count",
-          "value": 1,
-        },
-        {
-          "name": "webhook_head_recovery_queue_wait_ms",
-          "tags": {
-            "chain_id": "4217",
-            "trigger": "alarm",
-          },
-          "type": "histogram",
-          "value": 200,
-        },
-        {
-          "name": "webhook_head_progress_lag_blocks",
-          "tags": {
-            "chain_id": "4217",
-          },
-          "type": "gauge",
-          "value": 2,
-        },
-        {
-          "name": "webhook_poll_start_count",
-          "tags": {
-            "chain_id": "4217",
-            "trigger": "direct",
-          },
-          "type": "count",
-          "value": 1,
-        },
-        {
-          "name": "webhook_poll_start_delay_ms",
-          "tags": {
-            "chain_id": "4217",
-            "trigger": "direct",
-          },
-          "type": "histogram",
-          "value": 200,
-        },
-        {
-          "name": "webhook_poll_cycle_count",
-          "tags": {
-            "chain_id": "4217",
-            "outcome": "ok",
-            "trigger": "direct",
-          },
-          "type": "count",
-          "value": 1,
-        },
-        {
-          "name": "webhook_poll_requested_boundary_advance_blocks",
-          "tags": {
-            "chain_id": "4217",
-            "outcome": "ok",
-            "trigger": "direct",
-          },
-          "type": "histogram",
-          "value": 10,
-        },
-        {
-          "name": "webhook_poll_failure_count",
-          "tags": {
-            "chain_id": "4217",
-            "failure": "remote",
-            "stage": "finish",
-            "trigger": "direct",
-          },
-          "type": "count",
-          "value": 1,
-        },
-        {
-          "name": "webhook_poller_stage_duration_ms",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "token:transfer",
-            "outcome": "ok",
-            "stage": "scan",
-          },
-          "type": "histogram",
-          "value": 42,
-        },
-        {
-          "name": "webhook_poller_tick_count",
-          "tags": {
-            "chain_id": "4217",
-            "outcome": "error",
-          },
-          "type": "count",
-          "value": 1,
-        },
-        {
-          "name": "webhook_poller_tick_duration_ms",
-          "tags": {
-            "chain_id": "4217",
-            "outcome": "error",
-          },
-          "type": "histogram",
-          "value": 50,
-        },
-        {
-          "name": "webhook_subscription_cursor_lag_blocks",
-          "tags": {
-            "chain_id": "4217",
-          },
-          "type": "gauge",
-          "value": 7,
-        },
-      ]
-    `)
+    expect(events.map(({ name, tags, value }) => `${name}=${value} ${JSON.stringify(tags)}`))
+      .toMatchInlineSnapshot(`
+        [
+          "webhook_scan_block_count=1 {"chain_id":"42431","origin":"socket","outcome":"dispatched"}",
+          "webhook_scan_match_count=1 {"chain_id":"42431","origin":"socket","outcome":"dispatched"}",
+          "webhook_scan_work_ms=400 {"chain_id":"42431","origin":"socket","outcome":"dispatched"}",
+          "webhook_scan_queue_wait_ms=900 {"chain_id":"42431","origin":"socket","outcome":"dispatched","deferred":"false"}",
+          "webhook_scan_observation_lag_ms=600 {"chain_id":"42431","origin":"socket"}",
+          "webhook_scan_lag_ms=1500 {"chain_id":"42431"}",
+          "webhook_scan_block_count=1 {"chain_id":"42431","origin":"replay","outcome":"empty"}",
+          "webhook_scan_work_ms=250 {"chain_id":"42431","origin":"replay","outcome":"empty"}",
+          "webhook_scan_lag_ms=30000000 {"chain_id":"42431"}",
+          "webhook_scan_step_duration_ms=180 {"chain_id":"42431","step":"finalized_rpc"}",
+          "webhook_scan_step_count=2 {"chain_id":"42431","step":"finalized_rpc"}",
+          "webhook_scan_step_duration_ms=95 {"chain_id":"42431","step":"subscription_read"}",
+          "webhook_scan_step_count=1 {"chain_id":"42431","step":"subscription_read"}",
+        ]
+      `)
   })
 
   test('records obligation staging and claim outcomes', () => {
@@ -692,200 +603,6 @@ describe('webhooks', () => {
     `)
   })
 
-  test('records scan boundaries with bounded workload dimensions', () => {
-    const events: MetricEvent[] = []
-    const metrics = Metrics.from({
-      count(name, value, tags) {
-        events.push({ name, tags, type: 'count', value })
-      },
-      flush() {},
-      gauge() {},
-      histogram(name, value, tags) {
-        events.push({ name, tags, type: 'histogram', value })
-      },
-    })
-    const sink = MetricSink.webhooks(metrics)
-
-    sink.record({
-      chainId: 4217,
-      concurrency: 8,
-      eventType: 'log:emitted',
-      maxWindowBlocks: 1_000,
-      phase: 'start',
-      rpcMethod: 'eth_getLogs',
-      subscriptionCount: 8,
-      subscriptionLimit: 256,
-      totalWindowBlocks: 8_000,
-      type: 'webhook:poll-scan',
-    })
-    sink.record({
-      chainId: 4217,
-      concurrency: 8,
-      durationMs: 250,
-      eventType: 'log:emitted',
-      failedSubscriptions: 1,
-      matchedItems: 700,
-      maxWindowBlocks: 1_000,
-      outcome: 'error',
-      phase: 'complete',
-      rpcMethod: 'eth_getLogs',
-      subscriptionCount: 8,
-      subscriptionLimit: 256,
-      totalWindowBlocks: 8_000,
-      type: 'webhook:poll-scan',
-    })
-
-    expect(events.map(({ name, tags, value }) => ({ name, tags, value }))).toMatchInlineSnapshot(`
-      [
-        {
-          "name": "webhook_poller_scan_checkpoint_count",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "start",
-          },
-          "value": 1,
-        },
-        {
-          "name": "webhook_poller_scan_concurrency",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "start",
-          },
-          "value": 8,
-        },
-        {
-          "name": "webhook_poller_scan_subscription_count",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "start",
-          },
-          "value": 8,
-        },
-        {
-          "name": "webhook_poller_scan_subscription_limit",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "start",
-          },
-          "value": 256,
-        },
-        {
-          "name": "webhook_poller_scan_max_window_blocks",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "start",
-          },
-          "value": 1000,
-        },
-        {
-          "name": "webhook_poller_scan_total_window_blocks",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "start",
-          },
-          "value": 8000,
-        },
-        {
-          "name": "webhook_poller_scan_checkpoint_count",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "complete",
-          },
-          "value": 1,
-        },
-        {
-          "name": "webhook_poller_scan_concurrency",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "complete",
-          },
-          "value": 8,
-        },
-        {
-          "name": "webhook_poller_scan_subscription_count",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "complete",
-          },
-          "value": 8,
-        },
-        {
-          "name": "webhook_poller_scan_subscription_limit",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "complete",
-          },
-          "value": 256,
-        },
-        {
-          "name": "webhook_poller_scan_max_window_blocks",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "complete",
-          },
-          "value": 1000,
-        },
-        {
-          "name": "webhook_poller_scan_total_window_blocks",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "complete",
-          },
-          "value": 8000,
-        },
-        {
-          "name": "webhook_poller_scan_duration_ms",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "complete",
-          },
-          "value": 250,
-        },
-        {
-          "name": "webhook_poller_scan_failed_subscription_count",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "complete",
-          },
-          "value": 1,
-        },
-        {
-          "name": "webhook_poller_scan_matched_item_count",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "phase": "complete",
-          },
-          "value": 700,
-        },
-        {
-          "name": "webhook_poller_rpc_scan_count",
-          "tags": {
-            "chain_id": "4217",
-            "event_type": "log:emitted",
-            "outcome": "error",
-            "rpc_method": "eth_getLogs",
-          },
-          "value": 1,
-        },
-      ]
-    `)
-  })
-
   test('records delivery stages without subscription identity', () => {
     const events: MetricEvent[] = []
     const metrics = Metrics.from({