langwatch 1.19.0 → 2.0.0

package/dist/implementation-BXVPzwOt.d.mts

@@ -0,0 +1,261 @@
+import { BatchSpanProcessor, SpanExporter, ReadableSpan } from '@opentelemetry/sdk-trace-base';
+import { ExportResult } from '@opentelemetry/core';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-proto';
+import { CompressionAlgorithm } from '@opentelemetry/otlp-exporter-base';
+import { Logger, LogRecord, LoggerProvider } from '@opentelemetry/api-logs';
+import { V as VAL_GEN_AI_SYSTEMS, a as VAL_GEN_AI_FINISH_REASONS } from './values-1yj9l0Sa.mjs';
+import { b as SemConvLogRecordAttributes, a as SemConvAttributes } from './types-CoS5PmeU.mjs';
+import { TracerProvider } from '@opentelemetry/api';
+import { j as LangWatchTracer } from './types--ExXvd26.mjs';
+
+/**
+ * A BatchSpanProcessor subclass that filters spans before export by
+ * configurable rules -- spans matching any exclude rule are dropped.
+ * @module filterable-batch-span-exporter
+ */
+
+/**
+ * A rule for excluding spans from export, matched on `fieldName` by
+ * `matchOperation` against `matchValue`.
+ */
+interface SpanProcessingExcludeRule {
+    fieldName: "span_name" | "instrumentation_scope_name";
+    matchValue: string;
+    matchOperation: "includes" | "exact_match" | "starts_with" | "ends_with";
+}
+/**
+ * A BatchSpanProcessor that filters out spans matching any exclude rule
+ * before export — useful for dropping noisy spans like health checks.
+ */
+declare class FilterableBatchSpanProcessor extends BatchSpanProcessor {
+    private readonly _filters;
+    /**
+     * Create a new FilterableBatchSpanProcessor.
+     *
+     * @param exporter - The underlying SpanExporter to use for exporting spans.
+     * @param filters - An array of rules for excluding spans from export.
+     */
+    constructor(exporter: SpanExporter, filters: SpanProcessingExcludeRule[]);
+    /**
+     * Called when a span ends. If the span matches any exclude rule, it is dropped and not exported.
+     *
+     * @param span - The ReadableSpan that has ended.
+     */
+    onEnd(span: ReadableSpan): void;
+}
+
+interface Criteria {
+    instrumentationScopeName?: Match[];
+    name?: Match[];
+}
+interface Match {
+    equals?: string;
+    startsWith?: string;
+    matches?: RegExp;
+    ignoreCase?: boolean;
+}
+type TraceFilter = {
+    preset: "vercelAIOnly" | "excludeHttpRequests";
+} | {
+    include: Criteria;
+} | {
+    exclude: Criteria;
+};
+
+/** Options: endpoint URL, API key for auth, and optional span filters (default excludes HTTP). */
+interface LangWatchTraceExporterOptions {
+    endpoint?: string;
+    apiKey?: string;
+    /**
+     * Project identifier. Required when `apiKey` is a Personal Access Token
+     * (`pat-lw-*`); ignored for legacy `sk-lw-*` keys. Falls back to
+     * `LANGWATCH_PROJECT_ID`.
+     */
+    projectId?: string;
+    filters?: TraceFilter[] | null;
+    /** Request compression: gzip unless an OTEL_EXPORTER_OTLP_*COMPRESSION env var is set. */
+    compression?: CompressionAlgorithm;
+}
+
+/** Sends traces to LangWatch with auth; applies span filters (default excludes HTTP). */
+declare class LangWatchTraceExporter extends OTLPTraceExporter {
+    private readonly filters;
+    /** Configures auth from opts or environment; applies filters to span stream. */
+    constructor(opts?: LangWatchTraceExporterOptions);
+    export(spans: ReadableSpan[], resultCallback: (result: ExportResult) => void): void;
+}
+
+/** Body for a system message event in a GenAI span (a system/instruction to the model). */
+interface LangWatchSpanGenAISystemMessageEventBody {
+    /** Content of the system message */
+    content?: string;
+    /** Role of the message (system or instruction) */
+    role?: "system" | "instruction";
+}
+/** Body for a user message event in a GenAI span (a user/customer message to the model). */
+interface LangWatchSpanGenAIUserMessageEventBody {
+    /** Content of the user message */
+    content?: string;
+    /** Role of the message (user or customer) */
+    role?: "user" | "customer";
+}
+/** Body for an assistant message event in a GenAI span (a response, including tool calls). */
+interface LangWatchSpanGenAIAssistantMessageEventBody {
+    /** Content of the assistant message */
+    content?: string;
+    /** Role of the message (assistant or bot) */
+    role?: "assistant" | "bot";
+    /** Tool calls made by the assistant */
+    tool_calls?: {
+        function: {
+            /** Name of the function called */
+            name: string;
+            /** Arguments passed to the function */
+            arguments?: string;
+        };
+        /** Tool call identifier */
+        id: string;
+        /** Type of tool call */
+        type: "function";
+    }[];
+}
+/** Body for a tool message event in a GenAI span (a message from a tool the assistant invoked). */
+interface LangWatchSpanGenAIToolMessageEventBody {
+    /** Content of the tool message */
+    content?: string;
+    /** Tool call identifier */
+    id: string;
+    /** Role of the message (tool or function) */
+    role?: "tool" | "function";
+}
+/** Body for a choice event in a GenAI span (a model output choice, finish reason and message). */
+interface LangWatchSpanGenAIChoiceEventBody {
+    /** Reason the generation finished */
+    finish_reason: VAL_GEN_AI_FINISH_REASONS | (string & {});
+    /** Index of the choice */
+    index: number;
+    /** Message content for the choice */
+    message?: {
+        /** Content of the message */
+        content?: string;
+        /** Role of the message (assistant or bot) */
+        role?: "assistant" | "bot";
+        /** Tool calls made by the assistant */
+        tool_calls?: {
+            function: {
+                /** Name of the function called */
+                name: string;
+                /** Arguments passed to the function */
+                arguments?: string;
+            };
+            /** Tool call identifier */
+            id: string;
+            /** Type of tool call */
+            type: "function";
+        }[];
+    };
+}
+/**
+ * Extension of OpenTelemetry's LogRecord with LangWatch and GenAI-specific attributes.
+ */
+interface LangWatchLogRecord extends LogRecord {
+    /**
+     * Additional attributes to add to the log record.
+     *
+     * @default {}
+     */
+    attributes?: SemConvLogRecordAttributes;
+}
+/**
+ * Options for emitting a log record.
+ */
+interface EmitOptions {
+    /**
+     * Whether to omit the OTel context from the log record — standard OpenTelemetry
+     * omits it by default, so set this to avoid attaching context to every record.
+     * @default false
+     */
+    excludeContext?: boolean;
+}
+/**
+ * Extension of OpenTelemetry's Logger with LangWatch and GenAI-specific methods.
+ */
+interface LangWatchLogger extends Logger {
+    /**
+     * Emit a log record with LangWatch and GenAI-specific attributes.
+     *
+     * @param logRecord - The log record to emit
+     * @param options - Optional options for emitting the log record
+     */
+    emit(logRecord: LangWatchLogRecord, options?: EmitOptions): void;
+    /**
+     * Emit a GenAI system/instruction message event to the logger.
+     * @param body - The event body (content and role)
+     * @param system - The GenAI system (optional, e.g., 'openai', 'anthropic')
+     * @param attributes - Additional OpenTelemetry attributes (optional)
+     * @returns this
+     */
+    emitGenAISystemMessageEvent(body: LangWatchSpanGenAISystemMessageEventBody, system?: VAL_GEN_AI_SYSTEMS | (string & {}), attributes?: SemConvAttributes): void;
+    /**
+     * Emit a GenAI user/customer message event to the logger.
+     * @param body - The event body (content and role)
+     * @param system - The GenAI system (optional)
+     * @param attributes - Additional OpenTelemetry attributes (optional)
+     * @returns this
+     */
+    emitGenAIUserMessageEvent(body: LangWatchSpanGenAIUserMessageEventBody, system?: VAL_GEN_AI_SYSTEMS | (string & {}), attributes?: SemConvAttributes): void;
+    /**
+     * Emit a GenAI assistant/bot message event to the logger (including tool calls, if any).
+     * @param body - The event body (content, role, tool_calls)
+     * @param system - The GenAI system (optional)
+     * @param attributes - Additional OpenTelemetry attributes (optional)
+     * @returns this
+     */
+    emitGenAIAssistantMessageEvent(body: LangWatchSpanGenAIAssistantMessageEventBody, system?: VAL_GEN_AI_SYSTEMS | (string & {}), attributes?: SemConvAttributes): void;
+    /**
+     * Emit a GenAI tool/function message event to the logger (from a tool the assistant invoked).
+     * @param body - The event body (content, id, role)
+     * @param system - The GenAI system (optional)
+     * @param attributes - Additional OpenTelemetry attributes (optional)
+     * @returns this
+     */
+    emitGenAIToolMessageEvent(body: LangWatchSpanGenAIToolMessageEventBody, system?: VAL_GEN_AI_SYSTEMS | (string & {}), attributes?: SemConvAttributes): void;
+    /**
+     * Emit a GenAI choice event to the logger (a model output choice, finish reason, message).
+     * @param body - The event body (finish_reason, index, message)
+     * @param system - The GenAI system (optional)
+     * @param attributes - Additional OpenTelemetry attributes (optional)
+     * @returns this
+     */
+    emitGenAIChoiceEvent(body: LangWatchSpanGenAIChoiceEventBody, system?: VAL_GEN_AI_SYSTEMS | (string & {}), attributes?: SemConvAttributes): void;
+}
+
+/**
+ * @param name - The logger name (typically your service or module name).
+ * @param version - Optional logger version.
+ * @returns A {@link LangWatchLogger} instance, or a no-op logger if no provider was set.
+ */
+declare function getLangWatchLogger(name: string, version?: string): LangWatchLogger;
+/**
+ * @param loggerProvider - The OpenTelemetry logger provider to use.
+ * @param name - The name of the logger.
+ * @param version - Optional logger version.
+ * @returns A {@link LangWatchLogger} instance.
+ */
+declare function getLangWatchLoggerFromProvider(loggerProvider: LoggerProvider, name: string, version?: string): LangWatchLogger;
+
+/**
+ * @param name - Tracer name (service or library)
+ * @param version - Optional version identifier
+ * @returns A LangWatch tracer with enhanced functionality
+ */
+declare function getLangWatchTracer(name: string, version?: string): LangWatchTracer;
+/**
+ * @param tracerProvider - The OpenTelemetry tracer provider to use
+ * @param name - Tracer name (service or library)
+ * @param version - Optional version identifier
+ * @returns A LangWatch tracer with enhanced functionality
+ */
+declare function getLangWatchTracerFromProvider(tracerProvider: TracerProvider, name: string, version?: string): LangWatchTracer;
+
+export { FilterableBatchSpanProcessor as F, LangWatchTraceExporter as L, type SpanProcessingExcludeRule as S, getLangWatchTracer as a, type LangWatchTraceExporterOptions as b, type LangWatchLogger as c, getLangWatchLoggerFromProvider as d, getLangWatchTracerFromProvider as e, getLangWatchLogger as g };

package/dist/implementation-DJ-JveZl.d.ts

@@ -0,0 +1,261 @@
+import { BatchSpanProcessor, SpanExporter, ReadableSpan } from '@opentelemetry/sdk-trace-base';
+import { ExportResult } from '@opentelemetry/core';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-proto';
+import { CompressionAlgorithm } from '@opentelemetry/otlp-exporter-base';
+import { Logger, LogRecord, LoggerProvider } from '@opentelemetry/api-logs';
+import { V as VAL_GEN_AI_SYSTEMS, a as VAL_GEN_AI_FINISH_REASONS } from './values-1yj9l0Sa.js';
+import { b as SemConvLogRecordAttributes, a as SemConvAttributes } from './types-CoS5PmeU.js';
+import { TracerProvider } from '@opentelemetry/api';
+import { j as LangWatchTracer } from './types-CpT3iEIj.js';
+
+/**
+ * A BatchSpanProcessor subclass that filters spans before export by
+ * configurable rules -- spans matching any exclude rule are dropped.
+ * @module filterable-batch-span-exporter
+ */
+
+/**
+ * A rule for excluding spans from export, matched on `fieldName` by
+ * `matchOperation` against `matchValue`.
+ */
+interface SpanProcessingExcludeRule {
+    fieldName: "span_name" | "instrumentation_scope_name";
+    matchValue: string;
+    matchOperation: "includes" | "exact_match" | "starts_with" | "ends_with";
+}
+/**
+ * A BatchSpanProcessor that filters out spans matching any exclude rule
+ * before export — useful for dropping noisy spans like health checks.
+ */
+declare class FilterableBatchSpanProcessor extends BatchSpanProcessor {
+    private readonly _filters;
+    /**
+     * Create a new FilterableBatchSpanProcessor.
+     *
+     * @param exporter - The underlying SpanExporter to use for exporting spans.
+     * @param filters - An array of rules for excluding spans from export.
+     */
+    constructor(exporter: SpanExporter, filters: SpanProcessingExcludeRule[]);
+    /**
+     * Called when a span ends. If the span matches any exclude rule, it is dropped and not exported.
+     *
+     * @param span - The ReadableSpan that has ended.
+     */
+    onEnd(span: ReadableSpan): void;
+}
+
+interface Criteria {
+    instrumentationScopeName?: Match[];
+    name?: Match[];
+}
+interface Match {
+    equals?: string;
+    startsWith?: string;
+    matches?: RegExp;
+    ignoreCase?: boolean;
+}
+type TraceFilter = {
+    preset: "vercelAIOnly" | "excludeHttpRequests";
+} | {
+    include: Criteria;
+} | {
+    exclude: Criteria;
+};
+
+/** Options: endpoint URL, API key for auth, and optional span filters (default excludes HTTP). */
+interface LangWatchTraceExporterOptions {
+    endpoint?: string;
+    apiKey?: string;
+    /**
+     * Project identifier. Required when `apiKey` is a Personal Access Token
+     * (`pat-lw-*`); ignored for legacy `sk-lw-*` keys. Falls back to
+     * `LANGWATCH_PROJECT_ID`.
+     */
+    projectId?: string;
+    filters?: TraceFilter[] | null;
+    /** Request compression: gzip unless an OTEL_EXPORTER_OTLP_*COMPRESSION env var is set. */
+    compression?: CompressionAlgorithm;
+}
+
+/** Sends traces to LangWatch with auth; applies span filters (default excludes HTTP). */
+declare class LangWatchTraceExporter extends OTLPTraceExporter {
+    private readonly filters;
+    /** Configures auth from opts or environment; applies filters to span stream. */
+    constructor(opts?: LangWatchTraceExporterOptions);
+    export(spans: ReadableSpan[], resultCallback: (result: ExportResult) => void): void;
+}
+
+/** Body for a system message event in a GenAI span (a system/instruction to the model). */
+interface LangWatchSpanGenAISystemMessageEventBody {
+    /** Content of the system message */
+    content?: string;
+    /** Role of the message (system or instruction) */
+    role?: "system" | "instruction";
+}
+/** Body for a user message event in a GenAI span (a user/customer message to the model). */
+interface LangWatchSpanGenAIUserMessageEventBody {
+    /** Content of the user message */
+    content?: string;
+    /** Role of the message (user or customer) */
+    role?: "user" | "customer";
+}
+/** Body for an assistant message event in a GenAI span (a response, including tool calls). */
+interface LangWatchSpanGenAIAssistantMessageEventBody {
+    /** Content of the assistant message */
+    content?: string;
+    /** Role of the message (assistant or bot) */
+    role?: "assistant" | "bot";
+    /** Tool calls made by the assistant */
+    tool_calls?: {
+        function: {
+            /** Name of the function called */
+            name: string;
+            /** Arguments passed to the function */
+            arguments?: string;
+        };
+        /** Tool call identifier */
+        id: string;
+        /** Type of tool call */
+        type: "function";
+    }[];
+}
+/** Body for a tool message event in a GenAI span (a message from a tool the assistant invoked). */
+interface LangWatchSpanGenAIToolMessageEventBody {
+    /** Content of the tool message */
+    content?: string;
+    /** Tool call identifier */
+    id: string;
+    /** Role of the message (tool or function) */
+    role?: "tool" | "function";
+}
+/** Body for a choice event in a GenAI span (a model output choice, finish reason and message). */
+interface LangWatchSpanGenAIChoiceEventBody {
+    /** Reason the generation finished */
+    finish_reason: VAL_GEN_AI_FINISH_REASONS | (string & {});
+    /** Index of the choice */
+    index: number;
+    /** Message content for the choice */
+    message?: {
+        /** Content of the message */
+        content?: string;
+        /** Role of the message (assistant or bot) */
+        role?: "assistant" | "bot";
+        /** Tool calls made by the assistant */
+        tool_calls?: {
+            function: {
+                /** Name of the function called */
+                name: string;
+                /** Arguments passed to the function */
+                arguments?: string;
+            };
+            /** Tool call identifier */
+            id: string;
+            /** Type of tool call */
+            type: "function";
+        }[];
+    };
+}
+/**
+ * Extension of OpenTelemetry's LogRecord with LangWatch and GenAI-specific attributes.
+ */
+interface LangWatchLogRecord extends LogRecord {
+    /**
+     * Additional attributes to add to the log record.
+     *
+     * @default {}
+     */
+    attributes?: SemConvLogRecordAttributes;
+}
+/**
+ * Options for emitting a log record.
+ */
+interface EmitOptions {
+    /**
+     * Whether to omit the OTel context from the log record — standard OpenTelemetry
+     * omits it by default, so set this to avoid attaching context to every record.
+     * @default false
+     */
+    excludeContext?: boolean;
+}
+/**
+ * Extension of OpenTelemetry's Logger with LangWatch and GenAI-specific methods.
+ */
+interface LangWatchLogger extends Logger {
+    /**
+     * Emit a log record with LangWatch and GenAI-specific attributes.
+     *
+     * @param logRecord - The log record to emit
+     * @param options - Optional options for emitting the log record
+     */
+    emit(logRecord: LangWatchLogRecord, options?: EmitOptions): void;
+    /**
+     * Emit a GenAI system/instruction message event to the logger.
+     * @param body - The event body (content and role)
+     * @param system - The GenAI system (optional, e.g., 'openai', 'anthropic')
+     * @param attributes - Additional OpenTelemetry attributes (optional)
+     * @returns this
+     */
+    emitGenAISystemMessageEvent(body: LangWatchSpanGenAISystemMessageEventBody, system?: VAL_GEN_AI_SYSTEMS | (string & {}), attributes?: SemConvAttributes): void;
+    /**
+     * Emit a GenAI user/customer message event to the logger.
+     * @param body - The event body (content and role)
+     * @param system - The GenAI system (optional)
+     * @param attributes - Additional OpenTelemetry attributes (optional)
+     * @returns this
+     */
+    emitGenAIUserMessageEvent(body: LangWatchSpanGenAIUserMessageEventBody, system?: VAL_GEN_AI_SYSTEMS | (string & {}), attributes?: SemConvAttributes): void;
+    /**
+     * Emit a GenAI assistant/bot message event to the logger (including tool calls, if any).
+     * @param body - The event body (content, role, tool_calls)
+     * @param system - The GenAI system (optional)
+     * @param attributes - Additional OpenTelemetry attributes (optional)
+     * @returns this
+     */
+    emitGenAIAssistantMessageEvent(body: LangWatchSpanGenAIAssistantMessageEventBody, system?: VAL_GEN_AI_SYSTEMS | (string & {}), attributes?: SemConvAttributes): void;
+    /**
+     * Emit a GenAI tool/function message event to the logger (from a tool the assistant invoked).
+     * @param body - The event body (content, id, role)
+     * @param system - The GenAI system (optional)
+     * @param attributes - Additional OpenTelemetry attributes (optional)
+     * @returns this
+     */
+    emitGenAIToolMessageEvent(body: LangWatchSpanGenAIToolMessageEventBody, system?: VAL_GEN_AI_SYSTEMS | (string & {}), attributes?: SemConvAttributes): void;
+    /**
+     * Emit a GenAI choice event to the logger (a model output choice, finish reason, message).
+     * @param body - The event body (finish_reason, index, message)
+     * @param system - The GenAI system (optional)
+     * @param attributes - Additional OpenTelemetry attributes (optional)
+     * @returns this
+     */
+    emitGenAIChoiceEvent(body: LangWatchSpanGenAIChoiceEventBody, system?: VAL_GEN_AI_SYSTEMS | (string & {}), attributes?: SemConvAttributes): void;
+}
+
+/**
+ * @param name - The logger name (typically your service or module name).
+ * @param version - Optional logger version.
+ * @returns A {@link LangWatchLogger} instance, or a no-op logger if no provider was set.
+ */
+declare function getLangWatchLogger(name: string, version?: string): LangWatchLogger;
+/**
+ * @param loggerProvider - The OpenTelemetry logger provider to use.
+ * @param name - The name of the logger.
+ * @param version - Optional logger version.
+ * @returns A {@link LangWatchLogger} instance.
+ */
+declare function getLangWatchLoggerFromProvider(loggerProvider: LoggerProvider, name: string, version?: string): LangWatchLogger;
+
+/**
+ * @param name - Tracer name (service or library)
+ * @param version - Optional version identifier
+ * @returns A LangWatch tracer with enhanced functionality
+ */
+declare function getLangWatchTracer(name: string, version?: string): LangWatchTracer;
+/**
+ * @param tracerProvider - The OpenTelemetry tracer provider to use
+ * @param name - Tracer name (service or library)
+ * @param version - Optional version identifier
+ * @returns A LangWatch tracer with enhanced functionality
+ */
+declare function getLangWatchTracerFromProvider(tracerProvider: TracerProvider, name: string, version?: string): LangWatchTracer;
+
+export { FilterableBatchSpanProcessor as F, LangWatchTraceExporter as L, type SpanProcessingExcludeRule as S, getLangWatchTracer as a, type LangWatchTraceExporterOptions as b, type LangWatchLogger as c, getLangWatchLoggerFromProvider as d, getLangWatchTracerFromProvider as e, getLangWatchLogger as g };