@gravito/core 1.6.1 → 2.0.0

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;

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

@@ -0,0 +1,332 @@
+/**
+ * @gravito/core - OpenTelemetry Event Metrics
+ *
+ * Provides event system metrics using OpenTelemetry API directly.
+ * This enables Prometheus export without requiring @gravito/monitor dependency.
+ *
+ * Metrics:
+ * - gravito_event_dispatch_duration_seconds (Histogram)
+ * - gravito_event_listener_duration_seconds (Histogram)
+ * - gravito_event_queue_depth (Observable Gauge)
+ *
+ * @packageDocumentation
+ */
+import type { Meter } from '@opentelemetry/api';
+import type { CircuitBreakerMetricsRecorder } from '../CircuitBreaker';
+/**
+ * Queue depth callback type.
+ * Returns the current queue depths for each priority level.
+ */
+export type QueueDepthCallback = () => {
+    critical: number;
+    high: number;
+    normal: number;
+    low: number;
+};
+/**
+ * Circuit breaker state callback type.
+ * Returns the current state of a circuit breaker.
+ */
+export type CircuitBreakerStateCallback = () => {
+    eventName: string;
+    listenerIndex: number;
+    state: 0 | 1 | 2;
+};
+/**
+ * OpenTelemetry-based Event Metrics collector.
+ *
+ * Uses OpenTelemetry API directly for metrics collection, enabling
+ * Prometheus export through the OpenTelemetry SDK.
+ *
+ * @example
+ * ```typescript
+ * import { metrics } from '@opentelemetry/api'
+ * import { OTelEventMetrics } from '@gravito/core'
+ *
+ * const meter = metrics.getMeter('@gravito/core', '1.0.0')
+ * const eventMetrics = new OTelEventMetrics(meter)
+ *
+ * // Record dispatch duration
+ * eventMetrics.recordDispatchDuration('order:created', 'high', 0.123)
+ *
+ * // Record listener duration
+ * eventMetrics.recordListenerDuration('order:created', 0, 0.456)
+ *
+ * // Set queue depth callback
+ * eventMetrics.setQueueDepthCallback(() => ({
+ *   high: 10,
+ *   normal: 50,
+ *   low: 100
+ * }))
+ * ```
+ *
+ * @public
+ */
+export declare class OTelEventMetrics implements CircuitBreakerMetricsRecorder {
+    private readonly meter;
+    private readonly prefix;
+    private readonly dispatchDurationHistogram;
+    private readonly listenerDurationHistogram;
+    private readonly queueDepthGauge;
+    private readonly cbStateGauge;
+    private readonly cbFailuresCounter;
+    private readonly cbSuccessesCounter;
+    private readonly cbTransitionsCounter;
+    private readonly cbOpenDurationHistogram;
+    private readonly backpressureRejectionsCounter;
+    private readonly backpressureStateGauge;
+    private readonly backpressureDegradationsCounter;
+    private backpressureStateValue;
+    private readonly dlqEntriesCounter;
+    private readonly dlqDepthGauge;
+    private readonly dlqRequeueCounter;
+    private readonly retryAttemptsCounter;
+    private dlqDepthCallback?;
+    private readonly priorityEscalationCounter;
+    private queueDepthCallback?;
+    private circuitBreakerStateCallbacks;
+    private recordedCircuitBreakerStates;
+    /**
+     * Bucket boundaries for dispatch duration histogram.
+     */
+    private readonly dispatchDurationBuckets;
+    /**
+     * Bucket boundaries for listener duration histogram.
+     */
+    private readonly listenerDurationBuckets;
+    /**
+     * Bucket boundaries for circuit breaker open duration histogram.
+     */
+    private readonly cbOpenDurationBuckets;
+    /**
+     * Create a new OTelEventMetrics instance.
+     *
+     * @param meter - OpenTelemetry Meter instance
+     * @param prefix - Metric name prefix (default: 'gravito_event_')
+     */
+    constructor(meter: Meter, prefix?: string);
+    /**
+     * Record event dispatch duration.
+     *
+     * @param eventName - Name of the event
+     * @param priority - Priority level (high, normal, low)
+     * @param durationSeconds - Duration in seconds
+     */
+    recordDispatchDuration(eventName: string, priority: string, durationSeconds: number): void;
+    /**
+     * Record listener execution duration.
+     *
+     * @param eventName - Name of the event
+     * @param listenerIndex - Index of the listener in the callback list
+     * @param durationSeconds - Duration in seconds
+     */
+    recordListenerDuration(eventName: string, listenerIndex: number, durationSeconds: number): void;
+    /**
+     * Set the callback for queue depth observable gauge.
+     *
+     * The callback will be invoked when metrics are collected,
+     * allowing real-time reporting of queue depths.
+     *
+     * @param callback - Function returning current queue depths
+     */
+    setQueueDepthCallback(callback: QueueDepthCallback): void;
+    /**
+     * Register a circuit breaker state callback for monitoring.
+     *
+     * @param key - Unique identifier for the circuit breaker (e.g., "order:created-0")
+     * @param callback - Function returning current circuit breaker state
+     */
+    registerCircuitBreakerStateCallback(key: string, callback: CircuitBreakerStateCallback): void;
+    /**
+     * Unregister a circuit breaker state callback.
+     *
+     * @param key - Unique identifier for the circuit breaker
+     */
+    unregisterCircuitBreakerStateCallback(key: string): void;
+    /**
+     * Record circuit breaker state change.
+     *
+     * @param name - Name of the circuit breaker (usually event name)
+     * @param state - State as number (0=CLOSED, 1=HALF_OPEN, 2=OPEN)
+     */
+    recordState(name: string, state: number): void;
+    /**
+     * Record circuit breaker state transition.
+     *
+     * @param name - Name of the circuit breaker
+     * @param fromState - Previous state
+     * @param toState - New state
+     */
+    recordTransition(name: string, fromState: string, toState: string): void;
+    /**
+     * Record circuit breaker failure.
+     *
+     * @param name - Name of the circuit breaker
+     */
+    recordFailure(name: string): void;
+    /**
+     * Record circuit breaker success.
+     *
+     * @param name - Name of the circuit breaker
+     */
+    recordSuccess(name: string): void;
+    /**
+     * Record circuit breaker open duration.
+     *
+     * @param name - Name of the circuit breaker
+     * @param seconds - Duration in seconds
+     */
+    recordOpenDuration(name: string, seconds: number): void;
+    /**
+     * Record circuit breaker failure.
+     *
+     * @param eventName - Name of the event
+     * @param listenerIndex - Index of the listener
+     */
+    recordCircuitBreakerFailure(eventName: string, listenerIndex: number): void;
+    /**
+     * Record circuit breaker success.
+     *
+     * @param eventName - Name of the event
+     * @param listenerIndex - Index of the listener
+     */
+    recordCircuitBreakerSuccess(eventName: string, listenerIndex: number): void;
+    /**
+     * Record circuit breaker state transition.
+     *
+     * @param eventName - Name of the event
+     * @param listenerIndex - Index of the listener
+     * @param fromState - Previous state (CLOSED, HALF_OPEN, OPEN)
+     * @param toState - New state (CLOSED, HALF_OPEN, OPEN)
+     */
+    recordCircuitBreakerTransition(eventName: string, listenerIndex: number, fromState: string, toState: string): void;
+    /**
+     * Record circuit breaker open duration.
+     *
+     * @param eventName - Name of the event
+     * @param listenerIndex - Index of the listener
+     * @param durationSeconds - Duration in seconds
+     */
+    recordCircuitBreakerOpenDuration(eventName: string, listenerIndex: number, durationSeconds: number): void;
+    /**
+     * Get the bucket boundaries for dispatch duration histogram.
+     *
+     * @returns Array of bucket boundaries in seconds
+     */
+    getDispatchDurationBuckets(): number[];
+    /**
+     * Get the bucket boundaries for listener duration histogram.
+     *
+     * @returns Array of bucket boundaries in seconds
+     */
+    getListenerDurationBuckets(): number[];
+    /**
+     * Get the OpenTelemetry Meter instance.
+     *
+     * @returns Meter instance
+     */
+    getMeter(): Meter;
+    /**
+     * Get the metric name prefix.
+     *
+     * @returns Metric name prefix
+     */
+    getPrefix(): string;
+    /**
+     * Get the bucket boundaries for circuit breaker open duration histogram.
+     *
+     * @returns Array of bucket boundaries in seconds
+     */
+    getCircuitBreakerOpenDurationBuckets(): number[];
+    /**
+     * Get all registered circuit breaker state callback keys.
+     *
+     * @returns Array of registered keys
+     */
+    getRegisteredCircuitBreakers(): string[];
+    /**
+     * Clear all circuit breaker state callbacks.
+     */
+    clearCircuitBreakerCallbacks(): void;
+    /**
+     * Record a backpressure rejection event.
+     *
+     * @param eventName - Event name
+     * @param priority - Event priority
+     * @param reason - Rejection reason
+     */
+    recordBackpressureRejection(eventName: string, priority: string, reason: string): void;
+    /**
+     * Record a backpressure state change event.
+     *
+     * @param state - New backpressure state (NORMAL, WARNING, CRITICAL, OVERFLOW)
+     */
+    recordBackpressureState(state: string): void;
+    /**
+     * Record a backpressure degradation event.
+     *
+     * @param eventName - Event name
+     * @param fromPriority - Original priority
+     * @param toPriority - Degraded priority
+     */
+    recordBackpressureDegradation(eventName: string, fromPriority: string, toPriority: string): void;
+    /**
+     * Record an event added to Dead Letter Queue.
+     *
+     * @param eventName - Event name
+     * @param source - Source of DLQ entry (retry_exhausted, circuit_breaker, backpressure_overflow)
+     */
+    recordDLQEntry(eventName: string, source: string): void;
+    /**
+     * Set the callback for DLQ depth observable gauge.
+     *
+     * @param callback - Function returning current DLQ depth
+     */
+    setDLQDepthCallback(callback: () => number): void;
+    /**
+     * Record a DLQ requeue attempt.
+     *
+     * @param eventName - Event name
+     * @param result - Result of requeue (success or failure)
+     */
+    recordDLQRequeue(eventName: string, result: 'success' | 'failure'): void;
+    /**
+     * Record an event retry attempt.
+     *
+     * @param eventName - Event name
+     * @param attemptNumber - Attempt number
+     */
+    recordRetryAttempt(eventName: string, attemptNumber: number): void;
+    /**
+     * Record a priority escalation event.
+     *
+     * @param eventName - Event name
+     * @param fromPriority - Original priority
+     * @param toPriority - Escalated priority
+     */
+    recordPriorityEscalation(eventName: string, fromPriority: string, toPriority: string): void;
+    /**
+     * Record event deduplication (FS-102).
+     *
+     * @param eventName - Event name
+     * @param deduplicatedCount - Number of events after deduplication
+     * @param totalCount - Total number of events before deduplication
+     */
+    recordDeduplication(eventName: string, deduplicatedCount: number, totalCount: number): void;
+    /**
+     * Record batch submission (FS-102).
+     *
+     * @param eventName - Event name
+     * @param batchSize - Size of submitted batch
+     * @param windowMs - Aggregation window size
+     */
+    recordBatch(eventName: string, batchSize: number, windowMs: number): void;
+    /**
+     * Record window adjustment (FS-102).
+     *
+     * @param oldWindowMs - Previous window size
+     * @param newWindowMs - New window size
+     * @param reason - Adjustment reason
+     */
+    recordWindowAdjustment(oldWindowMs: number, newWindowMs: number, reason: string): void;
+}

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

@@ -0,0 +1,108 @@
+/**
+ * @gravito/core - Observable Hook Manager
+ *
+ * Wraps HookManager with observability support (metrics and tracing).
+ */
+import { HookManager, type HookManagerConfig } from '../../HookManager';
+import type { EventOptions } from '../EventOptions';
+import { EventMetrics } from './EventMetrics';
+import { EventTracer } from './EventTracer';
+import { EventTracing } from './EventTracing';
+/**
+ * Configuration for observability features.
+ * @public
+ */
+export interface ObservabilityConfig {
+    /**
+     * Enable observability features.
+     * @default false
+     */
+    enabled?: boolean;
+    /**
+     * MetricsRegistry instance from @gravito/monitor.
+     * Required if metrics collection is enabled.
+     */
+    metrics?: any;
+    /**
+     * Enable OpenTelemetry distributed tracing.
+     * @default false
+     */
+    tracing?: boolean;
+    /**
+     * Prefix for metric names.
+     * @default 'gravito_event_'
+     */
+    metricsPrefix?: string;
+}
+/**
+ * Observable Hook Manager - extends HookManager with observability.
+ *
+ * Provides metrics and distributed tracing for event dispatch and listener execution.
+ * Maintains 100% backward compatibility with HookManager.
+ *
+ * @public
+ */
+export declare class ObservableHookManager extends HookManager {
+    private eventMetrics?;
+    private eventTracer?;
+    private eventTracing?;
+    private obsConfig;
+    /**
+     * Create a new ObservableHookManager instance.
+     *
+     * @param config - HookManager configuration
+     * @param obsConfig - Observability configuration
+     */
+    constructor(config?: HookManagerConfig, obsConfig?: ObservabilityConfig);
+    /**
+     * Run all registered actions asynchronously via priority queue with observability.
+     *
+     * This override adds metrics and tracing to the base implementation.
+     *
+     * @template TArgs - The type of arguments passed to the action.
+     * @param hook - The name of the hook.
+     * @param args - The arguments to pass to the callbacks.
+     * @param options - Event options for async dispatch.
+     */
+    doActionAsync<TArgs = unknown>(hook: string, args: TArgs, options?: EventOptions): Promise<void>;
+    /**
+     * Run all registered actions synchronously with observability.
+     *
+     * This override adds metrics and tracing to the base implementation.
+     *
+     * @template TArgs - The type of arguments passed to the action.
+     * @param hook - The name of the hook.
+     * @param args - The arguments to pass to the callbacks.
+     */
+    doActionSync<TArgs = unknown>(hook: string, args: TArgs): Promise<void>;
+    /**
+     * Get the EventMetrics instance.
+     *
+     * @returns EventMetrics instance if observability is enabled, undefined otherwise
+     */
+    getMetrics(): EventMetrics | undefined;
+    /**
+     * Get the EventTracer instance.
+     *
+     * @returns EventTracer instance if tracing is enabled, undefined otherwise
+     */
+    getTracer(): EventTracer | undefined;
+    /**
+     * Update observability configuration at runtime.
+     *
+     * @param config - New observability configuration
+     */
+    setObservabilityConfig(config: Partial<ObservabilityConfig>): void;
+    /**
+     * Get the EventTracing instance.
+     *
+     * @returns EventTracing instance if tracing is enabled, undefined otherwise
+     */
+    getEventTracing(): EventTracing | undefined;
+    /**
+     * Get current observability configuration.
+     *
+     * @returns Current observability configuration
+     */
+    getObservabilityConfig(): ObservabilityConfig;
+}