fix: make trace name configurable (#1896)

[MASTRA-1822](https://linear.app/kepler-crm/issue/MASTRA-1822/fix-langfuse-exporter-not-functioning), make trace name configurable to fix langfuse exporter. Langfuse client is expecting trace name "ai", all other trace names are dropped. in langfuse dashboard: ![image](https://github.com/user-attachments/assets/861f7bbe-1382-46dd-9a69-789ca6f1626e)
mastra-ai · Feb 13, 2025 · 5ee67d3 · 5ee67d3
1 parent bc1d50e
commit 5ee67d3
Show file tree

Hide file tree

Showing 8 changed files with 253 additions and 125 deletions.
diff --git a/.changeset/spicy-dolphins-think.md b/.changeset/spicy-dolphins-think.md
@@ -0,0 +1,5 @@
+---
+'@mastra/core': patch
+---
+
+make trace name configurable for telemetry exporter
diff --git a/docs/public/llms.txt b/docs/public/llms.txt
@@ -7797,6 +7797,8 @@ LANGFUSE_SECRET_KEY=your_secret_key
 LANGFUSE_BASEURL=https://cloud.langfuse.com  # Optional - defaults to cloud.langfuse.com
 ```
 
+**Important**: When configuring the telemetry export settings, the `traceName` parameter must be set to `"ai"` for the Langfuse integration to work properly.
+
 ## Implementation
 
 Here's how to configure Mastra to use Langfuse:
@@ -7813,6 +7815,8 @@ export const mastra = new Mastra({
     export: {
       type: "custom",
       exporter: new LangfuseExporter({
+        type: "custom",
+        traceName: "ai",
         publicKey: process.env.LANGFUSE_PUBLIC_KEY,
         secretKey: process.env.LANGFUSE_SECRET_KEY,
         baseUrl: process.env.LANGFUSE_BASEURL,

diff --git a/docs/src/pages/docs/reference/observability/providers/langfuse.mdx b/docs/src/pages/docs/reference/observability/providers/langfuse.mdx
@@ -17,6 +17,8 @@ LANGFUSE_SECRET_KEY=your_secret_key
 LANGFUSE_BASEURL=https://cloud.langfuse.com  # Optional - defaults to cloud.langfuse.com
 ```
 
+**Important**: When configuring the telemetry export settings, the `traceName` parameter must be set to `"ai"` for the Langfuse integration to work properly.
+
 ## Implementation
 
 Here's how to configure Mastra to use Langfuse:
@@ -32,6 +34,7 @@ export const mastra = new Mastra({
     enabled: true,
     export: {
       type: "custom",
+      traceName: "ai",
       exporter: new LangfuseExporter({
         publicKey: process.env.LANGFUSE_PUBLIC_KEY,
         secretKey: process.env.LANGFUSE_SECRET_KEY,

diff --git a/packages/core/src/mastra/index.ts b/packages/core/src/mastra/index.ts
@@ -70,7 +70,7 @@ export class Mastra<
     Telemetry
     */
     // if storage is a libsql instance, we need to default the telemetry exporter to OTLPStorageExporter
-    if (storage instanceof DefaultStorage) {
+    if (storage instanceof DefaultStorage && config?.telemetry?.export?.type !== 'custom') {
       const newTelemetry = {
         ...(config?.telemetry || {}),
         export: {

diff --git a/packages/core/src/telemetry/telemetry.decorators.ts b/packages/core/src/telemetry/telemetry.decorators.ts
@@ -3,7 +3,12 @@ import { trace, context, SpanStatusCode, SpanKind, propagation } from '@opentele
 import { hasActiveTelemetry } from './utility';
 
 // Decorator factory that takes optional spanName
-export function withSpan(options: { spanName?: string; skipIfNoTelemetry?: boolean; spanKind?: SpanKind }): any {
+export function withSpan(options: {
+  spanName?: string;
+  skipIfNoTelemetry?: boolean;
+  spanKind?: SpanKind;
+  tracerName?: string;
+}): any {
   return function (_target: any, propertyKey: string | symbol, descriptor?: PropertyDescriptor | number) {
     if (!descriptor || typeof descriptor === 'number') return;
 
@@ -12,11 +17,11 @@ export function withSpan(options: { spanName?: string; skipIfNoTelemetry?: boole
 
     descriptor.value = function (...args: any[]) {
       // Skip if no telemetry is available and skipIfNoTelemetry is true
-      if (options?.skipIfNoTelemetry && !hasActiveTelemetry()) {
+      if (options?.skipIfNoTelemetry && !hasActiveTelemetry(options?.tracerName)) {
         return originalMethod.apply(this, args);
       }
 
-      const tracer = trace.getTracer('default-tracer');
+      const tracer = trace.getTracer(options?.tracerName ?? 'default-tracer');
 
       // Determine span name and kind
       let spanName: string;
@@ -113,6 +118,7 @@ export function InstrumentClass(options?: {
   spanKind?: SpanKind;
   excludeMethods?: string[];
   methodFilter?: (methodName: string) => boolean;
+  tracerName?: string;
 }) {
   return function (target: any) {
     const methods = Object.getOwnPropertyNames(target.prototype);
@@ -132,6 +138,7 @@ export function InstrumentClass(options?: {
             spanName: options?.prefix ? `${options.prefix}.${method}` : method,
             skipIfNoTelemetry: true,
             spanKind: options?.spanKind || SpanKind.INTERNAL,
+            tracerName: options?.tracerName,
           })(target, method, descriptor),
         );
       }

diff --git a/packages/core/src/telemetry/types.ts b/packages/core/src/telemetry/types.ts
@@ -34,6 +34,9 @@ export type OtelConfig = {
   /** Whether telemetry is enabled. Defaults to true */
   enabled?: boolean;
 
+  /** Name of the tracer to use. Defaults to 'mastra-tracer' */
+  tracerName?: string;
+
   /** Sampling configuration to control trace data volume */
   sampling?: SamplingStrategy;
 
@@ -53,6 +56,7 @@ export type OtelConfig = {
       }
     | {
         type: 'custom';
+        tracerName?: string;
         exporter: SpanExporter;
       };
 };
diff --git a/packages/core/src/telemetry/utility.ts b/packages/core/src/telemetry/utility.ts
@@ -1,9 +1,9 @@
 import { trace } from '@opentelemetry/api';
 
 // Helper function to check if telemetry is active
-export function hasActiveTelemetry(): boolean {
+export function hasActiveTelemetry(tracerName: string = 'default-tracer'): boolean {
   try {
-    return !!trace.getTracer('default-tracer');
+    return !!trace.getTracer(tracerName);
   } catch {
     return false;
   }