spanport 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,57 @@
-# Temporary Holding Version
+# spanport (Node.js SDK)
 
-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.
+Send your Node.js app's logs to Spanport. Keep logging the way you already do.
+
+```bash
+npm install spanport
+```
+
+```js
+import * as spanport from "spanport";
+
+spanport.init({
+  // From: python -m spanport_server.cli create-data-key
+  dataKey: "sp_ingest_...",
+  service: "orders-api",
+  // Defaults: http://localhost:4318 and http://localhost:8000
+  collectorUrl: "https://spanport-collector.example.com",
+  serverUrl: "https://spanport.example.com",
+});
+
+console.error("Payment failed for order 1042"); // sent automatically
+```
+
+**pino and winston** write JSON lines to `spanport.logStream()`:
+
+```js
+import pino from "pino";
+const logger = pino(pino.multistream([{ stream: process.stdout }, { stream: spanport.logStream() }]));
+
+import winston from "winston";
+const logger = winston.createLogger({
+  format: winston.format.combine(winston.format.timestamp(), winston.format.json()),
+  transports: [
+    new winston.transports.Console(),
+    new winston.transports.Stream({ stream: spanport.logStream() }),
+  ],
+});
+```
+
+- **`console.debug/log/info/warn/error` are sent automatically**; what your app prints doesn't change. Turn this off with `captureConsole: false`.
+- **Logs are sent in the background**, in batches. A normal exit sends what is left; on `SIGTERM`, call `await spanport.shutdown()` first.
+- **Logs inside an OpenTelemetry span** carry its `trace_id` and `span_id`; so do pino lines that include them.
+- **Wrong key?** At start-up the SDK asks the server once whether the key is valid and prints a clear error on stderr if not. Pass `checkKey: false` if the app cannot reach the server.
+- **Use `https://` for anything beyond your own machine or Docker network.** The data key is sent with every batch.
+- **It never breaks your app.** `init()` never throws; problems are printed on stderr as `spanport: ...` and the app carries on.
+
+Node.js 22.15 or newer. ES module; CommonJS apps can `require("spanport")`.
+
+## Development
+
+```bash
+npm install
+npm test
+npm run lint
+npm run typecheck
+npm run build
+```

package/dist/consoleCapture.d.ts

@@ -0,0 +1,14 @@
+/** Copies console.debug/log/info/warn/error calls to Spanport. The app's console output is unchanged. */
+import { type ConsoleMethod } from "./severity.js";
+/**
+ * Wrap the console methods so each call is also passed to `onLog`.
+ *
+ * The original method always runs first. A failure in `onLog` is ignored on purpose: the app's
+ * console must keep working whatever happens to Spanport. A call made while `onLog` is running
+ * (e.g. by an exporter that logs) is not passed on again, so it can't loop.
+ *
+ * @param onLog - Receives the method and the formatted message, as console would print it.
+ * @returns A function that puts the original console methods back.
+ */
+export declare function captureConsole(onLog: (method: ConsoleMethod, message: string) => void): () => void;
+//# sourceMappingURL=consoleCapture.d.ts.map

package/dist/consoleCapture.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"consoleCapture.d.ts","sourceRoot":"","sources":["../src/consoleCapture.ts"],"names":[],"mappings":"AAAA,yGAAyG;AAKzG,OAAO,EAAE,KAAK,aAAa,EAAE,MAAM,eAAe,CAAC;AAInD;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,KAAK,EAAE,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,GAAG,MAAM,IAAI,CAwBlG"}

package/dist/consoleCapture.js

@@ -0,0 +1,44 @@
+/** Copies console.debug/log/info/warn/error calls to Spanport. The app's console output is unchanged. */
+import { format } from "node:util";
+import { CAPTURED_CONSOLE_METHODS } from "./constants.js";
+import {} from "./severity.js";
+/**
+ * Wrap the console methods so each call is also passed to `onLog`.
+ *
+ * The original method always runs first. A failure in `onLog` is ignored on purpose: the app's
+ * console must keep working whatever happens to Spanport. A call made while `onLog` is running
+ * (e.g. by an exporter that logs) is not passed on again, so it can't loop.
+ *
+ * @param onLog - Receives the method and the formatted message, as console would print it.
+ * @returns A function that puts the original console methods back.
+ */
+export function captureConsole(onLog) {
+    const originals = new Map();
+    let passingOn = false;
+    for (const method of CAPTURED_CONSOLE_METHODS) {
+        // Kept as-is so restore puts back the exact original; always called with console as `this`.
+        // eslint-disable-next-line @typescript-eslint/unbound-method
+        const original = console[method];
+        originals.set(method, original);
+        console[method] = (...args) => {
+            original.apply(console, args);
+            if (passingOn)
+                return;
+            passingOn = true;
+            try {
+                onLog(method, format(...args));
+            }
+            catch {
+                // Never let Spanport break the app's console.
+            }
+            finally {
+                passingOn = false;
+            }
+        };
+    }
+    return () => {
+        for (const [method, original] of originals)
+            console[method] = original;
+    };
+}
+//# sourceMappingURL=consoleCapture.js.map

package/dist/consoleCapture.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"consoleCapture.js","sourceRoot":"","sources":["../src/consoleCapture.ts"],"names":[],"mappings":"AAAA,yGAAyG;AAEzG,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,wBAAwB,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EAAsB,MAAM,eAAe,CAAC;AAInD;;;;;;;;;GASG;AACH,MAAM,UAAU,cAAc,CAAC,KAAuD;IACpF,MAAM,SAAS,GAAG,IAAI,GAAG,EAAkC,CAAC;IAC5D,IAAI,SAAS,GAAG,KAAK,CAAC;IACtB,KAAK,MAAM,MAAM,IAAI,wBAAwB,EAAE,CAAC;QAC9C,4FAA4F;QAC5F,6DAA6D;QAC7D,MAAM,QAAQ,GAAoB,OAAO,CAAC,MAAM,CAAC,CAAC;QAClD,SAAS,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;QAChC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,IAAe,EAAQ,EAAE;YAC7C,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YAC9B,IAAI,SAAS;gBAAE,OAAO;YACtB,SAAS,GAAG,IAAI,CAAC;YACjB,IAAI,CAAC;gBACH,KAAK,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;YACjC,CAAC;YAAC,MAAM,CAAC;gBACP,8CAA8C;YAChD,CAAC;oBAAS,CAAC;gBACT,SAAS,GAAG,KAAK,CAAC;YACpB,CAAC;QACH,CAAC,CAAC;IACJ,CAAC;IACD,OAAO,GAAG,EAAE;QACV,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,SAAS;YAAE,OAAO,CAAC,MAAM,CAAC,GAAG,QAAQ,CAAC;IACzE,CAAC,CAAC;AACJ,CAAC"}

package/dist/constants.d.ts

@@ -0,0 +1,38 @@
+/** SDK constants. Code refers to these by name, never by inline value. */
+export declare const DATA_KEY_PREFIX = "sp_ingest_";
+export declare const DEFAULT_COLLECTOR_URL = "http://localhost:4318";
+export declare const DEFAULT_SERVER_URL = "http://localhost:8000";
+export declare const OTLP_LOGS_PATH = "/v1/logs";
+export declare const CURRENT_API_KEY_PATH = "/api/v1/api-keys/current";
+export declare const AUTHORIZATION_HEADER = "Authorization";
+export declare const BEARER_PREFIX = "Bearer ";
+export declare const ALLOWED_URL_PROTOCOLS: readonly string[];
+export declare const KEY_CHECK_TIMEOUT_MS = 5000;
+export declare const VISIBLE_KEY_SUFFIX_LENGTH = 4;
+export declare const HTTP_UNAUTHORIZED = 401;
+/** console methods the SDK copies to Spanport; the original output is unchanged. */
+export declare const CAPTURED_CONSOLE_METHODS: readonly ["debug", "log", "info", "warn", "error"];
+/** pino's numeric levels (pino's own defaults). */
+export declare const PINO_TRACE = 10;
+export declare const PINO_DEBUG = 20;
+export declare const PINO_INFO = 30;
+export declare const PINO_WARN = 40;
+export declare const PINO_ERROR = 50;
+export declare const PINO_FATAL = 60;
+export declare const SERVICE_NAME_ATTRIBUTE = "service.name";
+/** Instrumentation scope name on every log record the SDK emits. */
+export declare const SDK_SCOPE_NAME = "spanport";
+/** Prefix on the SDK's own stderr messages, which are never exported. */
+export declare const SDK_MESSAGE_PREFIX = "spanport:";
+/** Where a log came from, recorded as the `log.source` attribute. */
+export declare const LOG_SOURCE_ATTRIBUTE = "log.source";
+export declare const CONSOLE_SOURCE = "console";
+export declare const LOG_STREAM_SOURCE = "stream";
+/** Fields of a pino or winston JSON line that become part of the record rather than attributes. */
+export declare const MESSAGE_FIELDS: readonly string[];
+export declare const LEVEL_FIELD = "level";
+export declare const TIME_FIELDS: readonly string[];
+export declare const TRACE_ID_FIELD = "trace_id";
+export declare const SPAN_ID_FIELD = "span_id";
+export declare const LINE_SEPARATOR = "\n";
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAE1E,eAAO,MAAM,eAAe,eAAe,CAAC;AAC5C,eAAO,MAAM,qBAAqB,0BAA0B,CAAC;AAC7D,eAAO,MAAM,kBAAkB,0BAA0B,CAAC;AAC1D,eAAO,MAAM,cAAc,aAAa,CAAC;AACzC,eAAO,MAAM,oBAAoB,6BAA6B,CAAC;AAC/D,eAAO,MAAM,oBAAoB,kBAAkB,CAAC;AACpD,eAAO,MAAM,aAAa,YAAY,CAAC;AACvC,eAAO,MAAM,qBAAqB,EAAE,SAAS,MAAM,EAAwB,CAAC;AAC5E,eAAO,MAAM,oBAAoB,OAAO,CAAC;AACzC,eAAO,MAAM,yBAAyB,IAAI,CAAC;AAC3C,eAAO,MAAM,iBAAiB,MAAM,CAAC;AAErC,oFAAoF;AACpF,eAAO,MAAM,wBAAwB,oDAAqD,CAAC;AAE3F,mDAAmD;AACnD,eAAO,MAAM,UAAU,KAAK,CAAC;AAC7B,eAAO,MAAM,UAAU,KAAK,CAAC;AAC7B,eAAO,MAAM,SAAS,KAAK,CAAC;AAC5B,eAAO,MAAM,SAAS,KAAK,CAAC;AAC5B,eAAO,MAAM,UAAU,KAAK,CAAC;AAC7B,eAAO,MAAM,UAAU,KAAK,CAAC;AAE7B,eAAO,MAAM,sBAAsB,iBAAiB,CAAC;AACrD,oEAAoE;AACpE,eAAO,MAAM,cAAc,aAAa,CAAC;AACzC,yEAAyE;AACzE,eAAO,MAAM,kBAAkB,cAAc,CAAC;AAE9C,qEAAqE;AACrE,eAAO,MAAM,oBAAoB,eAAe,CAAC;AACjD,eAAO,MAAM,cAAc,YAAY,CAAC;AACxC,eAAO,MAAM,iBAAiB,WAAW,CAAC;AAE1C,mGAAmG;AACnG,eAAO,MAAM,cAAc,EAAE,SAAS,MAAM,EAAuB,CAAC;AACpE,eAAO,MAAM,WAAW,UAAU,CAAC;AACnC,eAAO,MAAM,WAAW,EAAE,SAAS,MAAM,EAA0B,CAAC;AACpE,eAAO,MAAM,cAAc,aAAa,CAAC;AACzC,eAAO,MAAM,aAAa,YAAY,CAAC;AACvC,eAAO,MAAM,cAAc,OAAO,CAAC"}

package/dist/constants.js

@@ -0,0 +1,38 @@
+/** SDK constants. Code refers to these by name, never by inline value. */
+export const DATA_KEY_PREFIX = "sp_ingest_";
+export const DEFAULT_COLLECTOR_URL = "http://localhost:4318";
+export const DEFAULT_SERVER_URL = "http://localhost:8000";
+export const OTLP_LOGS_PATH = "/v1/logs";
+export const CURRENT_API_KEY_PATH = "/api/v1/api-keys/current";
+export const AUTHORIZATION_HEADER = "Authorization";
+export const BEARER_PREFIX = "Bearer ";
+export const ALLOWED_URL_PROTOCOLS = ["http:", "https:"];
+export const KEY_CHECK_TIMEOUT_MS = 5000;
+export const VISIBLE_KEY_SUFFIX_LENGTH = 4;
+export const HTTP_UNAUTHORIZED = 401;
+/** console methods the SDK copies to Spanport; the original output is unchanged. */
+export const CAPTURED_CONSOLE_METHODS = ["debug", "log", "info", "warn", "error"];
+/** pino's numeric levels (pino's own defaults). */
+export const PINO_TRACE = 10;
+export const PINO_DEBUG = 20;
+export const PINO_INFO = 30;
+export const PINO_WARN = 40;
+export const PINO_ERROR = 50;
+export const PINO_FATAL = 60;
+export const SERVICE_NAME_ATTRIBUTE = "service.name";
+/** Instrumentation scope name on every log record the SDK emits. */
+export const SDK_SCOPE_NAME = "spanport";
+/** Prefix on the SDK's own stderr messages, which are never exported. */
+export const SDK_MESSAGE_PREFIX = "spanport:";
+/** Where a log came from, recorded as the `log.source` attribute. */
+export const LOG_SOURCE_ATTRIBUTE = "log.source";
+export const CONSOLE_SOURCE = "console";
+export const LOG_STREAM_SOURCE = "stream";
+/** Fields of a pino or winston JSON line that become part of the record rather than attributes. */
+export const MESSAGE_FIELDS = ["msg", "message"];
+export const LEVEL_FIELD = "level";
+export const TIME_FIELDS = ["time", "timestamp"];
+export const TRACE_ID_FIELD = "trace_id";
+export const SPAN_ID_FIELD = "span_id";
+export const LINE_SEPARATOR = "\n";
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,0EAA0E;AAE1E,MAAM,CAAC,MAAM,eAAe,GAAG,YAAY,CAAC;AAC5C,MAAM,CAAC,MAAM,qBAAqB,GAAG,uBAAuB,CAAC;AAC7D,MAAM,CAAC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC;AAC1D,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAC;AACzC,MAAM,CAAC,MAAM,oBAAoB,GAAG,0BAA0B,CAAC;AAC/D,MAAM,CAAC,MAAM,oBAAoB,GAAG,eAAe,CAAC;AACpD,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAC;AACvC,MAAM,CAAC,MAAM,qBAAqB,GAAsB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAC5E,MAAM,CAAC,MAAM,oBAAoB,GAAG,IAAI,CAAC;AACzC,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC;AAC3C,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAErC,oFAAoF;AACpF,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,CAAU,CAAC;AAE3F,mDAAmD;AACnD,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,CAAC;AAC7B,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,CAAC;AAC7B,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAC;AAC5B,MAAM,CAAC,MAAM,SAAS,GAAG,EAAE,CAAC;AAC5B,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,CAAC;AAC7B,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,CAAC;AAE7B,MAAM,CAAC,MAAM,sBAAsB,GAAG,cAAc,CAAC;AACrD,oEAAoE;AACpE,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAC;AACzC,yEAAyE;AACzE,MAAM,CAAC,MAAM,kBAAkB,GAAG,WAAW,CAAC;AAE9C,qEAAqE;AACrE,MAAM,CAAC,MAAM,oBAAoB,GAAG,YAAY,CAAC;AACjD,MAAM,CAAC,MAAM,cAAc,GAAG,SAAS,CAAC;AACxC,MAAM,CAAC,MAAM,iBAAiB,GAAG,QAAQ,CAAC;AAE1C,mGAAmG;AACnG,MAAM,CAAC,MAAM,cAAc,GAAsB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AACpE,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC;AACnC,MAAM,CAAC,MAAM,WAAW,GAAsB,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;AACpE,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAC;AACzC,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAC;AACvC,MAAM,CAAC,MAAM,cAAc,GAAG,IAAI,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Spanport SDK: send your Node.js app's logs to Spanport.
+ *
+ *     import * as spanport from "spanport";
+ *     spanport.init({ dataKey: "sp_ingest_...", service: "orders-api" });
+ *
+ * It never breaks the host app: init() never throws, logs are sent in the background, and if
+ * anything is wrong it says so on stderr and the app carries on.
+ */
+import { type Writable } from "node:stream";
+export interface SpanportOptions {
+    /** The project's data key (sp_ingest_...). */
+    dataKey: string;
+    /** Name of this app as shown in Spanport, e.g. "orders-api". */
+    service: string;
+    /** The Spanport OTel Collector (OTLP/HTTP). Default http://localhost:4318. */
+    collectorUrl?: string;
+    /** The Spanport server, asked once whether the data key is valid. Default http://localhost:8000. */
+    serverUrl?: string;
+    /** Set false to skip the start-up key check (e.g. no route to the server). Default true. */
+    checkKey?: boolean;
+    /** Set false to stop copying console.* calls to Spanport. Default true. */
+    captureConsole?: boolean;
+}
+/**
+ * Start sending this app's logs to Spanport. Call once at start-up. Never throws.
+ *
+ * @param options - Data key, service name and where Spanport runs.
+ */
+export declare function init(options: SpanportOptions): void;
+/**
+ * Send any logs still queued, stop capturing console and stop. Safe to call more than once.
+ * Call it on SIGTERM; a normal exit calls it for you. Never rejects.
+ */
+export declare function shutdown(): Promise<void>;
+/**
+ * A stream for pino or winston (JSON lines). Lines written before init() or after shutdown()
+ * are dropped.
+ *
+ *     pino(spanport.logStream())
+ *     new winston.transports.Stream({ stream: spanport.logStream() })
+ *
+ * @returns A new writable stream.
+ */
+export declare function logStream(): Writable;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,aAAa,CAAC;AAqB5C,MAAM,WAAW,eAAe;IAC9B,8CAA8C;IAC9C,OAAO,EAAE,MAAM,CAAC;IAChB,gEAAgE;IAChE,OAAO,EAAE,MAAM,CAAC;IAChB,8EAA8E;IAC9E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,oGAAoG;IACpG,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2EAA2E;IAC3E,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAWD;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI,CAMnD;AAED;;;GAGG;AACH,wBAAsB,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAU9C;AAED;;;;;;;;GAQG;AACH,wBAAgB,SAAS,IAAI,QAAQ,CAIpC"}

package/dist/index.js

@@ -0,0 +1,112 @@
+/**
+ * Spanport SDK: send your Node.js app's logs to Spanport.
+ *
+ *     import * as spanport from "spanport";
+ *     spanport.init({ dataKey: "sp_ingest_...", service: "orders-api" });
+ *
+ * It never breaks the host app: init() never throws, logs are sent in the background, and if
+ * anything is wrong it says so on stderr and the app carries on.
+ */
+import {} from "node:stream";
+import {} from "@opentelemetry/api";
+import {} from "@opentelemetry/sdk-logs";
+import { captureConsole } from "./consoleCapture.js";
+import { CONSOLE_SOURCE, DATA_KEY_PREFIX, DEFAULT_COLLECTOR_URL, DEFAULT_SERVER_URL, LOG_STREAM_SOURCE, SDK_SCOPE_NAME, } from "./constants.js";
+import { checkDataKey } from "./keyCheck.js";
+import { createLogStream } from "./logStream.js";
+import { buildLoggerProvider, buildOtlpExporter, toLogRecord } from "./pipeline.js";
+import { sdkError, sdkInfo, sdkWarning } from "./sdkMessages.js";
+import { consoleSeverity } from "./severity.js";
+import { isHttpUrl } from "./urls.js";
+let active;
+let exitFlushInstalled = false;
+/**
+ * Start sending this app's logs to Spanport. Call once at start-up. Never throws.
+ *
+ * @param options - Data key, service name and where Spanport runs.
+ */
+export function init(options) {
+    try {
+        start(options);
+    }
+    catch (error) {
+        sdkError(`setup failed; the app keeps running but logs are not sent: ${describe(error)}`);
+    }
+}
+/**
+ * Send any logs still queued, stop capturing console and stop. Safe to call more than once.
+ * Call it on SIGTERM; a normal exit calls it for you. Never rejects.
+ */
+export async function shutdown() {
+    const pipeline = active;
+    active = undefined;
+    if (!pipeline)
+        return;
+    pipeline.restoreConsole?.();
+    try {
+        await pipeline.provider.shutdown();
+    }
+    catch (error) {
+        sdkWarning(`shutdown failed; some queued logs may not have been sent: ${describe(error)}`);
+    }
+}
+/**
+ * A stream for pino or winston (JSON lines). Lines written before init() or after shutdown()
+ * are dropped.
+ *
+ *     pino(spanport.logStream())
+ *     new winston.transports.Stream({ stream: spanport.logStream() })
+ *
+ * @returns A new writable stream.
+ */
+export function logStream() {
+    return createLogStream((entry) => {
+        active?.logger.emit(toLogRecord(entry, LOG_STREAM_SOURCE));
+    });
+}
+function start(options) {
+    if (active) {
+        sdkWarning("init() was already called; ignoring the second call");
+        return;
+    }
+    const collectorUrl = options.collectorUrl ?? DEFAULT_COLLECTOR_URL;
+    const problem = findProblem(options, collectorUrl);
+    if (problem) {
+        sdkError(`${problem}; logs are not sent`);
+        return;
+    }
+    const provider = buildLoggerProvider(options.service, buildOtlpExporter(collectorUrl, options.dataKey));
+    const logger = provider.getLogger(SDK_SCOPE_NAME);
+    const restoreConsole = options.captureConsole === false
+        ? undefined
+        : captureConsole((method, message) => {
+            logger.emit(toLogRecord({ body: message, severity: consoleSeverity(method), attributes: {} }, CONSOLE_SOURCE));
+        });
+    active = { provider, logger, restoreConsole };
+    installExitFlush();
+    sdkInfo(`sending logs for service ${options.service} to ${collectorUrl}`);
+    if (options.checkKey !== false) {
+        void checkDataKey(options.serverUrl ?? DEFAULT_SERVER_URL, options.dataKey);
+    }
+}
+/** Send what is queued when the app exits normally. Installed once, however often init runs. */
+function installExitFlush() {
+    if (exitFlushInstalled)
+        return;
+    exitFlushInstalled = true;
+    process.on("beforeExit", () => void shutdown());
+}
+function findProblem(options, collectorUrl) {
+    if (!options.dataKey.startsWith(DATA_KEY_PREFIX)) {
+        return `dataKey must be a data key (${DATA_KEY_PREFIX}...)`;
+    }
+    if (!options.service)
+        return "service must name this app, e.g. service: 'orders-api'";
+    if (!isHttpUrl(collectorUrl))
+        return "collectorUrl must start with http:// or https://";
+    return undefined;
+}
+function describe(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAiB,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAe,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAuB,MAAM,yBAAyB,CAAC;AAE9D,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EACL,cAAc,EACd,eAAe,EACf,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,cAAc,GACf,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACpF,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAuBtC,IAAI,MAAkC,CAAC;AACvC,IAAI,kBAAkB,GAAG,KAAK,CAAC;AAE/B;;;;GAIG;AACH,MAAM,UAAU,IAAI,CAAC,OAAwB;IAC3C,IAAI,CAAC;QACH,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,QAAQ,CAAC,8DAA8D,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC5F,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,QAAQ;IAC5B,MAAM,QAAQ,GAAG,MAAM,CAAC;IACxB,MAAM,GAAG,SAAS,CAAC;IACnB,IAAI,CAAC,QAAQ;QAAE,OAAO;IACtB,QAAQ,CAAC,cAAc,EAAE,EAAE,CAAC;IAC5B,IAAI,CAAC;QACH,MAAM,QAAQ,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;IACrC,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,UAAU,CAAC,6DAA6D,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;IAC7F,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS;IACvB,OAAO,eAAe,CAAC,CAAC,KAAK,EAAE,EAAE;QAC/B,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC;IAC7D,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,KAAK,CAAC,OAAwB;IACrC,IAAI,MAAM,EAAE,CAAC;QACX,UAAU,CAAC,qDAAqD,CAAC,CAAC;QAClE,OAAO;IACT,CAAC;IACD,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,qBAAqB,CAAC;IACnE,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACnD,IAAI,OAAO,EAAE,CAAC;QACZ,QAAQ,CAAC,GAAG,OAAO,qBAAqB,CAAC,CAAC;QAC1C,OAAO;IACT,CAAC;IACD,MAAM,QAAQ,GAAG,mBAAmB,CAClC,OAAO,CAAC,OAAO,EACf,iBAAiB,CAAC,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,CACjD,CAAC;IACF,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAClD,MAAM,cAAc,GAClB,OAAO,CAAC,cAAc,KAAK,KAAK;QAC9B,CAAC,CAAC,SAAS;QACX,CAAC,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE;YACjC,MAAM,CAAC,IAAI,CACT,WAAW,CACT,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,eAAe,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,EAAE,EAAE,EACpE,cAAc,CACf,CACF,CAAC;QACJ,CAAC,CAAC,CAAC;IACT,MAAM,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;IAC9C,gBAAgB,EAAE,CAAC;IACnB,OAAO,CAAC,4BAA4B,OAAO,CAAC,OAAO,OAAO,YAAY,EAAE,CAAC,CAAC;IAC1E,IAAI,OAAO,CAAC,QAAQ,KAAK,KAAK,EAAE,CAAC;QAC/B,KAAK,YAAY,CAAC,OAAO,CAAC,SAAS,IAAI,kBAAkB,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;IAC9E,CAAC;AACH,CAAC;AAED,gGAAgG;AAChG,SAAS,gBAAgB;IACvB,IAAI,kBAAkB;QAAE,OAAO;IAC/B,kBAAkB,GAAG,IAAI,CAAC;IAC1B,OAAO,CAAC,EAAE,CAAC,YAAY,EAAE,GAAG,EAAE,CAAC,KAAK,QAAQ,EAAE,CAAC,CAAC;AAClD,CAAC;AAED,SAAS,WAAW,CAAC,OAAwB,EAAE,YAAoB;IACjE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,eAAe,CAAC,EAAE,CAAC;QACjD,OAAO,+BAA+B,eAAe,MAAM,CAAC;IAC9D,CAAC;IACD,IAAI,CAAC,OAAO,CAAC,OAAO;QAAE,OAAO,wDAAwD,CAAC;IACtF,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC;QAAE,OAAO,kDAAkD,CAAC;IACxF,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC"}

package/dist/keyCheck.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Checks the data key once against the Spanport server and says clearly if it is wrong.
+ *
+ * The collector accepts logs without checking keys, so without this an app with a wrong key would
+ * lose its logs silently.
+ */
+/**
+ * Ask the server whether the data key is valid and report the answer on stderr. Never throws.
+ *
+ * Redirects are refused: following one would send the key to whatever host it names.
+ *
+ * @param serverUrl - Base URL of the Spanport server.
+ * @param dataKey - The raw data key; only its last characters are ever printed.
+ * @returns True if the server accepted the key; false if it rejected it or could not be asked.
+ */
+export declare function checkDataKey(serverUrl: string, dataKey: string): Promise<boolean>;
+//# sourceMappingURL=keyCheck.d.ts.map

package/dist/keyCheck.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyCheck.d.ts","sourceRoot":"","sources":["../src/keyCheck.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAaH;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAqBvF"}

package/dist/keyCheck.js

@@ -0,0 +1,56 @@
+/**
+ * Checks the data key once against the Spanport server and says clearly if it is wrong.
+ *
+ * The collector accepts logs without checking keys, so without this an app with a wrong key would
+ * lose its logs silently.
+ */
+import { AUTHORIZATION_HEADER, BEARER_PREFIX, CURRENT_API_KEY_PATH, HTTP_UNAUTHORIZED, KEY_CHECK_TIMEOUT_MS, VISIBLE_KEY_SUFFIX_LENGTH, } from "./constants.js";
+import { sdkError, sdkInfo, sdkWarning } from "./sdkMessages.js";
+import { isHttpUrl, joinUrl } from "./urls.js";
+/**
+ * Ask the server whether the data key is valid and report the answer on stderr. Never throws.
+ *
+ * Redirects are refused: following one would send the key to whatever host it names.
+ *
+ * @param serverUrl - Base URL of the Spanport server.
+ * @param dataKey - The raw data key; only its last characters are ever printed.
+ * @returns True if the server accepted the key; false if it rejected it or could not be asked.
+ */
+export async function checkDataKey(serverUrl, dataKey) {
+    const keySuffix = dataKey.slice(-VISIBLE_KEY_SUFFIX_LENGTH);
+    if (!isHttpUrl(serverUrl)) {
+        sdkWarning("serverUrl must start with http:// or https://; key not checked");
+        return false;
+    }
+    try {
+        const response = await fetch(joinUrl(serverUrl, CURRENT_API_KEY_PATH), {
+            headers: { [AUTHORIZATION_HEADER]: BEARER_PREFIX + dataKey },
+            redirect: "manual",
+            signal: AbortSignal.timeout(KEY_CHECK_TIMEOUT_MS),
+        });
+        // The body isn't needed; release the connection.
+        await response.body?.cancel();
+        return reportAnswer(response.status, response.ok, serverUrl, keySuffix);
+    }
+    catch (error) {
+        sdkWarning(`could not reach ${serverUrl} to check data key ...${keySuffix}: ${describe(error)}`);
+        return false;
+    }
+}
+function reportAnswer(status, ok, serverUrl, keySuffix) {
+    if (ok) {
+        sdkInfo(`data key ...${keySuffix} accepted`);
+        return true;
+    }
+    if (status === HTTP_UNAUTHORIZED) {
+        sdkError(`data key ...${keySuffix} was rejected by ${serverUrl}; logs will NOT be stored. ` +
+            "Check the key, or create one with create-data-key.");
+        return false;
+    }
+    sdkWarning(`could not check data key ...${keySuffix}: HTTP ${String(status)}`);
+    return false;
+}
+function describe(error) {
+    return error instanceof Error ? error.message : String(error);
+}
+//# sourceMappingURL=keyCheck.js.map

package/dist/keyCheck.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"keyCheck.js","sourceRoot":"","sources":["../src/keyCheck.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,oBAAoB,EACpB,aAAa,EACb,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,yBAAyB,GAC1B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAE/C;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,SAAiB,EAAE,OAAe;IACnE,MAAM,SAAS,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,yBAAyB,CAAC,CAAC;IAC5D,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;QAC1B,UAAU,CAAC,gEAAgE,CAAC,CAAC;QAC7E,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,SAAS,EAAE,oBAAoB,CAAC,EAAE;YACrE,OAAO,EAAE,EAAE,CAAC,oBAAoB,CAAC,EAAE,aAAa,GAAG,OAAO,EAAE;YAC5D,QAAQ,EAAE,QAAQ;YAClB,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,oBAAoB,CAAC;SAClD,CAAC,CAAC;QACH,iDAAiD;QACjD,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;QAC9B,OAAO,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1E,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,UAAU,CACR,mBAAmB,SAAS,yBAAyB,SAAS,KAAK,QAAQ,CAAC,KAAK,CAAC,EAAE,CACrF,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,MAAc,EAAE,EAAW,EAAE,SAAiB,EAAE,SAAiB;IACrF,IAAI,EAAE,EAAE,CAAC;QACP,OAAO,CAAC,eAAe,SAAS,WAAW,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,MAAM,KAAK,iBAAiB,EAAE,CAAC;QACjC,QAAQ,CACN,eAAe,SAAS,oBAAoB,SAAS,6BAA6B;YAChF,oDAAoD,CACvD,CAAC;QACF,OAAO,KAAK,CAAC;IACf,CAAC;IACD,UAAU,CAAC,+BAA+B,SAAS,UAAU,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IAC/E,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,OAAO,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChE,CAAC"}

package/dist/logStream.d.ts

@@ -0,0 +1,24 @@
+/**
+ * A writable stream for loggers that write JSON lines: pino (as its destination) and winston (with
+ * the Stream transport and JSON format). The SDK depends on neither.
+ */
+import { Writable } from "node:stream";
+import { type LogEntry } from "./pipeline.js";
+/**
+ * Create a stream that turns each line written to it into a log entry.
+ *
+ * Lines split across writes are joined before parsing.
+ *
+ * @param onEntry - Receives each parsed entry.
+ * @returns The stream to give to pino or winston.
+ */
+export declare function createLogStream(onEntry: (entry: LogEntry) => void): Writable;
+/**
+ * Parse one pino or winston JSON line. A line that isn't JSON becomes an INFO entry with the line
+ * as its message.
+ *
+ * @param line - One line, without the newline.
+ * @returns The log entry.
+ */
+export declare function parseLogLine(line: string): LogEntry;
+//# sourceMappingURL=logStream.d.ts.map

package/dist/logStream.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logStream.d.ts","sourceRoot":"","sources":["../src/logStream.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAmBvC,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AAc9C;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,QAAQ,KAAK,IAAI,GAAG,QAAQ,CAY5E;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,QAAQ,CAanD"}

package/dist/logStream.js

@@ -0,0 +1,127 @@
+/**
+ * A writable stream for loggers that write JSON lines: pino (as its destination) and winston (with
+ * the Stream transport and JSON format). The SDK depends on neither.
+ */
+import { Writable } from "node:stream";
+import { ROOT_CONTEXT, TraceFlags, isSpanContextValid, trace, } from "@opentelemetry/api";
+import { LEVEL_FIELD, LINE_SEPARATOR, MESSAGE_FIELDS, SPAN_ID_FIELD, TIME_FIELDS, TRACE_ID_FIELD, } from "./constants.js";
+import {} from "./pipeline.js";
+import { INFO, pinoSeverity, winstonSeverity } from "./severity.js";
+/** Fields that become part of the record itself, not attributes. */
+const RECORD_FIELDS = new Set([
+    ...MESSAGE_FIELDS,
+    LEVEL_FIELD,
+    ...TIME_FIELDS,
+    TRACE_ID_FIELD,
+    SPAN_ID_FIELD,
+]);
+/**
+ * Create a stream that turns each line written to it into a log entry.
+ *
+ * Lines split across writes are joined before parsing.
+ *
+ * @param onEntry - Receives each parsed entry.
+ * @returns The stream to give to pino or winston.
+ */
+export function createLogStream(onEntry) {
+    let partialLine = "";
+    return new Writable({
+        write(chunk, _encoding, done) {
+            const lines = (partialLine + chunk.toString()).split(LINE_SEPARATOR);
+            partialLine = lines.pop() ?? "";
+            for (const line of lines) {
+                if (line.trim())
+                    onEntry(parseLogLine(line));
+            }
+            done();
+        },
+    });
+}
+/**
+ * Parse one pino or winston JSON line. A line that isn't JSON becomes an INFO entry with the line
+ * as its message.
+ *
+ * @param line - One line, without the newline.
+ * @returns The log entry.
+ */
+export function parseLogLine(line) {
+    const fields = parseJsonObject(line);
+    if (!fields)
+        return { body: line, severity: INFO, attributes: {} };
+    const entry = {
+        body: messageOf(fields) ?? line,
+        severity: severityOf(fields[LEVEL_FIELD]),
+        attributes: attributesOf(fields),
+    };
+    const context = traceContextOf(fields);
+    if (context)
+        entry.context = context;
+    const timestamp = timestampOf(fields);
+    if (timestamp)
+        entry.timestamp = timestamp;
+    return entry;
+}
+function parseJsonObject(line) {
+    try {
+        const parsed = JSON.parse(line);
+        return typeof parsed === "object" && parsed !== null && !Array.isArray(parsed)
+            ? parsed
+            : undefined;
+    }
+    catch {
+        return undefined;
+    }
+}
+function messageOf(fields) {
+    for (const name of MESSAGE_FIELDS) {
+        const value = fields[name];
+        if (typeof value === "string")
+            return value;
+    }
+    return undefined;
+}
+function severityOf(level) {
+    if (typeof level === "number")
+        return pinoSeverity(level);
+    if (typeof level === "string")
+        return winstonSeverity(level);
+    return INFO;
+}
+function attributesOf(fields) {
+    const attributes = {};
+    for (const [name, value] of Object.entries(fields)) {
+        if (!RECORD_FIELDS.has(name))
+            attributes[name] = toAttributeValue(value);
+    }
+    return attributes;
+}
+function toAttributeValue(value) {
+    if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
+        return value;
+    }
+    return JSON.stringify(value);
+}
+/** Use the line's trace_id/span_id (as written by pino's OpenTelemetry integration) if valid. */
+function traceContextOf(fields) {
+    const traceId = fields[TRACE_ID_FIELD];
+    const spanId = fields[SPAN_ID_FIELD];
+    if (typeof traceId !== "string" || typeof spanId !== "string")
+        return undefined;
+    const spanContext = { traceId, spanId, traceFlags: TraceFlags.SAMPLED, isRemote: true };
+    return isSpanContextValid(spanContext)
+        ? trace.setSpanContext(ROOT_CONTEXT, spanContext)
+        : undefined;
+}
+/** pino writes epoch milliseconds in `time`; winston's timestamp format writes an ISO string. */
+function timestampOf(fields) {
+    for (const name of TIME_FIELDS) {
+        const value = fields[name];
+        if (typeof value !== "number" && typeof value !== "string")
+            continue;
+        const date = new Date(value);
+        if (!Number.isNaN(date.getTime()))
+            return date;
+    }
+    return undefined;
+}
+//# sourceMappingURL=logStream.js.map

package/dist/logStream.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logStream.js","sourceRoot":"","sources":["../src/logStream.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAEvC,OAAO,EAGL,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,KAAK,GACN,MAAM,oBAAoB,CAAC;AAE5B,OAAO,EACL,WAAW,EACX,cAAc,EACd,cAAc,EACd,aAAa,EACb,WAAW,EACX,cAAc,GACf,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAiB,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAiB,YAAY,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAInF,oEAAoE;AACpE,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC;IAC5B,GAAG,cAAc;IACjB,WAAW;IACX,GAAG,WAAW;IACd,cAAc;IACd,aAAa;CACd,CAAC,CAAC;AAEH;;;;;;;GAOG;AACH,MAAM,UAAU,eAAe,CAAC,OAAkC;IAChE,IAAI,WAAW,GAAG,EAAE,CAAC;IACrB,OAAO,IAAI,QAAQ,CAAC;QAClB,KAAK,CAAC,KAAsB,EAAE,SAAS,EAAE,IAAI;YAC3C,MAAM,KAAK,GAAG,CAAC,WAAW,GAAG,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;YACrE,WAAW,GAAG,KAAK,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC;YAChC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,IAAI,IAAI,CAAC,IAAI,EAAE;oBAAE,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC;YAC/C,CAAC;YACD,IAAI,EAAE,CAAC;QACT,CAAC;KACF,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY;IACvC,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;IACrC,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,EAAE,EAAE,CAAC;IACnE,MAAM,KAAK,GAAa;QACtB,IAAI,EAAE,SAAS,CAAC,MAAM,CAAC,IAAI,IAAI;QAC/B,QAAQ,EAAE,UAAU,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzC,UAAU,EAAE,YAAY,CAAC,MAAM,CAAC;KACjC,CAAC;IACF,MAAM,OAAO,GAAG,cAAc,CAAC,MAAM,CAAC,CAAC;IACvC,IAAI,OAAO;QAAE,KAAK,CAAC,OAAO,GAAG,OAAO,CAAC;IACrC,MAAM,SAAS,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;IACtC,IAAI,SAAS;QAAE,KAAK,CAAC,SAAS,GAAG,SAAS,CAAC;IAC3C,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,eAAe,CAAC,IAAY;IACnC,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACzC,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAC5E,CAAC,CAAE,MAAqB;YACxB,CAAC,CAAC,SAAS,CAAC;IAChB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,MAAkB;IACnC,KAAK,MAAM,IAAI,IAAI,cAAc,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,KAAK,CAAC;IAC9C,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED,SAAS,UAAU,CAAC,KAAc;IAChC,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;IAC1D,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,eAAe,CAAC,KAAK,CAAC,CAAC;IAC7D,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,YAAY,CAAC,MAAkB;IACtC,MAAM,UAAU,GAAe,EAAE,CAAC;IAClC,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACnD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,UAAU,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC;IAC3E,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED,SAAS,gBAAgB,CAAC,KAAc;IACtC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;QACzF,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,iGAAiG;AACjG,SAAS,cAAc,CAAC,MAAkB;IACxC,MAAM,OAAO,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC;IACvC,MAAM,MAAM,GAAG,MAAM,CAAC,aAAa,CAAC,CAAC;IACrC,IAAI,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,MAAM,KAAK,QAAQ;QAAE,OAAO,SAAS,CAAC;IAChF,MAAM,WAAW,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACxF,OAAO,kBAAkB,CAAC,WAAW,CAAC;QACpC,CAAC,CAAC,KAAK,CAAC,cAAc,CAAC,YAAY,EAAE,WAAW,CAAC;QACjD,CAAC,CAAC,SAAS,CAAC;AAChB,CAAC;AAED,iGAAiG;AACjG,SAAS,WAAW,CAAC,MAAkB;IACrC,KAAK,MAAM,IAAI,IAAI,WAAW,EAAE,CAAC;QAC/B,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC3B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,SAAS;QACrE,MAAM,IAAI,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAAE,OAAO,IAAI,CAAC;IACjD,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC"}

package/dist/pipeline.d.ts

@@ -0,0 +1,39 @@
+/** Builds the OpenTelemetry pipeline: log records → batch → OTLP/HTTP → collector. */
+import { type Attributes, type Context, type LogRecord } from "@opentelemetry/api";
+import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
+import { LoggerProvider, type LogRecordExporter } from "@opentelemetry/sdk-logs";
+import { type Severity } from "./severity.js";
+/** One log line, whatever logger it came from, before it becomes an OpenTelemetry record. */
+export interface LogEntry {
+    body: string;
+    severity: Severity;
+    attributes: Attributes;
+    /** Carries the trace and span the log belongs to; the active span is used when absent. */
+    context?: Context;
+    timestamp?: Date;
+}
+/**
+ * Exporter that sends batches to the collector with the data key as a bearer token.
+ *
+ * @param collectorUrl - Base URL of the OTel Collector, e.g. "http://localhost:4318".
+ * @param dataKey - The raw data key.
+ * @returns The OTLP/HTTP log exporter.
+ */
+export declare function buildOtlpExporter(collectorUrl: string, dataKey: string): OTLPLogExporter;
+/**
+ * Provider that batches records in the background and hands them to `exporter`.
+ *
+ * @param service - Service name shown in Spanport, e.g. "orders-api".
+ * @param exporter - Where batches go; OTLP in real use, in-memory in tests.
+ * @returns The provider; shut it down to send what is still queued.
+ */
+export declare function buildLoggerProvider(service: string, exporter: LogRecordExporter): LoggerProvider;
+/**
+ * Turn a log entry into an OpenTelemetry log record.
+ *
+ * @param entry - The parsed log line.
+ * @param source - Where it came from ("console" or "stream"), kept as the log.source attribute.
+ * @returns The record to emit.
+ */
+export declare function toLogRecord(entry: LogEntry, source: string): LogRecord;
+//# sourceMappingURL=pipeline.d.ts.map

package/dist/pipeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline.d.ts","sourceRoot":"","sources":["../src/pipeline.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,KAAK,UAAU,EAAE,KAAK,OAAO,EAAE,KAAK,SAAS,EAAE,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AAEzE,OAAO,EAEL,cAAc,EACd,KAAK,iBAAiB,EACvB,MAAM,yBAAyB,CAAC;AASjC,OAAO,EAAE,KAAK,QAAQ,EAAE,MAAM,eAAe,CAAC;AAG9C,6FAA6F;AAC7F,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,QAAQ,CAAC;IACnB,UAAU,EAAE,UAAU,CAAC;IACvB,0FAA0F;IAC1F,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,eAAe,CAKxF;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,iBAAiB,GAAG,cAAc,CAKhG;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAUtE"}

package/dist/pipeline.js

@@ -0,0 +1,55 @@
+/** Builds the OpenTelemetry pipeline: log records → batch → OTLP/HTTP → collector. */
+import {} from "@opentelemetry/api";
+import { OTLPLogExporter } from "@opentelemetry/exporter-logs-otlp-http";
+import { resourceFromAttributes } from "@opentelemetry/resources";
+import { BatchLogRecordProcessor, LoggerProvider, } from "@opentelemetry/sdk-logs";
+import { AUTHORIZATION_HEADER, BEARER_PREFIX, LOG_SOURCE_ATTRIBUTE, OTLP_LOGS_PATH, SERVICE_NAME_ATTRIBUTE, } from "./constants.js";
+import {} from "./severity.js";
+import { joinUrl } from "./urls.js";
+/**
+ * Exporter that sends batches to the collector with the data key as a bearer token.
+ *
+ * @param collectorUrl - Base URL of the OTel Collector, e.g. "http://localhost:4318".
+ * @param dataKey - The raw data key.
+ * @returns The OTLP/HTTP log exporter.
+ */
+export function buildOtlpExporter(collectorUrl, dataKey) {
+    return new OTLPLogExporter({
+        url: joinUrl(collectorUrl, OTLP_LOGS_PATH),
+        headers: { [AUTHORIZATION_HEADER]: BEARER_PREFIX + dataKey },
+    });
+}
+/**
+ * Provider that batches records in the background and hands them to `exporter`.
+ *
+ * @param service - Service name shown in Spanport, e.g. "orders-api".
+ * @param exporter - Where batches go; OTLP in real use, in-memory in tests.
+ * @returns The provider; shut it down to send what is still queued.
+ */
+export function buildLoggerProvider(service, exporter) {
+    return new LoggerProvider({
+        resource: resourceFromAttributes({ [SERVICE_NAME_ATTRIBUTE]: service }),
+        processors: [new BatchLogRecordProcessor({ exporter })],
+    });
+}
+/**
+ * Turn a log entry into an OpenTelemetry log record.
+ *
+ * @param entry - The parsed log line.
+ * @param source - Where it came from ("console" or "stream"), kept as the log.source attribute.
+ * @returns The record to emit.
+ */
+export function toLogRecord(entry, source) {
+    const record = {
+        body: entry.body,
+        severityNumber: entry.severity.number,
+        severityText: entry.severity.text,
+        attributes: { ...entry.attributes, [LOG_SOURCE_ATTRIBUTE]: source },
+    };
+    if (entry.context)
+        record.context = entry.context;
+    if (entry.timestamp)
+        record.timestamp = entry.timestamp;
+    return record;
+}
+//# sourceMappingURL=pipeline.js.map

package/dist/pipeline.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pipeline.js","sourceRoot":"","sources":["../src/pipeline.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAiD,MAAM,oBAAoB,CAAC;AACnF,OAAO,EAAE,eAAe,EAAE,MAAM,wCAAwC,CAAC;AACzE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EACL,uBAAuB,EACvB,cAAc,GAEf,MAAM,yBAAyB,CAAC;AAEjC,OAAO,EACL,oBAAoB,EACpB,aAAa,EACb,oBAAoB,EACpB,cAAc,EACd,sBAAsB,GACvB,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAiB,MAAM,eAAe,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAYpC;;;;;;GAMG;AACH,MAAM,UAAU,iBAAiB,CAAC,YAAoB,EAAE,OAAe;IACrE,OAAO,IAAI,eAAe,CAAC;QACzB,GAAG,EAAE,OAAO,CAAC,YAAY,EAAE,cAAc,CAAC;QAC1C,OAAO,EAAE,EAAE,CAAC,oBAAoB,CAAC,EAAE,aAAa,GAAG,OAAO,EAAE;KAC7D,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe,EAAE,QAA2B;IAC9E,OAAO,IAAI,cAAc,CAAC;QACxB,QAAQ,EAAE,sBAAsB,CAAC,EAAE,CAAC,sBAAsB,CAAC,EAAE,OAAO,EAAE,CAAC;QACvE,UAAU,EAAE,CAAC,IAAI,uBAAuB,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;KACxD,CAAC,CAAC;AACL,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,KAAe,EAAE,MAAc;IACzD,MAAM,MAAM,GAAc;QACxB,IAAI,EAAE,KAAK,CAAC,IAAI;QAChB,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC,MAAM;QACrC,YAAY,EAAE,KAAK,CAAC,QAAQ,CAAC,IAAI;QACjC,UAAU,EAAE,EAAE,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC,oBAAoB,CAAC,EAAE,MAAM,EAAE;KACpE,CAAC;IACF,IAAI,KAAK,CAAC,OAAO;QAAE,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;IAClD,IAAI,KAAK,CAAC,SAAS;QAAE,MAAM,CAAC,SAAS,GAAG,KAAK,CAAC,SAAS,CAAC;IACxD,OAAO,MAAM,CAAC;AAChB,CAAC"}

package/dist/sdkMessages.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The SDK's own messages. They go straight to stderr: never through console (which the SDK may be
+ * capturing, so they would loop) and never exported.
+ */
+/** Report normal progress, e.g. the key was accepted. */
+export declare function sdkInfo(message: string): void;
+/** Report something that may stop logs from arriving, e.g. the server could not be reached. */
+export declare function sdkWarning(message: string): void;
+/** Report something that stops logs from being stored, e.g. a rejected key. */
+export declare function sdkError(message: string): void;
+//# sourceMappingURL=sdkMessages.d.ts.map

package/dist/sdkMessages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdkMessages.d.ts","sourceRoot":"","sources":["../src/sdkMessages.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH,yDAAyD;AACzD,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAE7C;AAED,+FAA+F;AAC/F,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAEhD;AAED,+EAA+E;AAC/E,wBAAgB,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAE9C"}

package/dist/sdkMessages.js

@@ -0,0 +1,21 @@
+/**
+ * The SDK's own messages. They go straight to stderr: never through console (which the SDK may be
+ * capturing, so they would loop) and never exported.
+ */
+import { SDK_MESSAGE_PREFIX } from "./constants.js";
+function write(level, message) {
+    process.stderr.write(`${level} ${SDK_MESSAGE_PREFIX} ${message}\n`);
+}
+/** Report normal progress, e.g. the key was accepted. */
+export function sdkInfo(message) {
+    write("INFO", message);
+}
+/** Report something that may stop logs from arriving, e.g. the server could not be reached. */
+export function sdkWarning(message) {
+    write("WARNING", message);
+}
+/** Report something that stops logs from being stored, e.g. a rejected key. */
+export function sdkError(message) {
+    write("ERROR", message);
+}
+//# sourceMappingURL=sdkMessages.js.map

package/dist/sdkMessages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sdkMessages.js","sourceRoot":"","sources":["../src/sdkMessages.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,kBAAkB,EAAE,MAAM,gBAAgB,CAAC;AAIpD,SAAS,KAAK,CAAC,KAAmB,EAAE,OAAe;IACjD,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,KAAK,IAAI,kBAAkB,IAAI,OAAO,IAAI,CAAC,CAAC;AACtE,CAAC;AAED,yDAAyD;AACzD,MAAM,UAAU,OAAO,CAAC,OAAe;IACrC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACzB,CAAC;AAED,+FAA+F;AAC/F,MAAM,UAAU,UAAU,CAAC,OAAe;IACxC,KAAK,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;AAC5B,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,QAAQ,CAAC,OAAe;IACtC,KAAK,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;AAC1B,CAAC"}

package/dist/severity.d.ts

@@ -0,0 +1,31 @@
+/** Maps console, pino and winston levels to OpenTelemetry severities. */
+import { SeverityNumber } from "@opentelemetry/api";
+import { type CAPTURED_CONSOLE_METHODS } from "./constants.js";
+export type ConsoleMethod = (typeof CAPTURED_CONSOLE_METHODS)[number];
+export interface Severity {
+    number: SeverityNumber;
+    text: string;
+}
+export declare const INFO: Severity;
+/**
+ * Severity of a console call.
+ *
+ * @param method - The console method that was called.
+ * @returns console.debug is DEBUG, log and info are INFO, warn is WARN, error is ERROR.
+ */
+export declare function consoleSeverity(method: ConsoleMethod): Severity;
+/**
+ * Severity of a pino level number (10 trace ... 60 fatal; custom levels fall into the band below).
+ *
+ * @param level - pino's numeric level.
+ * @returns The matching severity.
+ */
+export declare function pinoSeverity(level: number): Severity;
+/**
+ * Severity of a winston (npm-style) level name. Unknown names count as INFO.
+ *
+ * @param level - e.g. "error", "warn", "info", "http", "verbose", "debug", "silly".
+ * @returns The matching severity.
+ */
+export declare function winstonSeverity(level: string): Severity;
+//# sourceMappingURL=severity.d.ts.map

package/dist/severity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"severity.d.ts","sourceRoot":"","sources":["../src/severity.ts"],"names":[],"mappings":"AAAA,yEAAyE;AAEzE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EACL,KAAK,wBAAwB,EAM9B,MAAM,gBAAgB,CAAC;AAExB,MAAM,MAAM,aAAa,GAAG,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtE,MAAM,WAAW,QAAQ;IACvB,MAAM,EAAE,cAAc,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;CACd;AAID,eAAO,MAAM,IAAI,EAAE,QAAwD,CAAC;AAK5E;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,aAAa,GAAG,QAAQ,CAY/D;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAOpD;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAqBvD"}

package/dist/severity.js

@@ -0,0 +1,76 @@
+/** Maps console, pino and winston levels to OpenTelemetry severities. */
+import { SeverityNumber } from "@opentelemetry/api";
+import { PINO_DEBUG, PINO_ERROR, PINO_FATAL, PINO_INFO, PINO_WARN, } from "./constants.js";
+const TRACE = { number: SeverityNumber.TRACE, text: "TRACE" };
+const DEBUG = { number: SeverityNumber.DEBUG, text: "DEBUG" };
+export const INFO = { number: SeverityNumber.INFO, text: "INFO" };
+const WARN = { number: SeverityNumber.WARN, text: "WARN" };
+const ERROR = { number: SeverityNumber.ERROR, text: "ERROR" };
+const FATAL = { number: SeverityNumber.FATAL, text: "FATAL" };
+/**
+ * Severity of a console call.
+ *
+ * @param method - The console method that was called.
+ * @returns console.debug is DEBUG, log and info are INFO, warn is WARN, error is ERROR.
+ */
+export function consoleSeverity(method) {
+    switch (method) {
+        case "debug":
+            return DEBUG;
+        case "log":
+        case "info":
+            return INFO;
+        case "warn":
+            return WARN;
+        case "error":
+            return ERROR;
+    }
+}
+/**
+ * Severity of a pino level number (10 trace ... 60 fatal; custom levels fall into the band below).
+ *
+ * @param level - pino's numeric level.
+ * @returns The matching severity.
+ */
+export function pinoSeverity(level) {
+    if (level >= PINO_FATAL)
+        return FATAL;
+    if (level >= PINO_ERROR)
+        return ERROR;
+    if (level >= PINO_WARN)
+        return WARN;
+    if (level >= PINO_INFO)
+        return INFO;
+    if (level >= PINO_DEBUG)
+        return DEBUG;
+    return TRACE;
+}
+/**
+ * Severity of a winston (npm-style) level name. Unknown names count as INFO.
+ *
+ * @param level - e.g. "error", "warn", "info", "http", "verbose", "debug", "silly".
+ * @returns The matching severity.
+ */
+export function winstonSeverity(level) {
+    switch (level.toLowerCase()) {
+        case "fatal":
+        case "emerg":
+        case "alert":
+        case "crit":
+            return FATAL;
+        case "error":
+            return ERROR;
+        case "warn":
+        case "warning":
+            return WARN;
+        case "debug":
+        case "verbose":
+            return DEBUG;
+        case "silly":
+        case "trace":
+            return TRACE;
+        default:
+            return INFO;
+    }
+}
+//# sourceMappingURL=severity.js.map

package/dist/severity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"severity.js","sourceRoot":"","sources":["../src/severity.ts"],"names":[],"mappings":"AAAA,yEAAyE;AAEzE,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAEL,UAAU,EACV,UAAU,EACV,UAAU,EACV,SAAS,EACT,SAAS,GACV,MAAM,gBAAgB,CAAC;AASxB,MAAM,KAAK,GAAa,EAAE,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AACxE,MAAM,KAAK,GAAa,EAAE,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AACxE,MAAM,CAAC,MAAM,IAAI,GAAa,EAAE,MAAM,EAAE,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AAC5E,MAAM,IAAI,GAAa,EAAE,MAAM,EAAE,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACrE,MAAM,KAAK,GAAa,EAAE,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AACxE,MAAM,KAAK,GAAa,EAAE,MAAM,EAAE,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;AAExE;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,MAAqB;IACnD,QAAQ,MAAM,EAAE,CAAC;QACf,KAAK,OAAO;YACV,OAAO,KAAK,CAAC;QACf,KAAK,KAAK,CAAC;QACX,KAAK,MAAM;YACT,OAAO,IAAI,CAAC;QACd,KAAK,MAAM;YACT,OAAO,IAAI,CAAC;QACd,KAAK,OAAO;YACV,OAAO,KAAK,CAAC;IACjB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,IAAI,KAAK,IAAI,UAAU;QAAE,OAAO,KAAK,CAAC;IACtC,IAAI,KAAK,IAAI,UAAU;QAAE,OAAO,KAAK,CAAC;IACtC,IAAI,KAAK,IAAI,SAAS;QAAE,OAAO,IAAI,CAAC;IACpC,IAAI,KAAK,IAAI,SAAS;QAAE,OAAO,IAAI,CAAC;IACpC,IAAI,KAAK,IAAI,UAAU;QAAE,OAAO,KAAK,CAAC;IACtC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,KAAa;IAC3C,QAAQ,KAAK,CAAC,WAAW,EAAE,EAAE,CAAC;QAC5B,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC;QACb,KAAK,OAAO,CAAC;QACb,KAAK,MAAM;YACT,OAAO,KAAK,CAAC;QACf,KAAK,OAAO;YACV,OAAO,KAAK,CAAC;QACf,KAAK,MAAM,CAAC;QACZ,KAAK,SAAS;YACZ,OAAO,IAAI,CAAC;QACd,KAAK,OAAO,CAAC;QACb,KAAK,SAAS;YACZ,OAAO,KAAK,CAAC;QACf,KAAK,OAAO,CAAC;QACb,KAAK,OAAO;YACV,OAAO,KAAK,CAAC;QACf;YACE,OAAO,IAAI,CAAC;IAChB,CAAC;AACH,CAAC"}

package/dist/urls.d.ts

@@ -0,0 +1,17 @@
+/** URL helpers shared by the exporter and the key check. */
+/**
+ * Append a path to a base URL, keeping any path the base already has (e.g. behind a proxy).
+ *
+ * @param baseUrl - e.g. "https://example.com/spanport" or "https://example.com/spanport/".
+ * @param path - Starting with "/", e.g. "/v1/logs".
+ * @returns The joined URL text.
+ */
+export declare function joinUrl(baseUrl: string, path: string): string;
+/**
+ * Whether the text is an absolute http:// or https:// URL.
+ *
+ * @param url - The URL text to check.
+ * @returns True only for parseable http(s) URLs.
+ */
+export declare function isHttpUrl(url: string): boolean;
+//# sourceMappingURL=urls.d.ts.map

package/dist/urls.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"urls.d.ts","sourceRoot":"","sources":["../src/urls.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAI5D;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7D;AAED;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAE9C"}

package/dist/urls.js

@@ -0,0 +1,22 @@
+/** URL helpers shared by the exporter and the key check. */
+import { ALLOWED_URL_PROTOCOLS } from "./constants.js";
+/**
+ * Append a path to a base URL, keeping any path the base already has (e.g. behind a proxy).
+ *
+ * @param baseUrl - e.g. "https://example.com/spanport" or "https://example.com/spanport/".
+ * @param path - Starting with "/", e.g. "/v1/logs".
+ * @returns The joined URL text.
+ */
+export function joinUrl(baseUrl, path) {
+    return (baseUrl.endsWith("/") ? baseUrl.slice(0, -1) : baseUrl) + path;
+}
+/**
+ * Whether the text is an absolute http:// or https:// URL.
+ *
+ * @param url - The URL text to check.
+ * @returns True only for parseable http(s) URLs.
+ */
+export function isHttpUrl(url) {
+    return URL.canParse(url) && ALLOWED_URL_PROTOCOLS.includes(new URL(url).protocol);
+}
+//# sourceMappingURL=urls.js.map

package/dist/urls.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"urls.js","sourceRoot":"","sources":["../src/urls.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAE5D,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AAEvD;;;;;;GAMG;AACH,MAAM,UAAU,OAAO,CAAC,OAAe,EAAE,IAAY;IACnD,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC;AACzE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,qBAAqB,CAAC,QAAQ,CAAC,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,CAAC;AACpF,CAAC"}

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "spanport",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "Send your Node.js app's logs to Spanport. Keep logging the way you already do.",
+  "keywords": ["logging", "observability", "opentelemetry", "otlp", "spanport"],
+  "license": "Apache-2.0",
+  "author": "Nitish Bharadwaj <nitishbharadwaj2002@gmail.com>",
+  "homepage": "https://github.com/span-port/spanport",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/span-port/spanport.git",
+    "directory": "sdk/node"
+  },
+  "bugs": "https://github.com/span-port/spanport/issues",
+  "type": "module",
+  "engines": {
+    "node": ">=22.15"
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": ["dist", "LICENSE", "README.md"],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "lint": "eslint .",
+    "test": "tsc -p tsconfig.json && node --test --test-reporter=dot \"build/test/**/*.test.js\"",
+    "prepublishOnly": "npm run lint && npm test && npm run build"
+  },
+  "dependencies": {
+    "@opentelemetry/api": ">=1.10.0 <1.11.0",
+    "@opentelemetry/exporter-logs-otlp-http": ">=0.300.0 <0.301.0",
+    "@opentelemetry/resources": ">=3.0.0 <4.0.0",
+    "@opentelemetry/sdk-logs": ">=3.0.0 <4.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "10.0.1",
+    "@opentelemetry/context-async-hooks": "3.0.0",
+    "@opentelemetry/sdk-trace": "3.0.0",
+    "@types/node": "22.20.5",
+    "eslint": "10.13.0",
+    "typescript": "6.0.3",
+    "typescript-eslint": "8.72.1"
+  },
+  "overrides": {
+    "@types/estree": "1.0.9"
+  }
+}