@mastra/observability 1.17.0 → 1.17.1-alpha.0

package/dist/index.js

@@ -185,21 +185,15 @@ var BaseObservabilityEventBus = class BaseObservabilityEventBus extends MastraBa
 * }
 * ```
 */
-/**
-* Default keys to strip from objects during deep cleaning.
-* These are typically internal/sensitive fields that shouldn't be traced.
-*/
-const DEFAULT_KEYS_TO_STRIP = /* @__PURE__ */ new Set([
-	"logger",
-	"experimental_providerMetadata",
-	"providerMetadata",
-	"steps",
-	"tracingContext",
-	"execute",
-	"validate"
-]);
+const FUNCTION_KEYS_TO_STRIP = /* @__PURE__ */ new Set(["execute", "validate"]);
+const LOGGER_METHODS = [
+	"debug",
+	"info",
+	"warn",
+	"error"
+];
 const DEFAULT_DEEP_CLEAN_OPTIONS = Object.freeze({
-	keysToStrip: DEFAULT_KEYS_TO_STRIP,
+	keysToStrip: [],
 	maxDepth: 8,
 	maxStringLength: 128 * 1024,
 	maxArrayLength: 50,
@@ -212,7 +206,7 @@ const DEFAULT_DEEP_CLEAN_OPTIONS = Object.freeze({
 function mergeSerializationOptions(userOptions) {
 	if (!userOptions) return DEFAULT_DEEP_CLEAN_OPTIONS;
 	return {
-		keysToStrip: DEFAULT_KEYS_TO_STRIP,
+		keysToStrip: DEFAULT_DEEP_CLEAN_OPTIONS.keysToStrip,
 		maxDepth: userOptions.maxDepth ?? DEFAULT_DEEP_CLEAN_OPTIONS.maxDepth,
 		maxStringLength: userOptions.maxStringLength ?? DEFAULT_DEEP_CLEAN_OPTIONS.maxStringLength,
 		maxArrayLength: userOptions.maxArrayLength ?? DEFAULT_DEEP_CLEAN_OPTIONS.maxArrayLength,
@@ -238,6 +232,47 @@ function getMapKeyType(key) {
 	if (key instanceof Error) return "error";
 	return typeof key;
 }
+function hasOnlyKnownKeys(value, keys) {
+	try {
+		return Object.keys(value).every((key) => keys.includes(key));
+	} catch {
+		return false;
+	}
+}
+function isSpanLike(value) {
+	if (typeof value !== "object" || value === null || Array.isArray(value)) return false;
+	const span = value;
+	try {
+		return typeof span.id === "string" && typeof span.traceId === "string" && typeof span.type === "string" && typeof span.name === "string";
+	} catch {
+		return false;
+	}
+}
+function isTracingContextLike(value) {
+	if (typeof value !== "object" || value === null || Array.isArray(value)) return false;
+	const context = value;
+	if (!hasOnlyKnownKeys(context, ["currentSpan"])) return false;
+	try {
+		return context.currentSpan === void 0 || isSpanLike(context.currentSpan);
+	} catch {
+		return false;
+	}
+}
+function isLoggerLike(value) {
+	if (typeof value !== "object" || value === null || Array.isArray(value)) return false;
+	const logger = value;
+	try {
+		return LOGGER_METHODS.some((method) => typeof logger[method] === "function");
+	} catch {
+		return false;
+	}
+}
+function shouldStripEntry(key, value, stripSet) {
+	if (stripSet.has(key)) return true;
+	if (key === "tracingContext" && isTracingContextLike(value)) return true;
+	if (key === "logger") return typeof value === "function" || isLoggerLike(value);
+	return FUNCTION_KEYS_TO_STRIP.has(key) && typeof value === "function";
+}
 function restoreSerializedMapKey(keyType, key) {
 	switch (keyType) {
 		case "undefined": return;
@@ -340,7 +375,7 @@ function deepClean(value, options = DEFAULT_DEEP_CLEAN_OPTIONS) {
 				let mapKeyCount = 0;
 				let omittedMapEntries = 0;
 				for (const [mapKey, mapVal] of val) {
-					if (typeof mapKey === "string" && stripSet.has(mapKey)) continue;
+					if (typeof mapKey === "string" && shouldStripEntry(mapKey, mapVal, stripSet)) continue;
 					if (mapKeyCount >= maxObjectKeys) {
 						omittedMapEntries++;
 						continue;
@@ -416,15 +451,34 @@ function deepClean(value, options = DEFAULT_DEEP_CLEAN_OPTIONS) {
 			}
 			if (looksLikeJsonSchema) return val;
 			const cleaned = {};
-			const keys = Object.keys(val).filter((key) => !stripSet.has(key));
+			let keys;
+			try {
+				keys = Object.keys(val);
+			} catch (error) {
+				return formatSerializationError(error);
+			}
 			let keyCount = 0;
 			for (const key of keys) {
+				if (stripSet.has(key)) continue;
+				let rawValue;
+				try {
+					rawValue = val[key];
+				} catch (error) {
+					if (keyCount >= maxObjectKeys) {
+						cleaned["__truncated"] = `${keys.length - keyCount} more keys omitted`;
+						break;
+					}
+					cleaned[key] = formatSerializationError(error);
+					keyCount++;
+					continue;
+				}
+				if (shouldStripEntry(key, rawValue, stripSet)) continue;
 				if (keyCount >= maxObjectKeys) {
 					cleaned["__truncated"] = `${keys.length - keyCount} more keys omitted`;
 					break;
 				}
 				try {
-					cleaned[key] = helper(val[key], depth + 1);
+					cleaned[key] = helper(rawValue, depth + 1);
 					keyCount++;
 				} catch (error) {
 					cleaned[key] = formatSerializationError(error);
@@ -2437,6 +2491,49 @@ var ModelSpanTracker = class {
 	}
 };
 //#endregion
+//#region src/spans/metadata.ts
+/**
+* Shared span-metadata helpers.
+*
+* Used by both the observability instance (`instances/base.ts`) and the span
+* base class (`spans/base.ts`) so the plain-record check and the
+* descriptor-preserving merge stay in a single place. Both feed the same span
+* metadata pipeline, so keeping one implementation avoids divergence.
+*/
+/**
+* Returns true only for plain object records (prototype is `Object.prototype`
+* or `null`). Maps, Dates, class instances, and arrays return false so callers
+* can preserve their original shape instead of shallow-copying them into `{}`.
+*/
+function isPlainRecord(value) {
+	if (!value || typeof value !== "object" || Array.isArray(value)) return false;
+	try {
+		const prototype = Object.getPrototypeOf(value);
+		return prototype === Object.prototype || prototype === null;
+	} catch {
+		return false;
+	}
+}
+/**
+* Merges two metadata values while preserving property descriptors (so getters
+* are copied as accessors rather than eagerly invoked). Only plain records are
+* merged; if either side is non-plain the second argument is returned as-is,
+* matching the previous per-module behavior.
+*/
+function mergeMetadata$1(parentMetadata, metadata) {
+	if (!parentMetadata) return metadata;
+	if (!metadata) return parentMetadata;
+	if (!isPlainRecord(parentMetadata) || !isPlainRecord(metadata)) return metadata;
+	try {
+		const merged = {};
+		Object.defineProperties(merged, Object.getOwnPropertyDescriptors(parentMetadata));
+		Object.defineProperties(merged, Object.getOwnPropertyDescriptors(metadata));
+		return merged;
+	} catch {
+		return metadata;
+	}
+}
+//#endregion
 //#region src/spans/base.ts
 /**
 * Determines if a span type should be considered internal based on flags.
@@ -2561,10 +2658,7 @@ var BaseSpan = class {
 		this.type = options.type;
 		this.isInternal = isSpanInternal(this.type, options.tracingPolicy?.internal);
 		this.isExcluded = this.alwaysExcluded || observabilityConfig.excludeSpanTypes?.includes(this.type) === true || this.isInternal && !observabilityConfig.includeInternalSpans;
-		this.metadata = deepClean(options.parent?.metadata || options.metadata ? {
-			...options.parent?.metadata,
-			...options.metadata
-		} : void 0, this.deepCleanOptions);
+		this.metadata = deepClean(this.prepareSpanMetadata(mergeMetadata$1(options.parent?.metadata, options.metadata)), this.deepCleanOptions);
 		this.parent = options.parent;
 		this.startTime = options.startTime ?? /* @__PURE__ */ new Date();
 		this.observabilityInstance = observabilityInstance;
@@ -2582,9 +2676,32 @@ var BaseSpan = class {
 		}
 		this.attributes = deepClean(options.attributes, this.deepCleanOptions) || {};
 		if (options.requestContext && options.requestContext.size() > 0) this.requestContext = deepClean(options.requestContext, this.deepCleanOptions);
-		if (this.isEvent) this.output = deepClean(options.output, this.deepCleanOptions);
+		if (this.isEvent) this.output = deepClean(this.prepareSpanOutput(options.output), this.deepCleanOptions);
 		else this.input = deepClean(options.input, this.deepCleanOptions);
 	}
+	prepareSpanOutput(value) {
+		if (!isPlainRecord(value)) return value;
+		if (this.type !== SpanType.MODEL_STEP && this.type !== SpanType.MODEL_INFERENCE) return value;
+		try {
+			const prepared = { ...value };
+			delete prepared.steps;
+			return prepared;
+		} catch {
+			return value;
+		}
+	}
+	prepareSpanMetadata(value) {
+		if (!isPlainRecord(value)) return value;
+		if (this.type !== SpanType.MODEL_STEP) return value;
+		try {
+			const prepared = { ...value };
+			delete prepared.providerMetadata;
+			delete prepared.experimental_providerMetadata;
+			return prepared;
+		} catch {
+			return value;
+		}
+	}
 	createChildSpan(options) {
 		return this.observabilityInstance.startSpan({
 			...options,
@@ -2791,10 +2908,10 @@ var DefaultSpan = class extends BaseSpan {
 		this.endTime = /* @__PURE__ */ new Date();
 		if (options?.metadata) this.metadata = {
 			...this.metadata,
-			...deepClean(options.metadata, this.deepCleanOptions)
+			...deepClean(this.prepareSpanMetadata(options.metadata), this.deepCleanOptions)
 		};
 		if (this.isExcluded) return;
-		if (options?.output !== void 0) this.output = deepClean(options.output, this.deepCleanOptions);
+		if (options?.output !== void 0) this.output = deepClean(this.prepareSpanOutput(options.output), this.deepCleanOptions);
 		if (options?.attributes) this.attributes = {
 			...this.attributes,
 			...deepClean(options.attributes, this.deepCleanOptions)
@@ -2805,7 +2922,7 @@ var DefaultSpan = class extends BaseSpan {
 		const { error, endSpan = true, attributes, metadata } = options;
 		if (metadata) this.metadata = {
 			...this.metadata,
-			...deepClean(metadata, this.deepCleanOptions)
+			...deepClean(this.prepareSpanMetadata(metadata), this.deepCleanOptions)
 		};
 		if (!this.isExcluded) {
 			this.errorInfo = deepClean(error instanceof MastraError ? {
@@ -2834,11 +2951,11 @@ var DefaultSpan = class extends BaseSpan {
 		if (options.name !== void 0) this.name = options.name;
 		if (options.metadata) this.metadata = {
 			...this.metadata,
-			...deepClean(options.metadata, this.deepCleanOptions)
+			...deepClean(this.prepareSpanMetadata(options.metadata), this.deepCleanOptions)
 		};
 		if (this.isExcluded) return;
 		if (options.input !== void 0) this.input = deepClean(options.input, this.deepCleanOptions);
-		if (options.output !== void 0) this.output = deepClean(options.output, this.deepCleanOptions);
+		if (options.output !== void 0) this.output = deepClean(this.prepareSpanOutput(options.output), this.deepCleanOptions);
 		if (options.attributes) this.attributes = {
 			...this.attributes,
 			...deepClean(options.attributes, this.deepCleanOptions)
@@ -2926,6 +3043,19 @@ var NoOpSpan = class extends BaseSpan {
 /**
 * BaseObservability - Abstract base class for Observability implementations
 */
+function hasMetadataKey(metadata, key) {
+	if (!metadata || typeof metadata !== "object") return false;
+	try {
+		return Object.prototype.hasOwnProperty.call(Object.getOwnPropertyDescriptors(metadata), key);
+	} catch {
+		return true;
+	}
+}
+function injectEnvironmentMetadata(metadata, environment) {
+	if (environment === void 0 || hasMetadataKey(metadata, "environment")) return metadata;
+	if (metadata && !isPlainRecord(metadata)) return metadata;
+	return mergeMetadata$1(metadata, { environment });
+}
 /**
 * Abstract base class for all Observability implementations in Mastra.
 */
@@ -3021,16 +3151,9 @@ var BaseObservabilityInstance = class extends MastraBase {
 		let traceState;
 		if (options.parent) traceState = options.parent.traceState;
 		else traceState = this.computeTraceState(tracingOptions);
-		const tracingMetadata = !options.parent ? tracingOptions?.metadata : void 0;
-		const mergedMetadata = metadata || tracingMetadata ? {
-			...metadata,
-			...tracingMetadata
-		} : void 0;
+		const mergedMetadata = mergeMetadata$1(metadata, !options.parent ? tracingOptions?.metadata : void 0);
 		const enrichedMetadata = this.extractMetadataFromRequestContext(requestContext, mergedMetadata, traceState);
-		const finalMetadata = !options.parent && this.#mastraEnvironment !== void 0 && (enrichedMetadata === void 0 || enrichedMetadata.environment === void 0) ? {
-			...enrichedMetadata ?? {},
-			environment: this.#mastraEnvironment
-		} : enrichedMetadata;
+		const finalMetadata = !options.parent ? injectEnvironmentMetadata(enrichedMetadata, this.#mastraEnvironment) : enrichedMetadata;
 		const tags = !options.parent ? tracingOptions?.tags : void 0;
 		const traceId = !options.parent ? options.traceId ?? tracingOptions?.traceId : options.traceId;
 		const parentSpanId = options.parentSpanId;
@@ -3295,10 +3418,7 @@ var BaseObservabilityInstance = class extends MastraBase {
 		if (!requestContext || !traceState || traceState.requestContextKeys.length === 0) return explicitMetadata;
 		const extracted = this.extractKeys(requestContext, traceState.requestContextKeys);
 		if (Object.keys(extracted).length === 0 && !explicitMetadata) return;
-		return {
-			...extracted,
-			...explicitMetadata
-		};
+		return mergeMetadata$1(extracted, explicitMetadata);
 	}
 	/**
 	* Extract specific keys from RequestContext
@@ -6345,6 +6465,8 @@ const QUOTA_EXCEEDED_STATUS = 402;
 const OBSERVABILITY_STATUS_HEADER = "x-mastra-observability";
 const OBSERVABILITY_DISABLED_VALUE = "disabled";
 const OBSERVABILITY_RETRY_AFTER_HEADER = "x-mastra-observability-retry-after";
+const OBSERVABILITY_CAPABILITIES_HEADER = "x-mastra-observability-capabilities";
+const QUOTA_PAUSE_CAPABILITY = "quota-pause-v1";
 const DEFAULT_QUOTA_PROBE_INTERVAL_SECONDS = 300;
 const MAX_QUOTA_PROBE_INTERVAL_SECONDS = Math.floor(2147483647 / 1e3);
 function isObservabilityDisabled(response) {
@@ -6671,7 +6793,8 @@ var MastraPlatformExporter = class extends BaseExporter {
 	buildPublishHeaders() {
 		return {
 			Authorization: `Bearer ${this.platformConfig.accessToken}`,
-			"Content-Type": "application/json"
+			"Content-Type": "application/json",
+			[OBSERVABILITY_CAPABILITIES_HEADER]: QUOTA_PAUSE_CAPABILITY
 		};
 	}
 	buildPublishBody(signal, records) {
@@ -6724,7 +6847,7 @@ var MastraPlatformExporter = class extends BaseExporter {
 			this.flushTimer = null;
 		}
 		this.resetBuffer();
-		this.logger.warn(`Mastra observability paused: quota exhausted, dropping telemetry and probing every ${retryAfterSeconds}s`);
+		this.logger.warn(`Mastra observability export paused: platform quota exhausted (OBSERVABILITY_QUOTA_EXCEEDED). Dropping telemetry and retrying in ${retryAfterSeconds} seconds. Check Platform billing/usage to restore telemetry.`);
 		this.scheduleQuotaProbe();
 	}
 	scheduleQuotaProbe() {
@@ -9299,6 +9422,6 @@ function buildTracingOptions(...updaters) {
 	return updaters.reduce((opts, updater) => updater(opts), {});
 }
 //#endregion
-export { BaseExporter, BaseObservabilityEventBus, BaseObservabilityInstance, BaseSpan, CardinalityFilter, CloudExporter, ConsoleExporter, DEFAULT_DEEP_CLEAN_OPTIONS, DEFAULT_KEYS_TO_STRIP, DEFAULT_LIMITS, DefaultExporter, DefaultObservabilityInstance, DefaultSpan, JsonExporter, LoggerContextImpl, MastraPlatformExporter, MastraStorageExporter, MetricsContextImpl, ModelSpanTracker, NoOpSpan, Observability, ObservabilityBus, SamplingStrategyType, SensitiveDataFilter, TestExporter, TraceData, TrackingExporter, buildExportedLog, buildExportedSpan, buildTracingOptions, chainFormatters, createClientObservabilityProxy, decodeResourceLogs, decodeResourceSpans, deepClean, formatBaggage, formatTraceparent, getExternalParentId, isSerializedMap, mergeSerializationOptions, observabilityConfigValueSchema, observabilityFeatures, observabilityInstanceConfigSchema, observabilityRegistryConfigSchema, otlpSeverityToLogLevel, parseBaggage, parseTraceparent, reconstructSerializedMap, routeToHandler, samplingStrategySchema, serializationOptionsSchema, truncateString };
+export { BaseExporter, BaseObservabilityEventBus, BaseObservabilityInstance, BaseSpan, CardinalityFilter, CloudExporter, ConsoleExporter, DEFAULT_DEEP_CLEAN_OPTIONS, DEFAULT_LIMITS, DefaultExporter, DefaultObservabilityInstance, DefaultSpan, JsonExporter, LoggerContextImpl, MastraPlatformExporter, MastraStorageExporter, MetricsContextImpl, ModelSpanTracker, NoOpSpan, OBSERVABILITY_CAPABILITIES_HEADER, Observability, ObservabilityBus, QUOTA_PAUSE_CAPABILITY, SamplingStrategyType, SensitiveDataFilter, TestExporter, TraceData, TrackingExporter, buildExportedLog, buildExportedSpan, buildTracingOptions, chainFormatters, createClientObservabilityProxy, decodeResourceLogs, decodeResourceSpans, deepClean, formatBaggage, formatTraceparent, getExternalParentId, isSerializedMap, mergeSerializationOptions, observabilityConfigValueSchema, observabilityFeatures, observabilityInstanceConfigSchema, observabilityRegistryConfigSchema, otlpSeverityToLogLevel, parseBaggage, parseTraceparent, reconstructSerializedMap, routeToHandler, samplingStrategySchema, serializationOptionsSchema, truncateString };
 
 //# sourceMappingURL=index.js.map