openlit 1.0.0

package/src/semantic-convention.ts

@@ -0,0 +1,113 @@
+export default class SemanticConvention {
+  // GenAI General
+  static GEN_AI_ENDPOINT = 'gen_ai.endpoint';
+  static GEN_AI_SYSTEM = 'gen_ai.system';
+  static GEN_AI_ENVIRONMENT = 'gen_ai.environment';
+  static GEN_AI_APPLICATION_NAME = 'gen_ai.application_name';
+  static GEN_AI_TYPE = 'gen_ai.type';
+  static GEN_AI_HUB_OWNER = 'gen_ai.hub.owner';
+  static GEN_AI_HUB_REPO = 'gen_ai.hub.repo';
+  static GEN_AI_RETRIEVAL_SOURCE = 'gen_ai.retrieval.source';
+  static GEN_AI_REQUESTS = 'gen_ai.total.requests';
+
+  // GenAI Request
+  static GEN_AI_REQUEST_MODEL = 'gen_ai.request.model';
+  static GEN_AI_REQUEST_TEMPERATURE = 'gen_ai.request.temperature';
+  static GEN_AI_REQUEST_TOP_P = 'gen_ai.request.top_p';
+  static GEN_AI_REQUEST_TOP_K = 'gen_ai.request.top_k';
+  static GEN_AI_REQUEST_MAX_TOKENS = 'gen_ai.request.max_tokens';
+  static GEN_AI_REQUEST_IS_STREAM = 'gen_ai.request.is_stream';
+  static GEN_AI_REQUEST_USER = 'gen_ai.request.user';
+  static GEN_AI_REQUEST_SEED = 'gen_ai.request.seed';
+  static GEN_AI_REQUEST_FREQUENCY_PENALTY = 'gen_ai.request.frequency_penalty';
+  static GEN_AI_REQUEST_PRESENCE_PENALTY = 'gen_ai.request.presence_penalty';
+  static GEN_AI_REQUEST_EMBEDDING_FORMAT = 'gen_ai.request.embedding_format';
+  static GEN_AI_REQUEST_EMBEDDING_DIMENSION = 'gen_ai.request.embedding_dimension';
+  static GEN_AI_REQUEST_TOOL_CHOICE = 'gen_ai.request.tool_choice';
+  static GEN_AI_REQUEST_AUDIO_VOICE = 'gen_ai.request.audio_voice';
+  static GEN_AI_REQUEST_AUDIO_RESPONSE_FORMAT = 'gen_ai.request.audio_response_format';
+  static GEN_AI_REQUEST_AUDIO_SPEED = 'gen_ai.request.audio_speed';
+  static GEN_AI_REQUEST_FINETUNE_STATUS = 'gen_ai.request.fine_tune_status';
+  static GEN_AI_REQUEST_FINETUNE_MODEL_SUFFIX = 'gen_ai.request.fine_tune_model_suffix';
+  static GEN_AI_REQUEST_FINETUNE_MODEL_EPOCHS = 'gen_ai.request.fine_tune_n_epochs';
+  static GEN_AI_REQUEST_FINETUNE_MODEL_LRM = 'gen_ai.request.learning_rate_multiplier';
+  static GEN_AI_REQUEST_FINETUNE_BATCH_SIZE = 'gen_ai.request.fine_tune_batch_size';
+  static GEN_AI_REQUEST_VALIDATION_FILE = 'gen_ai.request.validation_file';
+  static GEN_AI_REQUEST_TRAINING_FILE = 'gen_ai.request.training_file';
+
+  static GEN_AI_REQUEST_IMAGE_SIZE = 'gen_ai.request.image_size';
+  static GEN_AI_REQUEST_IMAGE_QUALITY = 'gen_ai.request.image_quality';
+  static GEN_AI_REQUEST_IMAGE_STYLE = 'gen_ai.request.image_style';
+
+  // GenAI Usage
+  static GEN_AI_USAGE_PROMPT_TOKENS = 'gen_ai.usage.input_tokens';
+  static GEN_AI_USAGE_COMPLETION_TOKENS = 'gen_ai.usage.output_tokens';
+  static GEN_AI_USAGE_TOTAL_TOKENS = 'gen_ai.usage.total_tokens';
+  static GEN_AI_USAGE_COST = 'gen_ai.usage.cost';
+
+  // GenAI Response
+  static GEN_AI_RESPONSE_ID = 'gen_ai.response.id';
+  static GEN_AI_RESPONSE_FINISH_REASON = 'gen_ai.response.finish_reason';
+  static GEN_AI_RESPONSE_IMAGE = 'gen_ai.response.image'; // Not used directly in code yet
+  static GEN_AI_RESPONSE_IMAGE_SIZE = 'gen_ai.request.image_size';
+  static GEN_AI_RESPONSE_IMAGE_QUALITY = 'gen_ai.request.image_quality';
+  static GEN_AI_RESPONSE_IMAGE_STYLE = 'gen_ai.request.image_style';
+
+  // GenAI Content
+  static GEN_AI_CONTENT_PROMPT = 'gen_ai.content.prompt';
+  static GEN_AI_CONTENT_COMPLETION = 'gen_ai.completion';
+  static GEN_AI_CONTENT_REVISED_PROMPT = 'gen_ai.content.revised_prompt';
+
+  static GEN_AI_TYPE_CHAT = 'chat';
+  static GEN_AI_TYPE_EMBEDDING = 'embedding';
+  static GEN_AI_TYPE_IMAGE = 'image';
+  static GEN_AI_TYPE_AUDIO = 'audio';
+  static GEN_AI_TYPE_FINETUNING = 'fine_tuning';
+  static GEN_AI_TYPE_VECTORDB = 'vectordb';
+  static GEN_AI_TYPE_FRAMEWORK = 'framework';
+
+  static GEN_AI_SYSTEM_HUGGING_FACE = 'huggingface';
+  static GEN_AI_SYSTEM_OPENAI = 'openai';
+  static GEN_AI_SYSTEM_AZURE_OPENAI = 'azure_openai';
+  static GEN_AI_SYSTEM_ANTHROPIC = 'anthropic';
+  static GEN_AI_SYSTEM_COHERE = 'cohere';
+  static GEN_AI_SYSTEM_MISTRAL = 'mistral';
+  static GEN_AI_SYSTEM_BEDROCK = 'bedrock';
+  static GEN_AI_SYSTEM_VERTEXAI = 'vertexai';
+  static GEN_AI_SYSTEM_LANGCHAIN = 'langchain';
+
+  // Vector DB
+  static DB_REQUESTS = 'db.total.requests';
+  static DB_SYSTEM = 'db.system';
+  static DB_SYSTEM_CHROMA = 'chroma';
+  static DB_SYSTEM_PINECONE = 'pinecone';
+  static DB_COLLECTION_NAME = 'db.collection.name';
+  static DB_OPERATION = 'db.operation';
+  static DB_OPERATION_CREATE_INDEX = 'create_index';
+  static DB_OPERATION_QUERY = 'query';
+  static DB_OPERATION_DELETE = 'delete';
+  static DB_OPERATION_UPDATE = 'update';
+  static DB_OPERATION_UPSERT = 'upsert';
+  static DB_OPERATION_GET = 'get';
+  static DB_OPERATION_ADD = 'add';
+  static DB_OPERATION_PEEK = 'peek';
+  static DB_ID_COUNT = 'db.ids_count';
+  static DB_VECTOR_COUNT = 'db.vector_count';
+  static DB_METADATA_COUNT = 'db.metadatas_count';
+  static DB_DOCUMENTS_COUNT = 'db.documents_count';
+  static DB_QUERY_LIMIT = 'db.limit';
+  static DB_OFFSET = 'db.offset';
+  static DB_WHERE_DOCUMENT = 'db.where_document';
+  static DB_FILTER = 'db.filter';
+  static DB_STATEMENT = 'db.statement';
+  static DB_N_RESULTS = 'db.n_results';
+  static DB_DELETE_ALL = 'db.delete_all';
+  static DB_INDEX_NAME = 'db.create_index.name';
+  static DB_INDEX_DIMENSION = 'db.create_index.dimensions';
+  static DB_INDEX_METRIC = 'db.create_index.metric';
+  static DB_INDEX_SPEC = 'db.create_index.spec';
+  static DB_NAMESPACE = 'db.query.namespace';
+  static DB_UPDATE_METADATA = 'db.update.metadata';
+  static DB_UPDATE_VALUES = 'db.update.values';
+  static DB_UPDATE_ID = 'db.update.id';
+}

package/src/tracing.ts

@@ -0,0 +1,59 @@
+import { SetupTracerOptions } from './types';
+import {
+  NodeTracerProvider,
+  BatchSpanProcessor,
+  ConsoleSpanExporter,
+  SimpleSpanProcessor,
+  SpanExporter,
+} from '@opentelemetry/sdk-trace-node';
+import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http';
+
+import Instrumentations from './instrumentation';
+import OpenlitConfig from './config';
+
+export default class Tracing {
+  static traceProvider: NodeTracerProvider;
+  static traceExporter: OTLPTraceExporter;
+  static async setup(options: SetupTracerOptions) {
+    if (options.tracer) return options.tracer;
+    try {
+      this.traceProvider = new NodeTracerProvider({
+        resource: options.resource,
+      });
+
+      OpenlitConfig.updateConfig({
+        ...options,
+        tracer: options.tracer || Tracing.traceProvider,
+      });
+
+      Instrumentations.setup(
+        Tracing.traceProvider,
+        options?.disabledInstrumentations,
+        options?.instrumentations
+      );
+
+      const consoleSpanExporter = new ConsoleSpanExporter();
+
+      // Adding span to console
+      this.traceProvider.addSpanProcessor(new SimpleSpanProcessor(consoleSpanExporter));
+
+      this.traceExporter = new OTLPTraceExporter({
+        url: options.otlpEndpoint,
+        headers: options.otlpHeaders as Record<string, unknown> | undefined,
+      });
+      if (options.disableBatch) {
+        this.traceProvider.addSpanProcessor(
+          new SimpleSpanProcessor(this.traceExporter as SpanExporter)
+        );
+      } else {
+        this.traceProvider.addSpanProcessor(
+          new BatchSpanProcessor(this.traceExporter as SpanExporter)
+        );
+      }
+
+      this.traceProvider.register();
+    } catch (e) {
+      return null;
+    }
+  }
+}

package/src/types.ts

@@ -0,0 +1,48 @@
+// import { Instrumentation } from '@opentelemetry/instrumentation';
+import { Resource } from '@opentelemetry/resources';
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
+
+export type InstrumentationType = 'openai' | 'anthropic';
+
+export type OpenlitInstrumentations = Partial<Record<InstrumentationType, any>>;
+
+export type PricingObject = Record<string, Record<string, unknown>>;
+
+/**
+ *     environment (string): Deployment environment of the application.
+ *     applicationName (string): Name of the application using openLIT.
+ *     pricingInfo (Object): Pricing information.
+ *     tracer (any): Tracer instance for OpenTelemetry.
+ *     otlpEndpoint (string): Endpoint for OTLP.
+ *     otlpHeaders (Object): Headers for OTLP.
+ *     disableBatch (boolean): Flag to disable batch span processing in tracing.
+ *     traceContent (boolean): Flag to enable or disable tracing of content.
+ */
+export interface OpenlitConfigInterface {
+  environment?: string;
+  applicationName?: string;
+  pricingInfo?: PricingObject;
+  tracer: NodeTracerProvider;
+  otlpEndpoint?: string;
+  otlpHeaders?: Record<string, unknown>;
+  disableBatch?: boolean;
+  traceContent?: boolean;
+  pricing_json?: string | PricingObject;
+}
+
+export type OpenlitOptions = {
+  environment?: OpenlitConfigInterface['environment'];
+  applicationName?: OpenlitConfigInterface['applicationName'];
+  tracer?: OpenlitConfigInterface['tracer'];
+  otlpEndpoint?: OpenlitConfigInterface['otlpEndpoint'];
+  otlpHeaders?: OpenlitConfigInterface['otlpHeaders'];
+  disableBatch?: OpenlitConfigInterface['disableBatch'];
+  traceContent?: OpenlitConfigInterface['traceContent'];
+  disabledInstrumentations?: string[];
+  instrumentations?: OpenlitInstrumentations;
+  pricing_json?: OpenlitConfigInterface['pricing_json'];
+};
+
+export type SetupTracerOptions = OpenlitOptions & {
+  resource: Resource;
+};

package/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es2016",
+    "module": "commonjs",
+    "resolveJsonModule": true,
+    "outDir": "./dist",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    },
+    "strict": true,
+    "skipLibCheck": true
+  }
+}