@latitude-data/telemetry 1.0.0 → 1.0.2

package/dist/index.d.ts

@@ -37,14 +37,16 @@ declare const DEFAULT_REDACT_SPAN_PROCESSOR: () => RedactSpanProcessor;
 
 declare enum SegmentSource {
     API = "api",
-    Playground = "playground",
+    AgentAsTool = "agent_as_tool",// TODO(tracing): deprecated, use SegmentType.Document with DocumentType.Agent instead
+    Copilot = "copilot",
+    EmailTrigger = "email_trigger",
     Evaluation = "evaluation",// Note: from prompts of llm evaluations
     Experiment = "experiment",
-    User = "user",
+    Playground = "playground",
+    ScheduledTrigger = "scheduled_trigger",
+    IntegrationTrigger = "integration_trigger",
     SharedPrompt = "shared_prompt",
-    AgentAsTool = "agent_as_tool",// TODO(tracing): deprecated, use SegmentType.Document with DocumentType.Agent instead
-    EmailTrigger = "email_trigger",
-    ScheduledTrigger = "scheduled_trigger"
+    User = "user"
 }
 declare enum SegmentType {
     Document = "document",

package/dist/index.js

@@ -121,20 +121,32 @@ const env = { GATEWAY_BASE_URL: GET_GATEWAY_BASE_URL() };
 var SegmentSource;
 (function (SegmentSource) {
     SegmentSource["API"] = "api";
-    SegmentSource["Playground"] = "playground";
-    SegmentSource["Evaluation"] = "evaluation";
-    SegmentSource["Experiment"] = "experiment";
-    SegmentSource["User"] = "user";
-    SegmentSource["SharedPrompt"] = "shared_prompt";
     SegmentSource["AgentAsTool"] = "agent_as_tool";
+    SegmentSource["Copilot"] = "copilot";
     SegmentSource["EmailTrigger"] = "email_trigger";
+    SegmentSource["Evaluation"] = "evaluation";
+    SegmentSource["Experiment"] = "experiment";
+    SegmentSource["Playground"] = "playground";
     SegmentSource["ScheduledTrigger"] = "scheduled_trigger";
+    SegmentSource["IntegrationTrigger"] = "integration_trigger";
+    SegmentSource["SharedPrompt"] = "shared_prompt";
+    SegmentSource["User"] = "user";
 })(SegmentSource || (SegmentSource = {}));
 var SegmentType;
 (function (SegmentType) {
     SegmentType["Document"] = "document";
     SegmentType["Step"] = "step";
 })(SegmentType || (SegmentType = {}));
+const SEGMENT_SPECIFICATIONS = {
+    [SegmentType.Document]: {
+        name: 'Prompt',
+        description: 'A prompt',
+    },
+    [SegmentType.Step]: {
+        name: 'Step',
+        description: 'A step in a prompt',
+    },
+};
 const baseSegmentBaggageSchema = z.object({
     id: z.string(),
     parentId: z.string().optional(),
@@ -177,14 +189,56 @@ var SpanType;
     SpanType["Segment"] = "segment";
     SpanType["Unknown"] = "unknown";
 })(SpanType || (SpanType = {}));
-const GENAI_SPANS = [
-    SpanType.Tool,
-    SpanType.Completion,
-    SpanType.Embedding,
-    SpanType.Retrieval,
-    SpanType.Reranking,
-];
-[SpanType.Http, SpanType.Segment, SpanType.Unknown];
+const SPAN_SPECIFICATIONS = {
+    [SpanType.Tool]: {
+        name: 'Tool',
+        description: 'A tool call',
+        isGenAI: true,
+        isHidden: false,
+    },
+    [SpanType.Completion]: {
+        name: 'Completion',
+        description: 'A completion call',
+        isGenAI: true,
+        isHidden: false,
+    },
+    [SpanType.Embedding]: {
+        name: 'Embedding',
+        description: 'An embedding call',
+        isGenAI: true,
+        isHidden: false,
+    },
+    [SpanType.Retrieval]: {
+        name: 'Retrieval',
+        description: 'A retrieval call',
+        isGenAI: true,
+        isHidden: false,
+    },
+    [SpanType.Reranking]: {
+        name: 'Reranking',
+        description: 'A reranking call',
+        isGenAI: true,
+        isHidden: false,
+    },
+    [SpanType.Http]: {
+        name: 'HTTP',
+        description: 'An HTTP request',
+        isGenAI: false,
+        isHidden: true,
+    },
+    [SpanType.Segment]: {
+        name: 'Segment',
+        description: 'A (partial) segment of a trace',
+        isGenAI: false,
+        isHidden: false,
+    },
+    [SpanType.Unknown]: {
+        name: 'Unknown',
+        description: 'An unknown span',
+        isGenAI: false,
+        isHidden: true,
+    },
+};
 var SpanStatus;
 (function (SpanStatus) {
     SpanStatus["Unset"] = "unset";
@@ -264,9 +318,9 @@ const GEN_AI_RESPONSE_FINISH_REASON_VALUE_STOP = 'stop';
 const GEN_AI_RESPONSE_FINISH_REASON_VALUE_TOOL_CALLS = 'tool_calls';
 const ATTR_HTTP_REQUEST_URL = 'http.request.url';
 const ATTR_HTTP_REQUEST_BODY = 'http.request.body';
-const ATTR_HTTP_REQUEST_HEADERS = 'http.request.header';
+const ATTR_HTTP_REQUEST_HEADER = 'http.request.header';
 const ATTR_HTTP_RESPONSE_BODY = 'http.response.body';
-const ATTR_HTTP_RESPONSE_HEADERS = 'http.response.header';
+const ATTR_HTTP_RESPONSE_HEADER = 'http.response.header';
 /* Note: Schemas for span ingestion following OpenTelemetry service request specification */
 var Otlp;
 (function (Otlp) {
@@ -298,10 +352,22 @@ var Otlp;
         spanId: z.string(),
         attributes: z.array(Otlp.attributeSchema).optional(),
     });
+    (function (StatusCode) {
+        StatusCode[StatusCode["Unset"] = 0] = "Unset";
+        StatusCode[StatusCode["Ok"] = 1] = "Ok";
+        StatusCode[StatusCode["Error"] = 2] = "Error";
+    })(Otlp.StatusCode || (Otlp.StatusCode = {}));
     Otlp.statusSchema = z.object({
         code: z.number(),
         message: z.string().optional(),
     });
+    (function (SpanKind) {
+        SpanKind[SpanKind["Internal"] = 0] = "Internal";
+        SpanKind[SpanKind["Server"] = 1] = "Server";
+        SpanKind[SpanKind["Client"] = 2] = "Client";
+        SpanKind[SpanKind["Producer"] = 3] = "Producer";
+        SpanKind[SpanKind["Consumer"] = 4] = "Consumer";
+    })(Otlp.SpanKind || (Otlp.SpanKind = {}));
     Otlp.spanSchema = z.object({
         traceId: z.string(),
         spanId: z.string(),
@@ -684,17 +750,18 @@ var LegacyChainEventTypes;
 
 var ChainEventTypes;
 (function (ChainEventTypes) {
+    ChainEventTypes["ChainCompleted"] = "chain-completed";
+    ChainEventTypes["ChainError"] = "chain-error";
     ChainEventTypes["ChainStarted"] = "chain-started";
-    ChainEventTypes["StepStarted"] = "step-started";
-    ChainEventTypes["ProviderStarted"] = "provider-started";
+    ChainEventTypes["IntegrationWakingUp"] = "integration-waking-up";
     ChainEventTypes["ProviderCompleted"] = "provider-completed";
-    ChainEventTypes["ToolsStarted"] = "tools-started";
-    ChainEventTypes["ToolCompleted"] = "tool-completed";
+    ChainEventTypes["ProviderStarted"] = "provider-started";
     ChainEventTypes["StepCompleted"] = "step-completed";
-    ChainEventTypes["ChainCompleted"] = "chain-completed";
-    ChainEventTypes["ChainError"] = "chain-error";
+    ChainEventTypes["StepStarted"] = "step-started";
+    ChainEventTypes["ToolCompleted"] = "tool-completed";
     ChainEventTypes["ToolsRequested"] = "tools-requested";
-    ChainEventTypes["IntegrationWakingUp"] = "integration-waking-up";
+    ChainEventTypes["ToolResult"] = "tool-result";
+    ChainEventTypes["ToolsStarted"] = "tools-started";
 })(ChainEventTypes || (ChainEventTypes = {}));
 
 var IntegrationType;
@@ -702,6 +769,7 @@ var IntegrationType;
     IntegrationType["Latitude"] = "latitude";
     IntegrationType["ExternalMCP"] = "custom_mcp";
     IntegrationType["HostedMCP"] = "mcp_server";
+    IntegrationType["Pipedream"] = "pipedream";
 })(IntegrationType || (IntegrationType = {}));
 var HostedIntegrationType;
 (function (HostedIntegrationType) {
@@ -806,6 +874,14 @@ var EvaluationResultableType;
     EvaluationResultableType["Number"] = "evaluation_resultable_numbers";
 })(EvaluationResultableType || (EvaluationResultableType = {}));
 
+var MessageRole;
+(function (MessageRole) {
+    MessageRole["system"] = "system";
+    MessageRole["user"] = "user";
+    MessageRole["assistant"] = "assistant";
+    MessageRole["tool"] = "tool";
+})(MessageRole || (MessageRole = {}));
+
 var ModifiedDocumentType;
 (function (ModifiedDocumentType) {
     ModifiedDocumentType["Created"] = "created";
@@ -841,6 +917,7 @@ var DocumentTriggerType;
 (function (DocumentTriggerType) {
     DocumentTriggerType["Email"] = "email";
     DocumentTriggerType["Scheduled"] = "scheduled";
+    DocumentTriggerType["Integration"] = "integration";
 })(DocumentTriggerType || (DocumentTriggerType = {}));
 var DocumentTriggerParameters;
 (function (DocumentTriggerParameters) {
@@ -1009,7 +1086,7 @@ class ManualInstrumentation {
         }
         const start = options || {};
         let operation = undefined;
-        if (GENAI_SPANS.includes(type)) {
+        if (SPAN_SPECIFICATIONS[type].isGenAI) {
             operation = type;
         }
         const span = this.tracer.startSpan(name, {
@@ -1327,18 +1404,18 @@ class ManualInstrumentation {
         };
     }
     embedding(ctx, options) {
-        return this.span(ctx, options?.name || 'Embedding', SpanType.Embedding, options);
+        return this.span(ctx, options?.name || SPAN_SPECIFICATIONS[SpanType.Embedding].name, SpanType.Embedding, options);
     }
     retrieval(ctx, options) {
-        return this.span(ctx, options?.name || 'Retrieval', SpanType.Retrieval, options);
+        return this.span(ctx, options?.name || SPAN_SPECIFICATIONS[SpanType.Retrieval].name, SpanType.Retrieval, options);
     }
     reranking(ctx, options) {
-        return this.span(ctx, options?.name || 'Reranking', SpanType.Reranking, options);
+        return this.span(ctx, options?.name || SPAN_SPECIFICATIONS[SpanType.Reranking].name, SpanType.Reranking, options);
     }
     attribifyHeaders(direction, headers) {
         const prefix = direction === 'request'
-            ? ATTR_HTTP_REQUEST_HEADERS
-            : ATTR_HTTP_RESPONSE_HEADERS;
+            ? ATTR_HTTP_REQUEST_HEADER
+            : ATTR_HTTP_RESPONSE_HEADER;
         const attributes = {};
         for (const key in headers) {
             const field = this.toKebabCase(key);
@@ -1352,6 +1429,7 @@ class ManualInstrumentation {
     http(ctx, options) {
         const start = options;
         const method = start.request.method.toUpperCase();
+        // Note: do not serialize headers as a single attribute because fields won't be redacted
         const attrHeaders = this.attribifyHeaders('request', start.request.headers);
         let finalBody = '';
         if (typeof start.request.body === 'string') {
@@ -1378,6 +1456,7 @@ class ManualInstrumentation {
             context: span.context,
             end: (options) => {
                 const end = options;
+                // Note: do not serialize headers as a single attribute because fields won't be redacted
                 const attrHeaders = this.attribifyHeaders('response', end.response.headers);
                 let finalBody = '';
                 if (typeof end.response.body === 'string') {
@@ -1426,9 +1505,7 @@ class ManualInstrumentation {
         };
         ctx = this.setBaggage(ctx, baggage, options.baggage);
         // Dummy wrapper to force the same trace and carry on some segment attributes
-        const span = this.span(ctx, type, SpanType.Segment, {
-            attributes: options.attributes,
-        });
+        const span = this.span(ctx, SEGMENT_SPECIFICATIONS[type].name, SpanType.Segment, { attributes: options.attributes });
         let carrier = {};
         propagation.inject(span.context, carrier);
         baggage.segments.at(-1).traceparent = carrier.traceparent;
@@ -1512,11 +1589,11 @@ class LatitudeInstrumentation {
     }
     async wrapToolHandler(fn, ...args) {
         const toolArguments = args[0];
-        const { toolId, toolName } = args[1];
+        const { id, name } = args[1];
         const $tool = this.telemetry.tool(context.active(), {
-            name: toolName,
+            name,
             call: {
-                id: toolId,
+                id,
                 arguments: toolArguments,
             },
         });
@@ -1564,25 +1641,6 @@ class LatitudeInstrumentation {
         $prompt.end();
         return result;
     }
-    async wrapRenderAgent(fn, ...args) {
-        const { prompt, parameters } = args[0];
-        const $prompt = this.telemetry.prompt(context.active(), {
-            versionUuid: prompt.versionUuid,
-            promptUuid: prompt.uuid,
-            template: prompt.content,
-            parameters: parameters,
-        });
-        let result;
-        try {
-            result = await context.with($prompt.context, async () => await fn(...args));
-        }
-        catch (error) {
-            $prompt.fail(error);
-            throw error;
-        }
-        $prompt.end();
-        return result;
-    }
     async wrapRenderStep(fn, ...args) {
         const $step = this.telemetry.step(context.active());
         let result;
@@ -1661,7 +1719,7 @@ class LatitudeInstrumentation {
     }
 }
 
-const TRACES_URL = `${env.GATEWAY_BASE_URL}/api/v3/otlp/v1/traces`;
+const TRACES_URL = `${env.GATEWAY_BASE_URL}/api/v3/traces`;
 const SERVICE_NAME = process.env.npm_package_name || 'unknown';
 const SCOPE_VERSION = process.env.npm_package_version || 'unknown';
 const BACKGROUND = () => otel.ROOT_CONTEXT;