配置

🌐 Configuration

ObservabilityRegistryConfig

interface ObservabilityRegistryConfig {
  default?: { enabled?: boolean };
  configs?: Record<string, Omit<ObservabilityInstanceConfig, "name"> | ObservabilityInstance>;
  configSelector?: ConfigSelector;
}

ObservabilityInstanceConfig

interface ObservabilityInstanceConfig {
  name: string;
  serviceName: string;
  sampling?: SamplingStrategy;
  exporters?: ObservabilityExporter[];
  spanOutputProcessors?: SpanOutputProcessor[];
  includeInternalSpans?: boolean;
  requestContextKeys?: string[];
  serializationOptions?: SerializationOptions;
}

SerializationOptions

控制跨度数据在导出前如何序列化的选项。使用这些选项可以自定义大数据量的截断限制。

🌐 Options for controlling how span data is serialized before export. Use these to customize truncation limits for large payloads.

interface SerializationOptions {
  maxStringLength?: number;
  maxDepth?: number;
  maxArrayLength?: number;
  maxObjectKeys?: number;
}

SamplingStrategy

type SamplingStrategy =
  | { type: "always" }
  | { type: "never" }
  | { type: "ratio"; probability: number }
  | { type: "custom"; sampler: (options?: TracingOptions) => boolean };

ConfigSelector

type ConfigSelector = (
  options: ConfigSelectorOptions,
  availableConfigs: ReadonlyMap<string, ObservabilityInstance>,
) => string | undefined;

ConfigSelectorOptions

interface ConfigSelectorOptions {
  requestContext?: RequestContext;
}

注册表方法

🌐 Registry Methods

Observability 类提供了用于管理可观测性实例的方法：

🌐 The Observability class provides methods for managing observability instances:

registerInstance

registerInstance(
  name: string,
  instance: ObservabilityInstance,
  isDefault?: boolean
): void;

在注册表中注册一个可观测性实例。

🌐 Registers an observability instance in the registry.

getInstance

getInstance(name: string): ObservabilityInstance | undefined;

通过名称检索一个可观测性实例。

🌐 Retrieves an observability instance by name.

getDefaultInstance

getDefaultInstance(): ObservabilityInstance | undefined;

返回默认的可观测性实例。

🌐 Returns the default observability instance.

getSelectedInstance

getSelectedInstance(
  options: ConfigSelectorOptions
): ObservabilityInstance | undefined;

返回配置选择器选择的可观测性实例或默认实例。

🌐 Returns the observability instance selected by the config selector or default.

listInstances

listInstances(): ReadonlyMap<string, ObservabilityInstance>;

返回所有已注册的可观察性实例。

🌐 Returns all registered observability instances.

hasInstance

hasInstance(name: string): boolean;

检查观测实例是否存在。

🌐 Checks if an observability instance exists.

setConfigSelector

setConfigSelector(selector: ConfigSelector): void;

设置配置选择器函数。

🌐 Sets the config selector function.

unregisterInstance

unregisterInstance(name: string): boolean;

从注册表中移除一个可观察性实例。

🌐 Removes an observability instance from the registry.

clear

clear(): void;

清除所有实例而不关闭。

🌐 Clears all instances without shutdown.

shutdown

async shutdown(): Promise<void>;

关闭所有可观测性实例并清除注册表。

🌐 Shuts down all observability instances and clears the registry.

另请参阅

🌐 See Also

文档

🌐 Documentation

• 追踪概览 - 概念和使用指南
• 采样策略 - 采样配置详情
• 多配置设置 - 使用多种配置

参考

🌐 Reference

• 跟踪类 - 核心跟踪类
• 接口 - 类型定义
• 跨度参考 - 跨度生命周期

导出器

🌐 Exporters

• 默认导出器 - 存储配置
• CloudExporter - 云端设置
• Braintrust - Braintrust 集成
• Langfuse - Langfuse 集成
• LangSmith - LangSmith 集成