@alumnium/telemetry 0.0.0-stage → 0.24.0-alpha.2

package/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Alexey Rodionov, Tatiana Shepeleva
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -1,3 +1,3 @@
-# Temporary Holding Version
+# @alumnium/telemetry
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Alumnium OpenTelemetry trace and log exporters. See [the main `alumnium` package page](https://www.npmjs.com/package/alumnium) for more details.

package/package.json

@@ -1,6 +1,46 @@
 {
   "name": "@alumnium/telemetry",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.24.0-alpha.2",
+  "description": "Alumnium OpenTelemetry trace and log exporters",
+  "license": "MIT",
+  "author": "Alex Rodionov <p0deje@gmail.com>",
+  "contributors": [
+    "Alex Rodionov <p0deje@gmail.com>",
+    "Sasha Koss <koss@nocorp.me>",
+    "Tatiana Shepeleva <tati.shep@gmail.com>"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alumnium-hq/alumnium.git"
+  },
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE.md"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./src/index.d.ts",
+        "default": "./src/index.js"
+      },
+      "require": {
+        "types": "./src/index.d.ts",
+        "default": "./src/index.cjs"
+      }
+    }
+  },
+  "dependencies": {
+    "@logtape/logtape": "^2.0.2",
+    "@logtape/otel": "^2.0.5",
+    "@opentelemetry/exporter-logs-otlp-grpc": "^0.208.0",
+    "@opentelemetry/exporter-logs-otlp-http": "^0.208.0",
+    "@opentelemetry/exporter-logs-otlp-proto": "^0.208.0",
+    "@opentelemetry/exporter-trace-otlp-http": "^0.215.0",
+    "@opentelemetry/resources": "^2.7.0",
+    "@opentelemetry/sdk-logs": "^0.208.0",
+    "@opentelemetry/sdk-trace-base": "^2.7.0",
+    "@opentelemetry/sdk-trace-node": "^2.7.0"
+  }
+}

package/src/index.cjs

@@ -0,0 +1,103 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+function __accessProp(key) {
+  return this[key];
+}
+var __toCommonJS = (from) => {
+  var entry = (__moduleCache ??= new WeakMap()).get(from),
+    desc;
+  if (entry) return entry;
+  entry = __defProp({}, "__esModule", { value: true });
+  if ((from && typeof from === "object") || typeof from === "function") {
+    for (var key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(entry, key))
+        __defProp(entry, key, {
+          get: __accessProp.bind(from, key),
+          enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable,
+        });
+  }
+  __moduleCache.set(from, entry);
+  return entry;
+};
+var __moduleCache;
+var __returnValue = (v) => v;
+function __exportSetter(name, newValue) {
+  this[name] = __returnValue.bind(null, newValue);
+}
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {
+      get: all[name],
+      enumerable: true,
+      configurable: true,
+      set: __exportSetter.bind(all, name),
+    });
+};
+
+// telemetry/src/index.ts
+var exports_src = {};
+__export(exports_src, {
+  getLogSink: () => getLogSink,
+  startTracing: () => startTracing,
+});
+module.exports = __toCommonJS(exports_src);
+var import_otel = require("@logtape/otel");
+var import_exporter_logs_otlp_grpc = require("@opentelemetry/exporter-logs-otlp-grpc");
+var import_exporter_logs_otlp_http = require("@opentelemetry/exporter-logs-otlp-http");
+var import_exporter_logs_otlp_proto = require("@opentelemetry/exporter-logs-otlp-proto");
+var import_exporter_trace_otlp_http = require("@opentelemetry/exporter-trace-otlp-http");
+var import_resources = require("@opentelemetry/resources");
+var import_sdk_logs = require("@opentelemetry/sdk-logs");
+var import_sdk_trace_base = require("@opentelemetry/sdk-trace-base");
+var import_sdk_trace_node = require("@opentelemetry/sdk-trace-node");
+function startTracing(serviceName) {
+  const provider = new import_sdk_trace_node.NodeTracerProvider({
+    resource: import_resources.resourceFromAttributes({
+      "service.name": serviceName,
+    }),
+    spanProcessors: [
+      new import_sdk_trace_base.BatchSpanProcessor(
+        new import_exporter_trace_otlp_http.OTLPTraceExporter(),
+      ),
+    ],
+  });
+  provider.register();
+  return { flush: () => provider.forceFlush() };
+}
+function getLogSink(serviceName) {
+  if (!env("OTEL_EXPORTER_OTLP_LOGS_ENDPOINT", "OTEL_EXPORTER_OTLP_ENDPOINT"))
+    return () => {};
+  const loggerProvider = new import_sdk_logs.LoggerProvider({
+    resource: import_resources
+      .defaultResource()
+      .merge(
+        import_resources.resourceFromAttributes({
+          "service.name": serviceName,
+        }),
+      ),
+    processors: [
+      new import_sdk_logs.SimpleLogRecordProcessor(createLogExporter()),
+    ],
+  });
+  return import_otel.getOpenTelemetrySink({ loggerProvider });
+}
+function createLogExporter() {
+  switch (
+    env("OTEL_EXPORTER_OTLP_LOGS_PROTOCOL", "OTEL_EXPORTER_OTLP_PROTOCOL")
+  ) {
+    case "grpc":
+      return new import_exporter_logs_otlp_grpc.OTLPLogExporter();
+    case "http/protobuf":
+      return new import_exporter_logs_otlp_proto.OTLPLogExporter();
+    default:
+      return new import_exporter_logs_otlp_http.OTLPLogExporter();
+  }
+}
+function env(...names) {
+  return names.map((name) => process.env[name]).find(Boolean);
+}
+
+//# debugId=5988BC3DEE98F43864756E2164756E21
+//# sourceMappingURL=index.cjs.map

package/src/index.cjs.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../../telemetry/src/index.ts"],
+  "sourcesContent": [
+    "import type { Sink } from \"@logtape/logtape\";\nimport { getOpenTelemetrySink } from \"@logtape/otel\";\nimport { OTLPLogExporter as GrpcLogExporter } from \"@opentelemetry/exporter-logs-otlp-grpc\";\nimport { OTLPLogExporter as HttpLogExporter } from \"@opentelemetry/exporter-logs-otlp-http\";\nimport { OTLPLogExporter as ProtoLogExporter } from \"@opentelemetry/exporter-logs-otlp-proto\";\nimport { OTLPTraceExporter } from \"@opentelemetry/exporter-trace-otlp-http\";\nimport {\n  defaultResource,\n  resourceFromAttributes,\n} from \"@opentelemetry/resources\";\nimport {\n  LoggerProvider,\n  SimpleLogRecordProcessor,\n} from \"@opentelemetry/sdk-logs\";\nimport { BatchSpanProcessor } from \"@opentelemetry/sdk-trace-base\";\nimport { NodeTracerProvider } from \"@opentelemetry/sdk-trace-node\";\n\nexport interface Tracing {\n  /** Exports the pending spans. */\n  flush(): Promise<void>;\n}\n\n/**\n * Registers the global tracer provider, exporting spans over OTLP as\n * configured by the standard `OTEL_*` environment variables.\n */\nexport function startTracing(serviceName: string): Tracing {\n  const provider = new NodeTracerProvider({\n    resource: resourceFromAttributes({ \"service.name\": serviceName }),\n    spanProcessors: [new BatchSpanProcessor(new OTLPTraceExporter())],\n  });\n  provider.register();\n  return { flush: () => provider.forceFlush() };\n}\n\n/**\n * Creates a LogTape sink exporting logs over OTLP, when an OTLP endpoint is\n * configured.\n */\nexport function getLogSink(serviceName: string): Sink {\n  // NOTE: The exporter is created here rather than by `@logtape/otel`, which\n  // imports it by a dynamic specifier the Bun compiler can't bundle.\n  if (!env(\"OTEL_EXPORTER_OTLP_LOGS_ENDPOINT\", \"OTEL_EXPORTER_OTLP_ENDPOINT\"))\n    return () => {};\n  const loggerProvider = new LoggerProvider({\n    resource: defaultResource().merge(\n      resourceFromAttributes({ \"service.name\": serviceName }),\n    ),\n    processors: [new SimpleLogRecordProcessor(createLogExporter())],\n  });\n  return getOpenTelemetrySink({ loggerProvider });\n}\n\n/** Creates the log exporter for the configured OTLP protocol. */\nfunction createLogExporter() {\n  switch (\n    env(\"OTEL_EXPORTER_OTLP_LOGS_PROTOCOL\", \"OTEL_EXPORTER_OTLP_PROTOCOL\")\n  ) {\n    case \"grpc\":\n      return new GrpcLogExporter();\n    case \"http/protobuf\":\n      return new ProtoLogExporter();\n    default:\n      return new HttpLogExporter();\n  }\n}\n\nfunction env(...names: string[]): string | undefined {\n  // oxlint-disable-next-line no-process-env -- Reads the standard OTEL_* vars like the OpenTelemetry SDK, as this package doesn't depend on core's Env\n  return names.map((name) => process.env[name]).find(Boolean);\n}\n"
+  ],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACqC,IAArC;AACmD,IAAnD;AACmD,IAAnD;AACoD,IAApD;AACkC,IAAlC;AAIO,IAHP;AAOO,IAHP;AAImC,IAAnC;AACmC,IAAnC;AAWO,SAAS,YAAY,CAAC,aAA8B;AAAA,EACzD,MAAM,WAAW,IAAI,yCAAmB;AAAA,IACtC,UAAU,wCAAuB,EAAE,gBAAgB,YAAY,CAAC;AAAA,IAChE,gBAAgB,CAAC,IAAI,yCAAmB,IAAI,iDAAmB,CAAC;AAAA,EAClE,CAAC;AAAA,EACD,SAAS,SAAS;AAAA,EAClB,OAAO,EAAE,OAAO,MAAM,SAAS,WAAW,EAAE;AAAA;AAOvC,SAAS,UAAU,CAAC,aAA2B;AAAA,EAGpD,IAAI,CAAC,IAAI,oCAAoC,6BAA6B;AAAA,IACxE,OAAO,MAAM;AAAA,EACf,MAAM,iBAAiB,IAAI,+BAAe;AAAA,IACxC,UAAU,iCAAgB,EAAE,MAC1B,wCAAuB,EAAE,gBAAgB,YAAY,CAAC,CACxD;AAAA,IACA,YAAY,CAAC,IAAI,yCAAyB,kBAAkB,CAAC,CAAC;AAAA,EAChE,CAAC;AAAA,EACD,OAAO,iCAAqB,EAAE,eAAe,CAAC;AAAA;AAIhD,SAAS,iBAAiB,GAAG;AAAA,EAC3B,QACE,IAAI,oCAAoC,6BAA6B;AAAA,SAEhE;AAAA,MACH,OAAO,IAAI;AAAA,SACR;AAAA,MACH,OAAO,IAAI;AAAA;AAAA,MAEX,OAAO,IAAI;AAAA;AAAA;AAIjB,SAAS,GAAG,IAAI,OAAqC;AAAA,EAEnD,OAAO,MAAM,IAAI,CAAC,SAAS,QAAQ,IAAI,KAAK,EAAE,KAAK,OAAO;AAAA;",
+  "debugId": "5988BC3DEE98F43864756E2164756E21",
+  "names": []
+}

package/src/index.d.ts

@@ -0,0 +1,15 @@
+import type { Sink } from "@logtape/logtape";
+export interface Tracing {
+  /** Exports the pending spans. */
+  flush(): Promise<void>;
+}
+/**
+ * Registers the global tracer provider, exporting spans over OTLP as
+ * configured by the standard `OTEL_*` environment variables.
+ */
+export declare function startTracing(serviceName: string): Tracing;
+/**
+ * Creates a LogTape sink exporting logs over OTLP, when an OTLP endpoint is
+ * configured.
+ */
+export declare function getLogSink(serviceName: string): Sink;

package/src/index.js

@@ -0,0 +1,54 @@
+// telemetry/src/index.ts
+import { getOpenTelemetrySink } from "@logtape/otel";
+import { OTLPLogExporter as GrpcLogExporter } from "@opentelemetry/exporter-logs-otlp-grpc";
+import { OTLPLogExporter as HttpLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
+import { OTLPLogExporter as ProtoLogExporter } from "@opentelemetry/exporter-logs-otlp-proto";
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
+import {
+  defaultResource,
+  resourceFromAttributes,
+} from "@opentelemetry/resources";
+import {
+  LoggerProvider,
+  SimpleLogRecordProcessor,
+} from "@opentelemetry/sdk-logs";
+import { BatchSpanProcessor } from "@opentelemetry/sdk-trace-base";
+import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
+function startTracing(serviceName) {
+  const provider = new NodeTracerProvider({
+    resource: resourceFromAttributes({ "service.name": serviceName }),
+    spanProcessors: [new BatchSpanProcessor(new OTLPTraceExporter())],
+  });
+  provider.register();
+  return { flush: () => provider.forceFlush() };
+}
+function getLogSink(serviceName) {
+  if (!env("OTEL_EXPORTER_OTLP_LOGS_ENDPOINT", "OTEL_EXPORTER_OTLP_ENDPOINT"))
+    return () => {};
+  const loggerProvider = new LoggerProvider({
+    resource: defaultResource().merge(
+      resourceFromAttributes({ "service.name": serviceName }),
+    ),
+    processors: [new SimpleLogRecordProcessor(createLogExporter())],
+  });
+  return getOpenTelemetrySink({ loggerProvider });
+}
+function createLogExporter() {
+  switch (
+    env("OTEL_EXPORTER_OTLP_LOGS_PROTOCOL", "OTEL_EXPORTER_OTLP_PROTOCOL")
+  ) {
+    case "grpc":
+      return new GrpcLogExporter();
+    case "http/protobuf":
+      return new ProtoLogExporter();
+    default:
+      return new HttpLogExporter();
+  }
+}
+function env(...names) {
+  return names.map((name) => process.env[name]).find(Boolean);
+}
+export { getLogSink, startTracing };
+
+//# debugId=7D47D2EFB105F0F164756E2164756E21
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1,10 @@
+{
+  "version": 3,
+  "sources": ["../../telemetry/src/index.ts"],
+  "sourcesContent": [
+    "import type { Sink } from \"@logtape/logtape\";\nimport { getOpenTelemetrySink } from \"@logtape/otel\";\nimport { OTLPLogExporter as GrpcLogExporter } from \"@opentelemetry/exporter-logs-otlp-grpc\";\nimport { OTLPLogExporter as HttpLogExporter } from \"@opentelemetry/exporter-logs-otlp-http\";\nimport { OTLPLogExporter as ProtoLogExporter } from \"@opentelemetry/exporter-logs-otlp-proto\";\nimport { OTLPTraceExporter } from \"@opentelemetry/exporter-trace-otlp-http\";\nimport {\n  defaultResource,\n  resourceFromAttributes,\n} from \"@opentelemetry/resources\";\nimport {\n  LoggerProvider,\n  SimpleLogRecordProcessor,\n} from \"@opentelemetry/sdk-logs\";\nimport { BatchSpanProcessor } from \"@opentelemetry/sdk-trace-base\";\nimport { NodeTracerProvider } from \"@opentelemetry/sdk-trace-node\";\n\nexport interface Tracing {\n  /** Exports the pending spans. */\n  flush(): Promise<void>;\n}\n\n/**\n * Registers the global tracer provider, exporting spans over OTLP as\n * configured by the standard `OTEL_*` environment variables.\n */\nexport function startTracing(serviceName: string): Tracing {\n  const provider = new NodeTracerProvider({\n    resource: resourceFromAttributes({ \"service.name\": serviceName }),\n    spanProcessors: [new BatchSpanProcessor(new OTLPTraceExporter())],\n  });\n  provider.register();\n  return { flush: () => provider.forceFlush() };\n}\n\n/**\n * Creates a LogTape sink exporting logs over OTLP, when an OTLP endpoint is\n * configured.\n */\nexport function getLogSink(serviceName: string): Sink {\n  // NOTE: The exporter is created here rather than by `@logtape/otel`, which\n  // imports it by a dynamic specifier the Bun compiler can't bundle.\n  if (!env(\"OTEL_EXPORTER_OTLP_LOGS_ENDPOINT\", \"OTEL_EXPORTER_OTLP_ENDPOINT\"))\n    return () => {};\n  const loggerProvider = new LoggerProvider({\n    resource: defaultResource().merge(\n      resourceFromAttributes({ \"service.name\": serviceName }),\n    ),\n    processors: [new SimpleLogRecordProcessor(createLogExporter())],\n  });\n  return getOpenTelemetrySink({ loggerProvider });\n}\n\n/** Creates the log exporter for the configured OTLP protocol. */\nfunction createLogExporter() {\n  switch (\n    env(\"OTEL_EXPORTER_OTLP_LOGS_PROTOCOL\", \"OTEL_EXPORTER_OTLP_PROTOCOL\")\n  ) {\n    case \"grpc\":\n      return new GrpcLogExporter();\n    case \"http/protobuf\":\n      return new ProtoLogExporter();\n    default:\n      return new HttpLogExporter();\n  }\n}\n\nfunction env(...names: string[]): string | undefined {\n  // oxlint-disable-next-line no-process-env -- Reads the standard OTEL_* vars like the OpenTelemetry SDK, as this package doesn't depend on core's Env\n  return names.map((name) => process.env[name]).find(Boolean);\n}\n"
+  ],
+  "mappings": ";AACA;AACA,4BAAS;AACT,4BAAS;AACT,4BAAS;AACT;AACA;AAAA;AAAA;AAAA;AAIA;AAAA;AAAA;AAAA;AAIA;AACA;AAWO,SAAS,YAAY,CAAC,aAA8B;AAAA,EACzD,MAAM,WAAW,IAAI,mBAAmB;AAAA,IACtC,UAAU,uBAAuB,EAAE,gBAAgB,YAAY,CAAC;AAAA,IAChE,gBAAgB,CAAC,IAAI,mBAAmB,IAAI,iBAAmB,CAAC;AAAA,EAClE,CAAC;AAAA,EACD,SAAS,SAAS;AAAA,EAClB,OAAO,EAAE,OAAO,MAAM,SAAS,WAAW,EAAE;AAAA;AAOvC,SAAS,UAAU,CAAC,aAA2B;AAAA,EAGpD,IAAI,CAAC,IAAI,oCAAoC,6BAA6B;AAAA,IACxE,OAAO,MAAM;AAAA,EACf,MAAM,iBAAiB,IAAI,eAAe;AAAA,IACxC,UAAU,gBAAgB,EAAE,MAC1B,uBAAuB,EAAE,gBAAgB,YAAY,CAAC,CACxD;AAAA,IACA,YAAY,CAAC,IAAI,yBAAyB,kBAAkB,CAAC,CAAC;AAAA,EAChE,CAAC;AAAA,EACD,OAAO,qBAAqB,EAAE,eAAe,CAAC;AAAA;AAIhD,SAAS,iBAAiB,GAAG;AAAA,EAC3B,QACE,IAAI,oCAAoC,6BAA6B;AAAA,SAEhE;AAAA,MACH,OAAO,IAAI;AAAA,SACR;AAAA,MACH,OAAO,IAAI;AAAA;AAAA,MAEX,OAAO,IAAI;AAAA;AAAA;AAIjB,SAAS,GAAG,IAAI,OAAqC;AAAA,EAEnD,OAAO,MAAM,IAAI,CAAC,SAAS,QAAQ,IAAI,KAAK,EAAE,KAAK,OAAO;AAAA;",
+  "debugId": "7D47D2EFB105F0F164756E2164756E21",
+  "names": []
+}