Metrics

import { collectMetrics } from '@adonis-agora/durable'

const metrics = collectMetrics(engine)

export interface MetricsCollector {
  snapshot(): MetricsSnapshot
  /** Prometheus text exposition of the counters — serve this from a `/metrics` endpoint. */
  prometheus(): string
  /** Unsubscribe from the engine. */
  stop(): void
}

export interface MetricsSnapshot {
  /** `routed`: failures handed to an onError handler; `unrouted`: routes the engine could not apply. */
  runs: {
    started: number
    completed: number
    failed: number
    suspended: number
    routed: number
    unrouted: number
  }
  /** Routed failures by error code (`*` for a failure without one). */
  routedByCode: Record<string, number>
  steps: { started: number; completed: number; failed: number }
  /** Per-workflow run counters, keyed by workflow name. */
  byWorkflow: Record<string, { started: number; completed: number; failed: number }>
  /** Sum + count of recorded step durations (ms), for an average. */
  stepDuration: { sumMs: number; count: number }
}

import router from '@adonisjs/core/services/router'
import engine from '@adonis-agora/durable/services/main'
import { collectMetrics } from '@adonis-agora/durable'

const durableMetrics = collectMetrics(engine)

router.get('/metrics', ({ response }) => {
  response.header('content-type', 'text/plain; version=0.0.4')
  return durableMetrics.prometheus()
})

# TYPE durable_runs_total counter
durable_runs_total{event="started"} 42
durable_runs_total{event="completed"} 38
durable_runs_total{event="failed"} 2
durable_runs_total{event="suspended"} 6
durable_runs_total{event="routed"} 1
durable_runs_total{event="unrouted"} 0
# TYPE durable_steps_total counter
durable_steps_total{event="started"} 120
durable_steps_total{event="completed"} 115
durable_steps_total{event="failed"} 3
# TYPE durable_runs_by_workflow_total counter
durable_runs_by_workflow_total{workflow="charge-order",event="started"} 42
durable_runs_by_workflow_total{workflow="charge-order",event="completed"} 38
durable_runs_by_workflow_total{workflow="charge-order",event="failed"} 2
# TYPE durable_runs_routed_total counter
durable_runs_routed_total{code="E_CARD_DECLINED"} 1
# TYPE durable_step_duration_ms_sum counter
durable_step_duration_ms_sum 184230
# TYPE durable_step_duration_count counter
durable_step_duration_count 115

import { attachDurableMetrics } from '@adonis-agora/durable/otel'

const metrics = attachDurableMetrics(engine)

export interface DurableMetrics {
  /** A point-in-time copy of the counters and duration percentiles. */
  snapshot(): DurableMetricsSnapshot
  /** Zero everything (e.g. between scrape windows). */
  reset(): void
  /** Stop collecting. */
  unsubscribe(): void
}

export interface DurableMetricsSnapshot {
  runs: {
    started: number
    completed: number
    failed: number
    suspended: number
    /** Failures handed to an onError handler instead of failing the run. */
    routed: number
    /** Failures that had onError routes the engine could not apply (workers disagree). */
    unrouted: number
  }
  /** Routed failures by error code (`*` for a failure without one). */
  routedByCode: Record<string, number>
  steps: { completed: number; failed: number }
  /** Per-step wall-clock (from the `durationMs` on step events). */
  stepDurationMs: DurationStats
  /** Per-run wall-clock, measured `run.started` → terminal. */
  runDurationMs: DurationStats
}

export interface DurationStats {
  count: number
  /** Median, 95th percentile, and max — in milliseconds. */
  p50: number
  p95: number
  max: number
}

import router from '@adonisjs/core/services/router'
import engine from '@adonis-agora/durable/services/main'
import { attachDurableMetrics } from '@adonis-agora/durable/otel'

const durableMetrics = attachDurableMetrics(engine)

router.get('/metrics/durable', () => durableMetrics.snapshot())