HYPHA / DOCS

简体中文

English

简体中文

English

@codesoul-co/hypha-memory / provider-operational-health ​

模块用法 ​

用于把外部或本地 Provider 绑定到 Hypha Port。Provider operational health 模块公开 1 类、4 接口、2 类型。

从包入口导入 ​

ts
import {
  MemoryOperationalHealthService,
} from '@codesoul-co/hypha-memory';

import type {
  MemoryOperationalHealth,
  ProviderOperationalProbe,
  ProviderOperationalSnapshot,
  ProviderRuntimeMetrics,
  LivenessStatus,
  OperationalStatus,
} from '@codesoul-co/hypha-memory';

使用要点 ​

  • 6 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
  • 1 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。

公共导出 ​

Symbol种类签名说明
MemoryOperationalHealthService类new MemoryOperationalHealthService(probes: ProviderOperationalProbe[], now?: () => string): MemoryOperationalHealthServiceMemory Operational Health Service 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。
MemoryOperationalHealth接口interface MemoryOperationalHealthMemory Operational Health 接口，共包含 4 个公开字段或方法。
ProviderOperationalProbe接口interface ProviderOperationalProbeProvider Operational Probe 接口，共包含 4 个公开字段或方法。
ProviderOperationalSnapshot接口interface ProviderOperationalSnapshotProvider Operational Snapshot 接口，共包含 4 个公开字段或方法。
ProviderRuntimeMetrics接口interface ProviderRuntimeMetricsProvider Runtime Metrics 接口，共包含 11 个公开字段或方法。
LivenessStatus类型type LivenessStatus = 'alive' | 'stalled'Liveness Status 公共类型别名；完整类型表达式见声明。
OperationalStatus类型type OperationalStatus = 'ready' | 'degraded' | 'not_ready'Operational Status 公共类型别名；完整类型表达式见声明。

MemoryOperationalHealthService ​

Memory Operational Health Service 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。

  • 种类: 类
  • 导入: import { MemoryOperationalHealthService } from '@codesoul-co/hypha-memory';
  • 源码模块: provider-operational-health

声明 ​

text
export declare class MemoryOperationalHealthService {
    constructor(probes: ProviderOperationalProbe[], now?: () => string);
    snapshot(signal?: AbortSignal): Promise<MemoryOperationalHealth>;
}

公开成员 ​

成员种类签名说明
constructor构造函数(probes: ProviderOperationalProbe[], now?: () => string): MemoryOperationalHealthService创建该类的实例。
snapshot方法snapshot(signal?: AbortSignal): Promise<MemoryOperationalHealth>公开方法；参数与返回类型以签名列为准。

MemoryOperationalHealth ​

Memory Operational Health 接口，共包含 4 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { MemoryOperationalHealth } from '@codesoul-co/hypha-memory';
  • 源码模块: provider-operational-health

声明 ​

text
export interface MemoryOperationalHealth {
    readiness: {
        status: OperationalStatus;
        reasons: string[];
    };
    liveness: {
        status: LivenessStatus;
        reasons: string[];
    };
    providers: ProviderOperationalSnapshot[];
    checkedAt: string;
}

契约成员 ​

成员种类签名说明
checkedAt属性checkedAt: string公开属性；类型、只读和可选状态以签名列为准。
liveness属性liveness: { status: LivenessStatus; reasons: string[]; }公开属性；类型、只读和可选状态以签名列为准。
providers属性providers: ProviderOperationalSnapshot[]公开属性；类型、只读和可选状态以签名列为准。
readiness属性readiness: { status: OperationalStatus; reasons: string[]; }公开属性；类型、只读和可选状态以签名列为准。

ProviderOperationalProbe ​

Provider Operational Probe 接口，共包含 4 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { ProviderOperationalProbe } from '@codesoul-co/hypha-memory';
  • 源码模块: provider-operational-health

声明 ​

text
export interface ProviderOperationalProbe {
    readonly providerId: string;
    readonly required: boolean;
    health(signal?: AbortSignal): Promise<ProviderHealth>;
    metrics(): Promise<ProviderRuntimeMetrics>;
}

契约成员 ​

成员种类签名说明
health方法health(signal?: AbortSignal): Promise<ProviderHealth>公开方法；参数与返回类型以签名列为准。
metrics方法metrics(): Promise<ProviderRuntimeMetrics>公开方法；参数与返回类型以签名列为准。
providerId属性readonly providerId: string公开属性；类型、只读和可选状态以签名列为准。
required属性readonly required: boolean公开属性；类型、只读和可选状态以签名列为准。

ProviderOperationalSnapshot ​

Provider Operational Snapshot 接口，共包含 4 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { ProviderOperationalSnapshot } from '@codesoul-co/hypha-memory';
  • 源码模块: provider-operational-health

声明 ​

text
export interface ProviderOperationalSnapshot {
    providerId: string;
    health: ProviderHealth;
    metrics: ProviderRuntimeMetrics;
    required: boolean;
}

契约成员 ​

成员种类签名说明
health属性health: ProviderHealth公开属性；类型、只读和可选状态以签名列为准。
metrics属性metrics: ProviderRuntimeMetrics公开属性；类型、只读和可选状态以签名列为准。
providerId属性providerId: string公开属性；类型、只读和可选状态以签名列为准。
required属性required: boolean公开属性；类型、只读和可选状态以签名列为准。

ProviderRuntimeMetrics ​

Provider Runtime Metrics 接口，共包含 11 个公开字段或方法。

  • 种类: 接口
  • 导入: import type { ProviderRuntimeMetrics } from '@codesoul-co/hypha-memory';
  • 源码模块: provider-operational-health

声明 ​

text
export interface ProviderRuntimeMetrics {
    poolActive?: number;
    poolIdle?: number;
    poolLimit?: number;
    queueDepth?: number;
    queueOldestAgeMs?: number;
    retryAttempts?: number;
    retryBudgetRemaining?: number;
    circuitState?: 'closed' | 'open' | 'half_open';
    rateLimitRemaining?: number;
    quarantinedOperations?: number;
    deadLetterCount?: number;
}

契约成员 ​

成员种类签名说明
circuitState属性circuitState?: "closed" | "open" | "half_open"公开属性；类型、只读和可选状态以签名列为准。
deadLetterCount属性deadLetterCount?: number公开属性；类型、只读和可选状态以签名列为准。
poolActive属性poolActive?: number公开属性；类型、只读和可选状态以签名列为准。
poolIdle属性poolIdle?: number公开属性；类型、只读和可选状态以签名列为准。
poolLimit属性poolLimit?: number公开属性；类型、只读和可选状态以签名列为准。
quarantinedOperations属性quarantinedOperations?: number公开属性；类型、只读和可选状态以签名列为准。
queueDepth属性queueDepth?: number公开属性；类型、只读和可选状态以签名列为准。
queueOldestAgeMs属性queueOldestAgeMs?: number公开属性；类型、只读和可选状态以签名列为准。
rateLimitRemaining属性rateLimitRemaining?: number公开属性；类型、只读和可选状态以签名列为准。
retryAttempts属性retryAttempts?: number公开属性；类型、只读和可选状态以签名列为准。
retryBudgetRemaining属性retryBudgetRemaining?: number公开属性；类型、只读和可选状态以签名列为准。

LivenessStatus ​

Liveness Status 公共类型别名；完整类型表达式见声明。

声明 ​

text
export type LivenessStatus = 'alive' | 'stalled';

OperationalStatus ​

Operational Status 公共类型别名；完整类型表达式见声明。

声明 ​

text
export type OperationalStatus = 'ready' | 'degraded' | 'not_ready';