@arizeai/phoenix-otel 0.1.0 → 0.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@arizeai/phoenix-otel",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Otel registration and convenience methods",
   "main": "dist/src/index.js",
   "module": "dist/esm/index.js",

package/src/createNoOpProvider.ts

@@ -0,0 +1,10 @@
+import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
+
+/**
+ * For dry runs we create a provider that doesn't export traces.
+ */
+export function createNoOpProvider() {
+  const provider = new NodeTracerProvider({});
+
+  return provider;
+}

package/src/index.ts

@@ -1,4 +1,15 @@
-export { trace } from "@opentelemetry/api";
+export {
+  trace,
+  context,
+  type DiagLogLevel,
+  type Tracer,
+  SpanStatusCode,
+} from "@opentelemetry/api";
 export { registerInstrumentations } from "@opentelemetry/instrumentation";
-export { type RegisterParams, register } from "./register";
 export { type Instrumentation } from "@opentelemetry/instrumentation";
+export { type NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
+
+// Phoenix abstractions
+export * from "./createNoOpProvider";
+export * from "./register";
+export * from "./utils";

package/src/register.ts

@@ -14,6 +14,9 @@ import {
   Instrumentation,
   registerInstrumentations,
 } from "@opentelemetry/instrumentation";
+import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";
+
+export type Headers = Record<string, string>;
 
 /**
  * Configuration parameters for registering Phoenix OpenTelemetry tracing
@@ -35,6 +38,10 @@ export type RegisterParams = {
    * If not provided, environment variables are checked.
    */
   apiKey?: string;
+  /**
+   * Headers to be used when communicating with the OTLP collector
+   */
+  headers?: Headers;
   /**
    * Whether to use batching for span processing.
    * It is recommended to use batching in production environments
@@ -51,6 +58,11 @@ export type RegisterParams = {
    * @default true
    */
   global?: boolean;
+  /**
+   * The diag log level to set for the built in DiagConsoleLogger instance.
+   * Omit to disable built in logging.
+   */
+  diagLogLevel?: DiagLogLevel;
 };
 
 /**
@@ -63,6 +75,7 @@ export type RegisterParams = {
  * @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
+ * @param params.diagLogLevel - the diagnostics log level
  * @returns {NodeTracerProvider} The configured NodeTracerProvider instance
  *
  * @example
@@ -80,16 +93,23 @@ export type RegisterParams = {
 export function register({
   url: paramsUrl,
   apiKey: paramsApiKey,
+  headers: paramsHeaders = {},
   projectName = "default",
   instrumentations,
   batch = true,
   global = true,
+  diagLogLevel,
 }: RegisterParams): NodeTracerProvider {
+  if (diagLogLevel) {
+    diag.setLogger(new DiagConsoleLogger(), diagLogLevel);
+  }
   const url = ensureCollectorEndpoint(
     paramsUrl || getEnvCollectorURL() || "http://localhost:6006"
   );
   const apiKey = paramsApiKey || getEnvApiKey();
-  const headers: Record<string, string> = {};
+  const headers: Headers = Array.isArray(paramsHeaders)
+    ? Object.fromEntries(paramsHeaders)
+    : paramsHeaders;
   const configureHeaders = typeof apiKey == "string";
   if (configureHeaders) {
     headers["authorization"] = `Bearer ${apiKey}`;

package/src/utils.ts

@@ -0,0 +1,9 @@
+import { AttributeValue } from "@opentelemetry/api";
+
+export function objectAsAttributes<T extends Record<string, unknown>>(
+  obj: T
+): Record<string, AttributeValue> {
+  return Object.fromEntries(
+    Object.entries(obj).filter(([_, value]) => value !== null)
+  ) as Record<string, AttributeValue>;
+}