Configuration
ObservabilityRegistryConfig
interface ObservabilityRegistryConfig {
default?: { enabled?: boolean };
configs?: Record<string, TracingConfig | AITracing>;
configSelector?: ConfigSelector;
}
TracingConfig
interface TracingConfig {
name: string;
serviceName: string;
sampling?: SamplingStrategy;
exporters?: AITracingExporter[];
processors?: AISpanProcessor[];
}
SamplingStrategy
type SamplingStrategy =
| { type: 'always' }
| { type: 'never' }
| { type: 'ratio', probability: number }
| { type: 'custom', sampler: (options?: TracingOptions) => boolean };
ConfigSelector
type ConfigSelector = (
options: ConfigSelectorOptions,
availableConfigs: Map<string, AITracing>
) => string | undefined;
ConfigSelectorOptions
interface ConfigSelectorOptions {
metadata?: Record<string, any>;
runtimeContext?: Map<string, any>;
}
Registry Functions
setupAITracing
function setupAITracing(config: ObservabilityRegistryConfig): void
Initializes AI tracing from configuration. Called automatically by Mastra constructor.
registerAITracing
function registerAITracing(
name: string,
instance: AITracing,
isDefault?: boolean
): void
Registers a tracing config in the global registry.
getAITracing
function getAITracing(name: string): AITracing | undefined
Retrieves a tracing config by name.
getDefaultAITracing
function getDefaultAITracing(): AITracing | undefined
Returns the default tracing config.
getSelectedAITracing
function getSelectedAITracing(
options: ConfigSelectorOptions
): AITracing | undefined
Returns the tracing config selected by the config selector or default.
setSelector
function setSelector(selector: ConfigSelector): void
Sets the global config selector function.
unregisterAITracing
function unregisterAITracing(name: string): boolean
Removes a tracing config from the registry.
shutdownAITracingRegistry
async function shutdownAITracingRegistry(): Promise<void>
Shuts down all tracing configs and clears the registry.
clearAITracingRegistry
function clearAITracingRegistry(): void
Clears all configs without shutdown.
getAllAITracing
function getAllAITracing(): ReadonlyMap<string, AITracing>
Returns all registered tracing configs.
hasAITracing
function hasAITracing(name: string): boolean
Checks if a tracing instance exists and is enabled.
See Also
Documentation
- AI Tracing Overview - Concepts and usage guide
- Sampling Strategies - Sampling configuration details
- Multi-Config Setup - Using multiple configurations
Reference
- AITracing Classes - Core tracing classes
- Interfaces - Type definitions
- Span Reference - Span lifecycle
Examples
- Basic AI Tracing - Getting started
Exporters
- DefaultExporter - Storage configuration
- CloudExporter - Cloud setup
- Langfuse - Langfuse integration
- Braintrust - Braintrust integration