可观测性实例

🌐 Observability Instances

DefaultObservabilityInstance

ObservabilityInstance 接口的默认实现。

🌐 Default implementation of the ObservabilityInstance interface.

构造函数

🌐 Constructor

new DefaultObservabilityInstance(config: ObservabilityInstanceConfig)

使用指定的配置创建一个新的默认可观察性实例。

🌐 Creates a new DefaultObservabilityInstance with the specified configuration.

属性

🌐 Properties

继承自 BaseObservabilityInstance 的所有属性和方法。

🌐 Inherits all properties and methods from BaseObservabilityInstance.

BaseObservabilityInstance

自定义 ObservabilityInstance 实现的基类。

🌐 Base class for custom ObservabilityInstance implementations.

方法

🌐 Methods

getConfig

getConfig(): Readonly<Required<ObservabilityInstanceConfig>>

返回当前的可观测性配置。

🌐 Returns the current observability configuration.

getExporters

getExporters(): readonly ObservabilityExporter[]

返回所有已配置的导出器。

🌐 Returns all configured exporters.

getSpanOutputProcessors

getSpanOutputProcessors(): readonly SpanOutputProcessor[]

返回所有已配置的跨度输出处理器。

🌐 Returns all configured span output processors.

getLogger

getLogger(): IMastraLogger

返回用于导出器和其他组件的日志记录器实例。

🌐 Returns the logger instance for exporters and other components.

startSpan

startSpan<TType extends SpanType>(
  options: StartSpanOptions<TType>
): Span<TType>

启动一个特定 SpanType 的新跨度。如果未提供父跨度，则创建追踪的根跨度。

🌐 Start a new span of a specific SpanType. Creates the root span of a trace if no parent is provided.

shutdown

async shutdown(): Promise<void>

关闭所有导出器和处理器，清理资源。

🌐 Shuts down all exporters and processors, cleaning up resources.

自定义实现

🌐 Custom Implementation

要创建自定义的 ObservabilityInstance 实现，请扩展 BaseObservabilityInstance：

🌐 To create a custom ObservabilityInstance implementation, extend BaseObservabilityInstance:

class CustomObservabilityInstance extends BaseObservabilityInstance {
  constructor(config: ObservabilityInstanceConfig) {
    super(config);
    // Custom initialization
  }

  // Override methods as needed
  startSpan<TType extends SpanType>(
    options: StartSpanOptions<TType>,
  ): Span<TType> {
    // Custom span creation logic
    return super.startSpan(options);
  }
}

另请参阅

🌐 See Also

文档

🌐 Documentation

• 追踪概览 - 概念和使用指南
• 配置参考 - 配置选项
• 接口参考 - 类型定义
• 跨度参考 - 跨度生命周期和方法

导出器

🌐 Exporters

• DefaultExporter - 存储持久化
• CloudExporter - Mastra 云集成
• ConsoleExporter - 调试输出