@gravito/core 1.6.1 → 2.0.1

package/dist/events/aggregation/types.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Event aggregation and deduplication types (FS-102)
+ * @internal
+ */
+import { BackpressureState } from '../BackpressureManager';
+/**
+ * Deduplication statistics.
+ */
+export interface DeduplicationStats {
+    /** Total events submitted */
+    totalEvents: number;
+    /** Events after deduplication */
+    deduplicatedEvents: number;
+    /** Events removed by deduplication */
+    removedCount: number;
+    /** Number of patterns aggregated */
+    patternsAggregated: number;
+    /** Deduplication rate (%) */
+    deduplicationRate: number;
+}
+/**
+ * Batch submission statistics.
+ */
+export interface BatchStats {
+    /** Total batches submitted */
+    totalBatches: number;
+    /** Total events submitted */
+    totalEvents: number;
+    /** Average batch size */
+    averageBatchSize: number;
+    /** Average batch latency (ms) */
+    averageBatchLatency: number;
+    /** Last flush timestamp */
+    lastFlushTime: number;
+    /** Pending events in queue */
+    pendingEvents: number;
+    /** Auto-triggered flushes */
+    autoFlushCount: number;
+    /** Manual flushes */
+    manualFlushCount: number;
+}
+/**
+ * Aggregation window statistics.
+ */
+export interface WindowStats {
+    /** Current window size (ms) */
+    currentWindowMs: number;
+    /** Minimum window size (ms) */
+    minWindowMs: number;
+    /** Maximum window size (ms) */
+    maxWindowMs: number;
+    /** Last window adjustment reason */
+    lastAdjustmentReason?: string;
+    /** Window adjustment count */
+    adjustmentCount: number;
+}
+/**
+ * Complete aggregation statistics.
+ */
+export interface AggregationStats {
+    deduplication: DeduplicationStats;
+    batching: BatchStats;
+    window: WindowStats;
+    timestamp: number;
+}
+/**
+ * Aggregation configuration options.
+ */
+export interface AggregationConfig {
+    /** Enable aggregation (default: false) */
+    enabled: boolean;
+    /** Window size in milliseconds (default: 200) */
+    windowMs?: number;
+    /** Batch size threshold (default: 50) */
+    batchSize?: number;
+    /** Deduplication strategy */
+    deduplication?: 'pattern' | 'idempotencyKey' | 'off';
+    /** Deduplication pattern (string or function) */
+    pattern?: string | ((args: unknown) => string);
+    /** Merge priority when deduplicating */
+    mergePriority?: 'highest' | 'earliest' | 'latest';
+    /** Enable background cleanup (default: true) */
+    enableCleanup?: boolean;
+    /** Cleanup interval (ms, default: 5 minutes) */
+    cleanupIntervalMs?: number;
+    /** TTL for deduplication entries (ms, default: 10 minutes) */
+    ttlMs?: number;
+}
+/**
+ * Default aggregation configuration.
+ */
+export declare const DEFAULT_AGGREGATION_CONFIG: Required<AggregationConfig>;
+/**
+ * Priority order for merge decisions.
+ */
+export declare const PRIORITY_ORDER: Record<string, number>;
+/**
+ * Backpressure-aware window configuration.
+ */
+export interface WindowAdjustmentConfig {
+    /** Window for NORMAL backpressure state */
+    normalMs: number;
+    /** Window for WARNING backpressure state */
+    warningMs: number;
+    /** Window for CRITICAL backpressure state */
+    criticalMs: number;
+    /** Window for OVERFLOW backpressure state */
+    overflowMs: number;
+}
+/**
+ * Default window adjustment configuration based on backpressure.
+ */
+export declare const DEFAULT_WINDOW_ADJUSTMENT: WindowAdjustmentConfig;
+/**
+ * Get suggested window size based on backpressure state.
+ */
+export declare function getSuggestedWindow(state: BackpressureState, config?: WindowAdjustmentConfig): number;

package/dist/events/index.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Event system exports for async event dispatch.
+ * @packageDocumentation
+ */
+export * from './EventBackend';
+export type { EventOptions } from './EventOptions';
+export { DEFAULT_EVENT_OPTIONS } from './EventOptions';
+export type { BackpressureStrategy, EventQueueConfig, EventTask } from './types';
+export type { BackpressureConfig, BackpressureDecision, BackpressureMetricsSnapshot, } from './BackpressureManager';
+export { BackpressureManager, BackpressureState } from './BackpressureManager';
+export type { CircuitBreakerMetrics, CircuitBreakerMetricsRecorder, CircuitBreakerOptions, } from './CircuitBreaker';
+export { CircuitBreaker, CircuitBreakerState } from './CircuitBreaker';
+export type { DLQEntry, DLQEntryCallback, DLQEntrySource, DLQFilter } from './DeadLetterQueue';
+export { DeadLetterQueue } from './DeadLetterQueue';
+export { EventPriorityQueue } from './EventPriorityQueue';
+export * from './FlowControlStrategy';
+export { IdempotencyCache } from './IdempotencyCache';
+export { MessageQueueBridge } from './MessageQueueBridge';
+export type { PriorityStatistics } from './PriorityEscalationManager';
+export { PriorityEscalationManager } from './PriorityEscalationManager';
+export type { RetrySchedulerConfig } from './RetryScheduler';
+export { RetryScheduler } from './RetryScheduler';
+export type { DeadLetterDecision, MultiPriorityQueueDepth, WindowAdjustment } from './types';
+export { WorkerPool } from './WorkerPool';
+export type { WorkerPoolConfig, WorkerPoolStats, WorkerStats } from './WorkerPoolConfig';
+export { WorkerPoolMetrics } from './WorkerPoolMetrics';

package/dist/events/observability/EventMetrics.d.ts

@@ -0,0 +1,132 @@
+/**
+ * @gravito/core - Event System Metrics
+ *
+ * Manages metric collection for event dispatch and listener execution.
+ */
+import type { EventMetricGauge, EventMetricHistogram } from './metrics-types';
+/**
+ * Event metrics collector for monitoring and observability.
+ *
+ * Collects 6 core metrics:
+ * - Event dispatch latency (Histogram)
+ * - Listener execution time (Histogram)
+ * - Queue depth by priority (Gauge)
+ * - Failure count by error type (Counter)
+ * - Timeout count (Counter)
+ * - Processed event count by status (Counter)
+ *
+ * @public
+ */
+export declare class EventMetrics {
+    private dispatchLatency;
+    private listenerExecutionTime;
+    private queueDepthGauge;
+    private failureCounter;
+    private timeoutCounter;
+    private processedCounter;
+    private circuitBreakerStateGauge;
+    private circuitBreakerTransitionsCounter;
+    private circuitBreakerFailuresCounter;
+    private circuitBreakerSuccessesCounter;
+    private circuitBreakerOpenDurationHistogram;
+    /**
+     * Create a new EventMetrics instance.
+     *
+     * @param registry - MetricsRegistry from @gravito/monitor
+     * @param prefix - Metric name prefix (default: 'gravito_event_')
+     */
+    constructor(registry: any, // MetricsRegistry type
+    prefix?: string);
+    /**
+     * Record event dispatch latency.
+     *
+     * @param eventName - Name of the event
+     * @param priority - Priority level (high, normal, low)
+     * @param seconds - Duration in seconds
+     */
+    recordDispatchLatency(eventName: string, priority: string, seconds: number): void;
+    /**
+     * Record listener execution time.
+     *
+     * @param eventName - Name of the event
+     * @param index - Index of the listener in the callback list
+     * @param seconds - Duration in seconds
+     */
+    recordListenerExecution(eventName: string, index: number, seconds: number): void;
+    /**
+     * Update queue depth gauge for a specific priority.
+     *
+     * @param priority - Priority level (high, normal, low)
+     * @param depth - Current queue depth
+     */
+    updateQueueDepth(priority: string, depth: number): void;
+    /**
+     * Record event processing failure.
+     *
+     * @param eventName - Name of the event
+     * @param errorType - Type of error (e.g., 'TypeError', 'TimeoutError')
+     */
+    recordFailure(eventName: string, errorType: string): void;
+    /**
+     * Record event processing timeout.
+     *
+     * @param eventName - Name of the event
+     */
+    recordTimeout(eventName: string): void;
+    /**
+     * Record processed event (success or failure).
+     *
+     * @param eventName - Name of the event
+     * @param status - Processing status ('success' or 'failure')
+     */
+    recordProcessed(eventName: string, status: 'success' | 'failure'): void;
+    /**
+     * Get reference to dispatch latency histogram.
+     * @internal
+     */
+    getDispatchLatencyHistogram(): EventMetricHistogram;
+    /**
+     * Get reference to listener execution time histogram.
+     * @internal
+     */
+    getListenerExecutionHistogram(): EventMetricHistogram;
+    /**
+     * Get reference to queue depth gauge.
+     * @internal
+     */
+    getQueueDepthGauge(): EventMetricGauge;
+    /**
+     * Record circuit breaker state change.
+     *
+     * @param eventName - Name of the event
+     * @param state - Circuit breaker state (0=CLOSED, 1=HALF_OPEN, 2=OPEN)
+     */
+    recordCircuitBreakerState(eventName: string, state: number): void;
+    /**
+     * Record circuit breaker state transition.
+     *
+     * @param eventName - Name of the event
+     * @param fromState - Previous state
+     * @param toState - New state
+     */
+    recordCircuitBreakerTransition(eventName: string, fromState: string, toState: string): void;
+    /**
+     * Record circuit breaker failure.
+     *
+     * @param eventName - Name of the event
+     */
+    recordCircuitBreakerFailure(eventName: string): void;
+    /**
+     * Record circuit breaker success.
+     *
+     * @param eventName - Name of the event
+     */
+    recordCircuitBreakerSuccess(eventName: string): void;
+    /**
+     * Record circuit breaker OPEN duration.
+     *
+     * @param eventName - Name of the event
+     * @param seconds - Duration in seconds
+     */
+    recordCircuitBreakerOpenDuration(eventName: string, seconds: number): void;
+}

package/dist/events/observability/EventTracer.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @gravito/core - Event System Tracer
+ *
+ * Manages OpenTelemetry distributed tracing for event dispatch.
+ */
+import type { Span } from '@opentelemetry/api';
+/**
+ * Event tracer for distributed tracing support.
+ *
+ * Integrates with OpenTelemetry to provide:
+ * - Event dispatch tracing
+ * - Listener execution tracing
+ * - Error recording
+ * - Span hierarchy
+ *
+ * @public
+ */
+export declare class EventTracer {
+    private tracer;
+    /**
+     * Create a new EventTracer instance.
+     *
+     * @param tracerName - Name of the tracer (default: '@gravito/core')
+     */
+    constructor(tracerName?: string);
+    /**
+     * Start a span for event dispatch.
+     *
+     * @param eventName - Name of the event
+     * @param callbackCount - Number of callbacks registered for this event
+     * @param priority - Priority level (high, normal, low)
+     * @returns Span for the event dispatch
+     */
+    startDispatchSpan(eventName: string, callbackCount: number, priority: string): Span;
+    /**
+     * Start a span for listener execution.
+     *
+     * @param _parentSpan - Parent span for this listener
+     * @param eventName - Name of the event
+     * @param listenerIndex - Index of the listener in the callback list
+     * @returns Child span for the listener execution
+     */
+    startListenerSpan(_parentSpan: Span, eventName: string, listenerIndex: number): Span;
+    /**
+     * Record an error in the span.
+     *
+     * @param span - Span to record error in
+     * @param error - Error that occurred
+     */
+    recordError(span: Span, error: Error): void;
+    /**
+     * End a span with a specific status.
+     *
+     * @param span - Span to end
+     * @param status - Status ('ok' or 'error')
+     */
+    endSpan(span: Span, status?: 'ok' | 'error'): void;
+    /**
+     * Create a timer span for measuring duration.
+     *
+     * @param eventName - Name of the event
+     * @returns Object with span and duration recording function
+     */
+    startTimer(eventName: string): {
+        span: Span;
+        endTimer: (status?: 'ok' | 'error') => void;
+    };
+}

package/dist/events/observability/EventTracing.d.ts

@@ -0,0 +1,161 @@
+/**
+ * @gravito/core - Event System Tracing
+ *
+ * 使用 OpenTelemetry API 實現事件系統的分佈式追蹤。
+ * 提供事件派發、監聽器執行與隊列操作的端到端追蹤。
+ */
+import type { Span } from '@opentelemetry/api';
+/**
+ * 事件追蹤配置
+ */
+export interface EventTracingConfig {
+    /** Tracer 名稱 */
+    tracerName?: string;
+    /** 是否記錄詳細的 payload 信息 */
+    capturePayload?: boolean;
+    /** 最大 payload 大小（字節） */
+    maxPayloadSize?: number;
+}
+/**
+ * 事件追蹤管理器
+ *
+ * 提供事件系統的分佈式追蹤能力，包括：
+ * - 事件派發追蹤
+ * - 監聽器執行追蹤
+ * - 隊列操作追蹤
+ * - 異常記錄與追蹤
+ *
+ * @public
+ */
+export declare class EventTracing {
+    private tracer;
+    private config;
+    constructor(config?: EventTracingConfig);
+    /**
+     * 為事件派發創建追蹤 Span
+     *
+     * @param eventName - 事件名稱
+     * @param listenerCount - 監聽器數量
+     * @param priority - 優先級（high, normal, low）
+     * @param payload - 事件負載（可選，用於調試）
+     * @returns Span 實例
+     *
+     * @example
+     * ```typescript
+     * const tracer = new EventTracing()
+     * const span = tracer.startDispatchSpan('order:created', 3, 'high', orderData)
+     * try {
+     *   // 派發事件
+     *   await dispatchEvent()
+     *   tracer.endDispatchSpan(span, 'ok')
+     * } catch (error) {
+     *   tracer.endDispatchSpan(span, 'error', error)
+     * }
+     * ```
+     */
+    startDispatchSpan(eventName: string, listenerCount: number, priority?: 'high' | 'normal' | 'low', payload?: unknown): Span;
+    /**
+     * 為監聽器執行創建追蹤 Span
+     *
+     * @param _parentSpan - 父 Span
+     * @param eventName - 事件名稱
+     * @param listenerName - 監聽器名稱/標識
+     * @param listenerIndex - 監聽器索引
+     * @returns 子 Span 實例
+     */
+    startListenerSpan(_parentSpan: Span, eventName: string, listenerName: string, listenerIndex: number): Span;
+    /**
+     * 為隊列操作創建追蹤 Span
+     *
+     * @param _parentSpan - 父 Span
+     * @param operationType - 操作類型（enqueue, dequeue, requeue）
+     * @param eventName - 事件名稱
+     * @param priority - 優先級
+     * @returns Span 實例
+     */
+    startQueueOperationSpan(_parentSpan: Span, operationType: 'enqueue' | 'dequeue' | 'requeue', eventName: string, priority: 'high' | 'normal' | 'low'): Span;
+    /**
+     * 結束事件派發 Span
+     *
+     * @param span - Span 實例
+     * @param status - 完成狀態（ok, error）
+     * @param error - 如果 status 為 error，傳遞錯誤對象
+     */
+    endDispatchSpan(span: Span, status?: 'ok' | 'error', error?: Error): void;
+    /**
+     * 結束監聽器執行 Span
+     *
+     * @param span - Span 實例
+     * @param status - 完成狀態（ok, error）
+     * @param duration - 執行時間（毫秒）
+     * @param error - 如果發生錯誤，傳遞錯誤對象
+     */
+    endListenerSpan(span: Span, status?: 'ok' | 'error', duration?: number, error?: Error): void;
+    /**
+     * 結束隊列操作 Span
+     *
+     * @param span - Span 實例
+     * @param status - 完成狀態（ok, error）
+     * @param queueDepth - 當前隊列深度
+     * @param error - 如果發生錯誤，傳遞錯誤對象
+     */
+    endQueueOperationSpan(span: Span, status?: 'ok' | 'error', queueDepth?: number, error?: Error): void;
+    /**
+     * 在 Span 中添加自定義屬性
+     *
+     * @param span - Span 實例
+     * @param attributes - 屬性對象
+     */
+    addSpanAttributes(span: Span, attributes: Record<string, string | number | boolean>): void;
+    /**
+     * 在 Span 中添加自定義事件
+     *
+     * @param span - Span 實例
+     * @param eventName - 事件名稱
+     * @param attributes - 事件屬性（可選）
+     */
+    addSpanEvent(span: Span, eventName: string, attributes?: Record<string, string | number | boolean>): void;
+    /**
+     * 記錄異常到 Span
+     *
+     * @param span - Span 實例
+     * @param error - 錯誤對象
+     */
+    recordException(span: Span, error: Error | string): void;
+    /**
+     * 創建定時器 Span（用於測量操作時間）
+     *
+     * @param operationName - 操作名稱
+     * @returns 對象包含 span 和結束函數
+     *
+     * @example
+     * ```typescript
+     * const { span, endTimer } = tracer.startTimer('slow-operation')
+     * try {
+     *   await slowOperation()
+     *   endTimer('ok')
+     * } catch (error) {
+     *   endTimer('error', error)
+     * }
+     * ```
+     */
+    startTimer(operationName: string): {
+        span: Span;
+        endTimer: (status?: 'ok' | 'error', error?: Error) => void;
+    };
+    /**
+     * 獲取 tracer 實例（用於高級用法）
+     *
+     * @returns OpenTelemetry Tracer 實例
+     */
+    getTracer(): import("@opentelemetry/api").Tracer;
+}
+/**
+ * 獲取或創建全局 EventTracing 實例
+ *
+ * @param config - 配置選項
+ * @returns EventTracing 實例
+ *
+ * @public
+ */
+export declare function getEventTracing(config?: EventTracingConfig): EventTracing;