@arizeai/phoenix-otel 0.0.1 → 0.1.0

package/dist/src/index.d.ts

@@ -1,3 +1,5 @@
 export { trace } from "@opentelemetry/api";
-export * from "./register";
+export { registerInstrumentations } from "@opentelemetry/instrumentation";
+export { type RegisterParams, register } from "./register";
+export { type Instrumentation } from "@opentelemetry/instrumentation";
 //# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAC1E,OAAO,EAAE,KAAK,cAAc,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3D,OAAO,EAAE,KAAK,eAAe,EAAE,MAAM,gCAAgC,CAAC"}

package/dist/src/index.js

@@ -1,21 +1,10 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.trace = void 0;
+exports.register = exports.registerInstrumentations = exports.trace = void 0;
 var api_1 = require("@opentelemetry/api");
 Object.defineProperty(exports, "trace", { enumerable: true, get: function () { return api_1.trace; } });
-__exportStar(require("./register"), exports);
+var instrumentation_1 = require("@opentelemetry/instrumentation");
+Object.defineProperty(exports, "registerInstrumentations", { enumerable: true, get: function () { return instrumentation_1.registerInstrumentations; } });
+var register_1 = require("./register");
+Object.defineProperty(exports, "register", { enumerable: true, get: function () { return register_1.register; } });
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,0CAA2C;AAAlC,4FAAA,KAAK,OAAA;AACd,6CAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,0CAA2C;AAAlC,4FAAA,KAAK,OAAA;AACd,kEAA0E;AAAjE,2HAAA,wBAAwB,OAAA;AACjC,uCAA2D;AAA7B,oGAAA,QAAQ,OAAA"}

package/dist/src/register.d.ts

@@ -1,12 +1,16 @@
 import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
-type RegisterParams = {
+import { Instrumentation } from "@opentelemetry/instrumentation";
+/**
+ * Configuration parameters for registering Phoenix OpenTelemetry tracing
+ */
+export type RegisterParams = {
     /**
      * The project the spans should be associated to
      * @default "default"
      */
     projectName?: string;
     /**
-     * the URL to the phoenix server. Can be postfixed with tracing path.
+     * The URL to the phoenix server. Can be postfixed with tracing path.
      * If not provided, environment variables are checked.
      * @example "https://app.phoenix.arize.com"
      */
@@ -22,18 +26,48 @@ type RegisterParams = {
      * @default true
      */
     batch?: boolean;
+    /**
+     * A list of instrumentation to register.
+     * Note: this may only work with commonjs projects. ESM projects will require manually applying instrumentation.
+     */
+    instrumentations?: Instrumentation[];
     /**
      * Whether to set the tracer as a global provider.
      * @default true
      */
-    setGlobalTracerProvider?: boolean;
+    global?: boolean;
 };
-export declare function register({ url: paramsUrl, apiKey: paramsApiKey, projectName, batch, setGlobalTracerProvider, }: RegisterParams): NodeTracerProvider;
 /**
- * A utility method to normalize the url to be http compatible.
- * Assumes we are using http over gRPC.
- * @param url the url to the phoenix server. May contain a slug
+ * Registers Phoenix OpenTelemetry tracing with the specified configuration
+ *
+ * @param params - Configuration parameters for Phoenix tracing
+ * @param params.url - The URL to the phoenix server. Can be postfixed with tracing path
+ * @param params.apiKey - The API key for the phoenix instance
+ * @param params.projectName - The project the spans should be associated to
+ * @param params.instrumentations - A list of instrumentation to register
+ * @param params.batch - Whether to use batching for span processing
+ * @param params.global - Whether to set the tracer as a global provider
+ * @returns {NodeTracerProvider} The configured NodeTracerProvider instance
+ *
+ * @example
+ * ```typescript
+ * import { register } from '@arizeai/phoenix-otel';
+ *
+ * const provider = register({
+ *   projectName: 'my-app',
+ *   url: 'https://app.phoenix.arize.com',
+ *   apiKey: 'your-api-key',
+ *   batch: true
+ * });
+ * ```
+ */
+export declare function register({ url: paramsUrl, apiKey: paramsApiKey, projectName, instrumentations, batch, global, }: RegisterParams): NodeTracerProvider;
+/**
+ * A utility method to normalize the URL to be HTTP compatible.
+ * Assumes we are using HTTP over gRPC and ensures the URL ends with the correct traces endpoint.
+ *
+ * @param url - The URL to the phoenix server. May contain a slug
+ * @returns {string} The normalized URL with the '/v1/traces' endpoint
  */
 export declare function ensureCollectorEndpoint(url: string): string;
-export {};
 //# sourceMappingURL=register.d.ts.map

package/dist/src/register.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../src/register.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,kBAAkB,EAEnB,MAAM,+BAA+B,CAAC;AAGvC,KAAK,cAAc,GAAG;IACpB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC,CAAC;AAEF,wBAAgB,QAAQ,CAAC,EACvB,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,YAAY,EACpB,WAAuB,EACvB,KAAY,EACZ,uBAA8B,GAC/B,EAAE,cAAc,sBA+BhB;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAK3D"}
+{"version":3,"file":"register.d.ts","sourceRoot":"","sources":["../../src/register.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,kBAAkB,EAEnB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EACL,eAAe,EAEhB,MAAM,gCAAgC,CAAC;AAExC;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,QAAQ,CAAC,EACvB,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,YAAY,EACpB,WAAuB,EACvB,gBAAgB,EAChB,KAAY,EACZ,MAAa,GACd,EAAE,cAAc,GAAG,kBAAkB,CAqCrC;AAED;;;;;;GAMG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAK3D"}

package/dist/src/register.js

@@ -8,7 +8,32 @@ const exporter_trace_otlp_proto_1 = require("@opentelemetry/exporter-trace-otlp-
 const resources_1 = require("@opentelemetry/resources");
 const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
 const config_1 = require("./config");
-function register({ url: paramsUrl, apiKey: paramsApiKey, projectName = "default", batch = true, setGlobalTracerProvider = true, }) {
+const instrumentation_1 = require("@opentelemetry/instrumentation");
+/**
+ * Registers Phoenix OpenTelemetry tracing with the specified configuration
+ *
+ * @param params - Configuration parameters for Phoenix tracing
+ * @param params.url - The URL to the phoenix server. Can be postfixed with tracing path
+ * @param params.apiKey - The API key for the phoenix instance
+ * @param params.projectName - The project the spans should be associated to
+ * @param params.instrumentations - A list of instrumentation to register
+ * @param params.batch - Whether to use batching for span processing
+ * @param params.global - Whether to set the tracer as a global provider
+ * @returns {NodeTracerProvider} The configured NodeTracerProvider instance
+ *
+ * @example
+ * ```typescript
+ * import { register } from '@arizeai/phoenix-otel';
+ *
+ * const provider = register({
+ *   projectName: 'my-app',
+ *   url: 'https://app.phoenix.arize.com',
+ *   apiKey: 'your-api-key',
+ *   batch: true
+ * });
+ * ```
+ */
+function register({ url: paramsUrl, apiKey: paramsApiKey, projectName = "default", instrumentations, batch = true, global = true, }) {
     const url = ensureCollectorEndpoint(paramsUrl || (0, config_1.getEnvCollectorURL)() || "http://localhost:6006");
     const apiKey = paramsApiKey || (0, config_1.getEnvApiKey)();
     const headers = {};
@@ -33,15 +58,23 @@ function register({ url: paramsUrl, apiKey: paramsApiKey, projectName = "default
         }),
         spanProcessors: [spanProcessor],
     });
-    if (setGlobalTracerProvider) {
+    if (instrumentations) {
+        (0, instrumentation_1.registerInstrumentations)({
+            instrumentations,
+            tracerProvider: provider,
+        });
+    }
+    if (global) {
         provider.register();
     }
     return provider;
 }
 /**
- * A utility method to normalize the url to be http compatible.
- * Assumes we are using http over gRPC.
- * @param url the url to the phoenix server. May contain a slug
+ * A utility method to normalize the URL to be HTTP compatible.
+ * Assumes we are using HTTP over gRPC and ensures the URL ends with the correct traces endpoint.
+ *
+ * @param url - The URL to the phoenix server. May contain a slug
+ * @returns {string} The normalized URL with the '/v1/traces' endpoint
  */
 function ensureCollectorEndpoint(url) {
     if (!url.includes("/v1/traces")) {

package/dist/src/register.js.map

@@ -1 +1 @@
-{"version":3,"file":"register.js","sourceRoot":"","sources":["../../src/register.ts"],"names":[],"mappings":";;AA2CA,4BAqCC;AAOD,0DAKC;AA5FD,oGAAuF;AACvF,wEAGuC;AACvC,wFAA6E;AAC7E,wDAAkE;AAClE,kEAGuC;AACvC,qCAA4D;AAgC5D,SAAgB,QAAQ,CAAC,EACvB,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,YAAY,EACpB,WAAW,GAAG,SAAS,EACvB,KAAK,GAAG,IAAI,EACZ,uBAAuB,GAAG,IAAI,GACf;IACf,MAAM,GAAG,GAAG,uBAAuB,CACjC,SAAS,IAAI,IAAA,2BAAkB,GAAE,IAAI,uBAAuB,CAC7D,CAAC;IACF,MAAM,MAAM,GAAG,YAAY,IAAI,IAAA,qBAAY,GAAE,CAAC;IAC9C,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,MAAM,gBAAgB,GAAG,OAAO,MAAM,IAAI,QAAQ,CAAC;IACnD,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,MAAM,EAAE,CAAC;IAChD,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,6CAAiB,CAAC;QACrC,GAAG;QACH,OAAO;KACR,CAAC,CAAC;IACH,IAAI,aAA4B,CAAC;IACjC,IAAI,KAAK,EAAE,CAAC;QACV,aAAa,GAAG,IAAI,sDAA+B,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IACpE,CAAC;SAAM,CAAC;QACN,aAAa,GAAG,IAAI,uDAAgC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IACrE,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,mCAAkB,CAAC;QACtC,QAAQ,EAAE,IAAA,kCAAsB,EAAC;YAC/B,CAAC,6DAAwB,CAAC,EAAE,WAAW;SACxC,CAAC;QACF,cAAc,EAAE,CAAC,aAAa,CAAC;KAChC,CAAC,CAAC;IAEH,IAAI,uBAAuB,EAAE,CAAC;QAC5B,QAAQ,CAAC,QAAQ,EAAE,CAAC;IACtB,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;GAIG;AACH,SAAgB,uBAAuB,CAAC,GAAW;IACjD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/C,CAAC;IACD,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;AACjC,CAAC"}
+{"version":3,"file":"register.js","sourceRoot":"","sources":["../../src/register.ts"],"names":[],"mappings":";;AA+EA,4BA4CC;AASD,0DAKC;AAzID,oGAAuF;AACvF,wEAGuC;AACvC,wFAA6E;AAC7E,wDAAkE;AAClE,kEAGuC;AACvC,qCAA4D;AAC5D,oEAGwC;AAwCxC;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,SAAgB,QAAQ,CAAC,EACvB,GAAG,EAAE,SAAS,EACd,MAAM,EAAE,YAAY,EACpB,WAAW,GAAG,SAAS,EACvB,gBAAgB,EAChB,KAAK,GAAG,IAAI,EACZ,MAAM,GAAG,IAAI,GACE;IACf,MAAM,GAAG,GAAG,uBAAuB,CACjC,SAAS,IAAI,IAAA,2BAAkB,GAAE,IAAI,uBAAuB,CAC7D,CAAC;IACF,MAAM,MAAM,GAAG,YAAY,IAAI,IAAA,qBAAY,GAAE,CAAC;IAC9C,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,MAAM,gBAAgB,GAAG,OAAO,MAAM,IAAI,QAAQ,CAAC;IACnD,IAAI,gBAAgB,EAAE,CAAC;QACrB,OAAO,CAAC,eAAe,CAAC,GAAG,UAAU,MAAM,EAAE,CAAC;IAChD,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,6CAAiB,CAAC;QACrC,GAAG;QACH,OAAO;KACR,CAAC,CAAC;IACH,IAAI,aAA4B,CAAC;IACjC,IAAI,KAAK,EAAE,CAAC;QACV,aAAa,GAAG,IAAI,sDAA+B,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IACpE,CAAC;SAAM,CAAC;QACN,aAAa,GAAG,IAAI,uDAAgC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IACrE,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,mCAAkB,CAAC;QACtC,QAAQ,EAAE,IAAA,kCAAsB,EAAC;YAC/B,CAAC,6DAAwB,CAAC,EAAE,WAAW;SACxC,CAAC;QACF,cAAc,EAAE,CAAC,aAAa,CAAC;KAChC,CAAC,CAAC;IAEH,IAAI,gBAAgB,EAAE,CAAC;QACrB,IAAA,0CAAwB,EAAC;YACvB,gBAAgB;YAChB,cAAc,EAAE,QAAQ;SACzB,CAAC,CAAC;IACL,CAAC;IACD,IAAI,MAAM,EAAE,CAAC;QACX,QAAQ,CAAC,QAAQ,EAAE,CAAC;IACtB,CAAC;IACD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,uBAAuB,CAAC,GAAW;IACjD,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,YAAY,CAAC,EAAE,CAAC;QAChC,OAAO,IAAI,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;IAC/C,CAAC;IACD,OAAO,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;AACjC,CAAC"}