@logtape/otel 1.2.1 → 1.2.3

package/dist/deno.cjs

@@ -1,7 +1,7 @@
 
 //#region deno.json
 var name = "@logtape/otel";
-var version = "1.2.1";
+var version = "1.2.3";
 var license = "MIT";
 var exports$1 = { ".": "./src/mod.ts" };
 var imports = {

package/dist/deno.js

@@ -1,6 +1,6 @@
 //#region deno.json
 var name = "@logtape/otel";
-var version = "1.2.1";
+var version = "1.2.3";
 var license = "MIT";
 var exports = { ".": "./src/mod.ts" };
 var imports = {

package/dist/deno.js.map

@@ -1 +1 @@
-{"version":3,"file":"deno.js","names":[],"sources":["../deno.json"],"sourcesContent":["{\n  \"name\": \"@logtape/otel\",\n  \"version\": \"1.2.1\",\n  \"license\": \"MIT\",\n  \"exports\": {\n    \".\": \"./src/mod.ts\"\n  },\n  \"imports\": {\n    \"@opentelemetry/api\": \"npm:@opentelemetry/api@^1.9.0\",\n    \"@opentelemetry/api-logs\": \"npm:@opentelemetry/api-logs@^0.202.0\",\n    \"@opentelemetry/exporter-logs-otlp-http\": \"npm:@opentelemetry/exporter-logs-otlp-http@^0.202.0\",\n    \"@opentelemetry/otlp-exporter-base\": \"npm:@opentelemetry/otlp-exporter-base@^0.202.0\",\n    \"@opentelemetry/resources\": \"npm:@opentelemetry/resources@^2.0.1\",\n    \"@opentelemetry/sdk-logs\": \"npm:@opentelemetry/sdk-logs@^0.202.0\",\n    \"@opentelemetry/semantic-conventions\": \"npm:@opentelemetry/semantic-conventions@^1.34.0\"\n  },\n  \"tasks\": {\n    \"build\": \"pnpm build\",\n    \"test\": \"deno test --allow-net --allow-env\"\n  }\n}\n"],"mappings":";WACU;cACG;cACA;cACA,EACT,KAAK,eACN;cACU;CACT,sBAAsB;CACtB,2BAA2B;CAC3B,0CAA0C;CAC1C,qCAAqC;CACrC,4BAA4B;CAC5B,2BAA2B;CAC3B,uCAAuC;AACxC;YACQ;CACP,SAAS;CACT,QAAQ;AACT;mBAnBH;;;;;;;AAoBC"}
+{"version":3,"file":"deno.js","names":[],"sources":["../deno.json"],"sourcesContent":["{\n  \"name\": \"@logtape/otel\",\n  \"version\": \"1.2.3\",\n  \"license\": \"MIT\",\n  \"exports\": {\n    \".\": \"./src/mod.ts\"\n  },\n  \"imports\": {\n    \"@opentelemetry/api\": \"npm:@opentelemetry/api@^1.9.0\",\n    \"@opentelemetry/api-logs\": \"npm:@opentelemetry/api-logs@^0.202.0\",\n    \"@opentelemetry/exporter-logs-otlp-http\": \"npm:@opentelemetry/exporter-logs-otlp-http@^0.202.0\",\n    \"@opentelemetry/otlp-exporter-base\": \"npm:@opentelemetry/otlp-exporter-base@^0.202.0\",\n    \"@opentelemetry/resources\": \"npm:@opentelemetry/resources@^2.0.1\",\n    \"@opentelemetry/sdk-logs\": \"npm:@opentelemetry/sdk-logs@^0.202.0\",\n    \"@opentelemetry/semantic-conventions\": \"npm:@opentelemetry/semantic-conventions@^1.34.0\"\n  },\n  \"tasks\": {\n    \"build\": \"pnpm build\",\n    \"test\": \"deno test --allow-net --allow-env\"\n  }\n}\n"],"mappings":";WACU;cACG;cACA;cACA,EACT,KAAK,eACN;cACU;CACT,sBAAsB;CACtB,2BAA2B;CAC3B,0CAA0C;CAC1C,qCAAqC;CACrC,4BAA4B;CAC5B,2BAA2B;CAC3B,uCAAuC;AACxC;YACQ;CACP,SAAS;CACT,QAAQ;AACT;mBAnBH;;;;;;;AAoBC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@logtape/otel",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "LogTape OpenTelemetry sink",
   "keywords": [
     "LogTape",
@@ -41,8 +41,11 @@
     "./package.json": "./package.json"
   },
   "sideEffects": false,
+  "files": [
+    "dist/"
+  ],
   "peerDependencies": {
-    "@logtape/logtape": "^1.2.1"
+    "@logtape/logtape": "^1.2.3"
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",

package/deno.json

@@ -1,21 +0,0 @@
-{
-  "name": "@logtape/otel",
-  "version": "1.2.1",
-  "license": "MIT",
-  "exports": {
-    ".": "./src/mod.ts"
-  },
-  "imports": {
-    "@opentelemetry/api": "npm:@opentelemetry/api@^1.9.0",
-    "@opentelemetry/api-logs": "npm:@opentelemetry/api-logs@^0.202.0",
-    "@opentelemetry/exporter-logs-otlp-http": "npm:@opentelemetry/exporter-logs-otlp-http@^0.202.0",
-    "@opentelemetry/otlp-exporter-base": "npm:@opentelemetry/otlp-exporter-base@^0.202.0",
-    "@opentelemetry/resources": "npm:@opentelemetry/resources@^2.0.1",
-    "@opentelemetry/sdk-logs": "npm:@opentelemetry/sdk-logs@^0.202.0",
-    "@opentelemetry/semantic-conventions": "npm:@opentelemetry/semantic-conventions@^1.34.0"
-  },
-  "tasks": {
-    "build": "pnpm build",
-    "test": "deno test --allow-net --allow-env"
-  }
-}

package/sample.ts

@@ -1,27 +0,0 @@
-import { configure, getConsoleSink, getLogger } from "@logtape/logtape";
-import { getOpenTelemetrySink } from "@logtape/otel";
-import "@std/dotenv/load";
-
-await configure({
-  sinks: {
-    console: getConsoleSink(),
-    otel: getOpenTelemetrySink({
-      messageType: "array",
-      diagnostics: true,
-    }),
-  },
-  filters: {},
-  loggers: [
-    { category: [], sinks: ["console", "otel"], lowestLevel: "debug" },
-  ],
-});
-
-getLogger(["test", "app"]).debug("hello {world} at {timestamp}", {
-  world: "debug",
-  timestamp: new Date(),
-});
-getLogger(["test", "app"]).info("hello {world} with {object}", {
-  world: "info",
-  object: new Uint8Array([1, 2, 3]),
-});
-getLogger(["test", "app"]).warn("hello {world}", { world: "warning" });

package/src/mod.test.ts

@@ -1,71 +0,0 @@
-// TODO: Add substantial tests for OpenTelemetry integration.
-// Current tests only verify basic browser compatibility and that the sink
-// can be created without errors. Future tests should include:
-// - Actual log record processing and OpenTelemetry output verification
-// - Integration with real OpenTelemetry collectors
-// - Message formatting and attribute handling
-// - Error handling scenarios
-// - Performance testing
-
-import { suite } from "@alinea/suite";
-import { assertEquals } from "@std/assert";
-import { getOpenTelemetrySink } from "./mod.ts";
-
-const test = suite(import.meta);
-
-test("getOpenTelemetrySink() creates sink without node:process dependency", () => {
-  // This test should pass in all environments (Deno, Node.js, browsers)
-  // without throwing errors about missing node:process
-  const sink = getOpenTelemetrySink();
-
-  assertEquals(typeof sink, "function");
-});
-
-test("getOpenTelemetrySink() works with explicit serviceName", () => {
-  const sink = getOpenTelemetrySink({
-    serviceName: "test-service",
-  });
-
-  assertEquals(typeof sink, "function");
-});
-
-test("getOpenTelemetrySink() handles missing environment variables gracefully", () => {
-  // Should not throw even if OTEL_SERVICE_NAME is not set
-  const sink = getOpenTelemetrySink({
-    // serviceName not provided, should fall back to env var
-  });
-
-  assertEquals(typeof sink, "function");
-});
-
-test("getOpenTelemetrySink() with diagnostics enabled", () => {
-  const sink = getOpenTelemetrySink({
-    diagnostics: true,
-  });
-
-  assertEquals(typeof sink, "function");
-});
-
-test("getOpenTelemetrySink() with custom messageType", () => {
-  const sink = getOpenTelemetrySink({
-    messageType: "array",
-  });
-
-  assertEquals(typeof sink, "function");
-});
-
-test("getOpenTelemetrySink() with custom objectRenderer", () => {
-  const sink = getOpenTelemetrySink({
-    objectRenderer: "json",
-  });
-
-  assertEquals(typeof sink, "function");
-});
-
-test("getOpenTelemetrySink() with custom bodyFormatter", () => {
-  const sink = getOpenTelemetrySink({
-    messageType: (message) => message.join(" "),
-  });
-
-  assertEquals(typeof sink, "function");
-});

package/src/mod.ts

@@ -1,369 +0,0 @@
-import {
-  getLogger,
-  type Logger,
-  type LogRecord,
-  type Sink,
-} from "@logtape/logtape";
-import { diag, type DiagLogger, DiagLogLevel } from "@opentelemetry/api";
-import {
-  type AnyValue,
-  type LoggerProvider as LoggerProviderBase,
-  type LogRecord as OTLogRecord,
-  SeverityNumber,
-} from "@opentelemetry/api-logs";
-import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
-import type { OTLPExporterNodeConfigBase } from "@opentelemetry/otlp-exporter-base";
-import {
-  defaultResource,
-  resourceFromAttributes,
-} from "@opentelemetry/resources";
-import {
-  LoggerProvider,
-  type LogRecordProcessor,
-  SimpleLogRecordProcessor,
-} from "@opentelemetry/sdk-logs";
-import { ATTR_SERVICE_NAME } from "@opentelemetry/semantic-conventions";
-import metadata from "../deno.json" with { type: "json" };
-
-/**
- * Gets an environment variable value across different JavaScript runtimes.
- * @param name The environment variable name.
- * @returns The environment variable value, or undefined if not found.
- */
-function getEnvironmentVariable(name: string): string | undefined {
-  // Deno runtime
-  if (typeof Deno !== "undefined" && Deno.env) {
-    try {
-      return Deno.env.get(name);
-    } catch {
-      // Deno.env.get() can throw if permissions are not granted
-      return undefined;
-    }
-  }
-
-  // Node.js/Bun runtime
-  if (
-    typeof globalThis !== "undefined" && "process" in globalThis &&
-    // @ts-ignore: process exists in Node.js/Bun
-    typeof globalThis.process !== "undefined" &&
-    // @ts-ignore: process.env exists in Node.js/Bun
-    typeof globalThis.process.env === "object" &&
-    // @ts-ignore: process.env exists in Node.js/Bun
-    globalThis.process.env !== null
-  ) {
-    // @ts-ignore: process.env exists in Node.js/Bun
-    return globalThis.process.env[name];
-  }
-
-  // Browser/other environments - no environment variables available
-  return undefined;
-}
-
-/**
- * The OpenTelemetry logger provider.
- */
-type ILoggerProvider = LoggerProviderBase & {
-  /**
-   * Adds a new {@link LogRecordProcessor} to this logger.
-   * @param processor the new LogRecordProcessor to be added.
-   */
-  addLogRecordProcessor(processor: LogRecordProcessor): void;
-
-  /**
-   * Flush all buffered data and shut down the LoggerProvider and all registered
-   * LogRecordProcessor.
-   *
-   * Returns a promise which is resolved when all flushes are complete.
-   */
-  shutdown?: () => Promise<void>;
-};
-
-/**
- * The way to render the object in the log record.  If `"json"`,
- * the object is rendered as a JSON string.  If `"inspect"`,
- * the object is rendered using `util.inspect` in Node.js/Bun, or
- * `Deno.inspect` in Deno.
- */
-export type ObjectRenderer = "json" | "inspect";
-
-type Message = (string | null | undefined)[];
-
-/**
- * Custom `body` attribute formatter.
- * @since 0.3.0
- */
-export type BodyFormatter = (message: Message) => AnyValue;
-
-/**
- * Options for creating an OpenTelemetry sink.
- */
-export interface OpenTelemetrySinkOptions {
-  /**
-   * The OpenTelemetry logger provider to use.
-   */
-  loggerProvider?: ILoggerProvider;
-
-  /**
-   * The way to render the message in the log record.  If `"string"`,
-   * the message is rendered as a single string with the values are
-   * interpolated into the message.  If `"array"`, the message is
-   * rendered as an array of strings.  `"string"` by default.
-   *
-   * Or even fully customizable with a {@link BodyFormatter} function.
-   * @since 0.2.0
-   */
-  messageType?: "string" | "array" | BodyFormatter;
-
-  /**
-   * The way to render the object in the log record.  If `"json"`,
-   * the object is rendered as a JSON string.  If `"inspect"`,
-   * the object is rendered using `util.inspect` in Node.js/Bun, or
-   * `Deno.inspect` in Deno.  `"inspect"` by default.
-   */
-  objectRenderer?: ObjectRenderer;
-
-  /**
-   * Whether to log diagnostics.  Diagnostic logs are logged to
-   * the `["logtape", "meta", "otel"]` category.
-   * Turned off by default.
-   */
-  diagnostics?: boolean;
-
-  /**
-   * The OpenTelemetry OTLP exporter configuration to use.
-   * Ignored if `loggerProvider` is provided.
-   */
-  otlpExporterConfig?: OTLPExporterNodeConfigBase;
-
-  /**
-   * The service name to use.  If not provided, the service name is
-   * taken from the `OTEL_SERVICE_NAME` environment variable.
-   * Ignored if `loggerProvider` is provided.
-   */
-  serviceName?: string;
-}
-
-/**
- * Creates a sink that forwards log records to OpenTelemetry.
- * @param options Options for creating the sink.
- * @returns The sink.
- */
-export function getOpenTelemetrySink(
-  options: OpenTelemetrySinkOptions = {},
-): Sink {
-  if (options.diagnostics) {
-    diag.setLogger(new DiagLoggerAdaptor(), DiagLogLevel.DEBUG);
-  }
-
-  let loggerProvider: ILoggerProvider;
-  if (options.loggerProvider == null) {
-    const resource = defaultResource().merge(
-      resourceFromAttributes({
-        [ATTR_SERVICE_NAME]: options.serviceName ??
-          getEnvironmentVariable("OTEL_SERVICE_NAME"),
-      }),
-    );
-    loggerProvider = new LoggerProvider({ resource });
-    const otlpExporter = new OTLPLogExporter(options.otlpExporterConfig);
-    loggerProvider.addLogRecordProcessor(
-      // @ts-ignore: it works anyway...
-      new SimpleLogRecordProcessor(otlpExporter),
-    );
-  } else {
-    loggerProvider = options.loggerProvider;
-  }
-  const objectRenderer = options.objectRenderer ?? "inspect";
-  const logger = loggerProvider.getLogger(metadata.name, metadata.version);
-  const sink = (record: LogRecord) => {
-    const { category, level, message, timestamp, properties } = record;
-    if (
-      category[0] === "logtape" && category[1] === "meta" &&
-      category[2] === "otel"
-    ) {
-      return;
-    }
-    const severityNumber = mapLevelToSeverityNumber(level);
-    const attributes = convertToAttributes(properties, objectRenderer);
-    attributes["category"] = [...category];
-    logger.emit(
-      {
-        severityNumber,
-        severityText: level,
-        body: typeof options.messageType === "function"
-          ? convertMessageToCustomBodyFormat(
-            message,
-            objectRenderer,
-            options.messageType,
-          )
-          : options.messageType === "array"
-          ? convertMessageToArray(message, objectRenderer)
-          : convertMessageToString(message, objectRenderer),
-        attributes,
-        timestamp: new Date(timestamp),
-      } satisfies OTLogRecord,
-    );
-  };
-  if (loggerProvider.shutdown != null) {
-    const shutdown = loggerProvider.shutdown.bind(loggerProvider);
-    sink[Symbol.asyncDispose] = shutdown;
-  }
-  return sink;
-}
-
-function mapLevelToSeverityNumber(level: string): number {
-  switch (level) {
-    case "trace":
-      return SeverityNumber.TRACE;
-    case "debug":
-      return SeverityNumber.DEBUG;
-    case "info":
-      return SeverityNumber.INFO;
-    case "warning":
-      return SeverityNumber.WARN;
-    case "error":
-      return SeverityNumber.ERROR;
-    case "fatal":
-      return SeverityNumber.FATAL;
-    default:
-      return SeverityNumber.UNSPECIFIED;
-  }
-}
-
-function convertToAttributes(
-  properties: Record<string, unknown>,
-  objectRenderer: ObjectRenderer,
-): Record<string, AnyValue> {
-  const attributes: Record<string, AnyValue> = {};
-  for (const [name, value] of Object.entries(properties)) {
-    const key = `attributes.${name}`;
-    if (value == null) continue;
-    if (Array.isArray(value)) {
-      let t = null;
-      for (const v of value) {
-        if (v == null) continue;
-        if (t != null && typeof v !== t) {
-          attributes[key] = value.map((v) =>
-            convertToString(v, objectRenderer)
-          );
-          break;
-        }
-        t = typeof v;
-      }
-      attributes[key] = value;
-    } else {
-      const encoded = convertToString(value, objectRenderer);
-      if (encoded == null) continue;
-      attributes[key] = encoded;
-    }
-  }
-  return attributes;
-}
-
-function convertToString(
-  value: unknown,
-  objectRenderer: ObjectRenderer,
-): string | null | undefined {
-  if (value === null || value === undefined || typeof value === "string") {
-    return value;
-  }
-  if (objectRenderer === "inspect") return inspect(value);
-  if (typeof value === "number" || typeof value === "boolean") {
-    return value.toString();
-  } else if (value instanceof Date) return value.toISOString();
-  else return JSON.stringify(value);
-}
-
-function convertMessageToArray(
-  message: readonly unknown[],
-  objectRenderer: ObjectRenderer,
-): AnyValue {
-  const body: (string | null | undefined)[] = [];
-  for (let i = 0; i < message.length; i += 2) {
-    const msg = message[i] as string;
-    body.push(msg);
-    if (message.length <= i + 1) break;
-    const val = message[i + 1];
-    body.push(convertToString(val, objectRenderer));
-  }
-  return body;
-}
-
-function convertMessageToString(
-  message: readonly unknown[],
-  objectRenderer: ObjectRenderer,
-): AnyValue {
-  let body = "";
-  for (let i = 0; i < message.length; i += 2) {
-    const msg = message[i] as string;
-    body += msg;
-    if (message.length <= i + 1) break;
-    const val = message[i + 1];
-    const extra = convertToString(val, objectRenderer);
-    body += extra ?? JSON.stringify(extra);
-  }
-  return body;
-}
-
-function convertMessageToCustomBodyFormat(
-  message: readonly unknown[],
-  objectRenderer: ObjectRenderer,
-  bodyFormatter: BodyFormatter,
-): AnyValue {
-  const body = message.map((msg) => convertToString(msg, objectRenderer));
-  return bodyFormatter(body);
-}
-
-/**
- * A platform-specific inspect function.  In Deno, this is {@link Deno.inspect},
- * and in Node.js/Bun it is {@link util.inspect}.  If neither is available, it
- * falls back to {@link JSON.stringify}.
- *
- * @param value The value to inspect.
- * @returns The string representation of the value.
- */
-const inspect: (value: unknown) => string =
-  // @ts-ignore: Deno global
-  "Deno" in globalThis && "inspect" in globalThis.Deno &&
-    // @ts-ignore: Deno global
-    typeof globalThis.Deno.inspect === "function"
-    // @ts-ignore: Deno global
-    ? globalThis.Deno.inspect
-    // @ts-ignore: Node.js global
-    : "util" in globalThis && "inspect" in globalThis.util &&
-        // @ts-ignore: Node.js global
-        globalThis.util.inspect === "function"
-    // @ts-ignore: Node.js global
-    ? globalThis.util.inspect
-    : JSON.stringify;
-
-class DiagLoggerAdaptor implements DiagLogger {
-  logger: Logger;
-
-  constructor() {
-    this.logger = getLogger(["logtape", "meta", "otel"]);
-  }
-
-  #escape(msg: string): string {
-    return msg.replaceAll("{", "{{").replaceAll("}", "}}");
-  }
-
-  error(msg: string, ...values: unknown[]): void {
-    this.logger.error(`${this.#escape(msg)}: {values}`, { values });
-  }
-
-  warn(msg: string, ...values: unknown[]): void {
-    this.logger.warn(`${this.#escape(msg)}: {values}`, { values });
-  }
-
-  info(msg: string, ...values: unknown[]): void {
-    this.logger.info(`${this.#escape(msg)}: {values}`, { values });
-  }
-
-  debug(msg: string, ...values: unknown[]): void {
-    this.logger.debug(`${this.#escape(msg)}: {values}`, { values });
-  }
-
-  verbose(msg: string, ...values: unknown[]): void {
-    this.logger.debug(`${this.#escape(msg)}: {values}`, { values });
-  }
-}

package/tsdown.config.ts

@@ -1,11 +0,0 @@
-import { defineConfig } from "tsdown";
-
-export default defineConfig({
-  entry: "src/mod.ts",
-  dts: {
-    sourcemap: true,
-  },
-  format: ["esm", "cjs"],
-  platform: "neutral",
-  unbundle: true,
-});