@flowrdesk/silo 1.0.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 2026 John Spriggs (Flowrdesk LLC)
+
+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/NOTICE

@@ -0,0 +1,4 @@
+Silo-Free Logging Engine
+Copyright 2026 John Spriggs (Flowrdesk LLC)
+
+This product includes software developed by John Spriggs for Flowrdesk LLC.

package/README.md

@@ -0,0 +1,320 @@
+# @flowrdesk/silo
+
+**The high-performance, zero-dependency logging engine built for Node.js.**  
+Part of the [Flowrdesk Silo Series](https://flowrdesk.com).
+
+[![npm version](https://img.shields.io/npm/v/@flowrdesk/silo)](https://www.npmjs.com/package/@flowrdesk/silo)
+[![license](https://img.shields.io/badge/license-Apache--2.0-blue)](./LICENSE)
+[![zero dependencies](https://img.shields.io/badge/dependencies-0-brightgreen)]()
+
+---
+
+## Why Silo
+
+Most Node.js loggers make you choose between speed and stability. Pino is fast but consumes memory aggressively at scale. Winston is stable but too slow for high-throughput environments. Silo doesn't make that tradeoff.
+
+**Zero dependencies.** No `node_modules` risk, no supply chain vulnerabilities, no version conflicts. The entire engine is built on Node.js core APIs only.
+
+**Per-instance architecture.** Every `new Logs()` call is a fully independent, self-contained logging instance. Each instance manages its own queue, its own write stream, its own rotation cycle, and its own backpressure. There is no global state. Instances never interfere with each other.
+
+**Built-in backpressure.** Silo's engine automatically gates writes when the internal queue reaches capacity, then releases when it drains. Your application never runs out of memory from a logging spike. No configuration required — it works out of the box.
+
+**Automatic file rotation.** Log files rotate automatically at a configurable size threshold (default 250MB). Rotated files are indexed sequentially. Your disk never fills up from runaway log growth.
+
+**Proven at scale.** The only Node.js logger publicly benchmarked at 1 billion logs with documented memory stability.
+
+---
+
+## Install
+
+```bash
+npm install @flowrdesk/silo
+```
+
+---
+
+## Quick Start
+
+```js
+import Logs from "@flowrdesk/silo";
+
+const logger = new Logs({
+  filename: "app",
+  toFile: true,
+  toTerminal: false,
+});
+
+logger.logg({ event: "server_start", port: 3000 });
+logger.logg({
+  event: "request",
+  method: "GET",
+  path: "/api/users",
+  status: 200,
+});
+
+// Flush before process exit to ensure all logs are written
+await logger.flush();
+```
+
+Logs are written to a `.logs/` folder in your project root by default.
+
+---
+
+## Configuration
+
+### Constructor Options
+
+```js
+const logger = new Logs({
+  filename, // Required. Base name for log files. e.g. 'app' → app_2026-01-01.log
+  level, // Optional. String or number. Added to every log entry as "level".
+  maxSize, // Optional. Max log file size in MB before rotation. Default: 250
+  txtColor, // Optional. Terminal text color. See color options below.
+  bgColor, // Optional. Terminal background color. See color options below.
+  benchmark, // Optional. Boolean. Strips metadata for raw throughput testing. Default: false
+  toFile, // Optional. Boolean. Write logs to file. Default: true
+  toTerminal, // Optional. Boolean. Write logs to terminal. Default: true
+  terminalRaw, // Optional. Boolean. Use raw terminal output (no ANSI formatting). Default: false
+  maxQueueDepth, // Optional. Max items in write queue before backpressure activates. Default: 50_000
+});
+```
+
+### Global Configuration
+
+```js
+import Logs, { configuration, bufferAutoTune } from "@flowrdesk/silo";
+
+// Set a custom log directory (must be called before creating instances)
+configuration({ setDir: "my_logs" });
+
+// Set a custom write buffer size in KB (must be called before creating instances)
+configuration({ setBufferSize: 512 });
+
+// Auto-detect CPU and set optimal buffer size automatically
+bufferAutoTune(); // Sets 64KB, 128KB, or 256KB based on detected CPU tier
+```
+
+> **Important:** Call `configuration()` and `bufferAutoTune()` before creating any logger instances. These settings apply globally and do not retroactively affect instances that have already been created.
+
+---
+
+## API
+
+### `logger.logg(data)`
+
+The unified logging method. Writes to file and/or terminal based on constructor settings. Accepts any object or value.
+
+```js
+logger.logg({ event: "purchase", userId: "u_123", amount: 49.99 });
+```
+
+### `logger.file(data)`
+
+Write directly to file only, bypassing terminal output. Async — await it in high-volume loops.
+
+```js
+await logger.file({ event: "batch_process", item: "SKU-9981" });
+```
+
+### `logger.terminal(data)`
+
+Write directly to terminal only, bypassing file output.
+
+### `logger.terminal_raw(data)`
+
+Write to terminal without ANSI color formatting. Used for benchmarking and raw output scenarios.
+
+### `await logger.flush()`
+
+Waits for all queued logs to be written to disk and closes the write stream cleanly. Always call this before process exit.
+
+```js
+process.on("SIGTERM", async () => {
+  await logger.flush();
+  process.exit(0);
+});
+```
+
+### `await logger.waitForQueueSpace()`
+
+Parks the caller until the internal queue drains below 50% capacity. Available for power users running high-volume batch scenarios who want explicit backpressure control. Regular usage does not require this — the engine self-regulates.
+
+```js
+// High-volume batch scenario
+for (const record of massiveDataset) {
+  await logger.waitForQueueSpace();
+  logger.file(record);
+}
+```
+
+### `await logger.terminalFlush()`
+
+Flushes the terminal output queue.
+
+### `await logger.rawTerminalFlush()`
+
+Flushes the raw terminal output queue.
+
+---
+
+## Benchmark Results
+
+All benchmarks run on Windows, Node.js with `--expose-gc`, GC forced before each measurement. Tests are included in the package — run them yourself to verify on your own hardware.
+
+### Fair Fight: 1,000,000 Logs (File Output)
+
+| Engine   | LPS           | Memory       |
+| -------- | ------------- | ------------ |
+| **Silo** | **1,535,373** | **13.58 MB** |
+| Pino     | 1,559,696     | 298.23 MB    |
+| Winston  | 117,211       | 1,403.01 MB  |
+
+Silo matches Pino's throughput at **22x less memory**. Winston uses over 100x more memory at 13x slower speed.
+
+### Scale Test: Where Others Drop Out
+
+| Engine   | 25M Logs                      | 100M Logs            | 1B Logs      |
+| -------- | ----------------------------- | -------------------- | ------------ |
+| **Silo** | ✅ 91.16 MB                   | ✅ 115.96 MB         | ✅ 125.53 MB |
+| Pino     | ❌ 11,063 MB — heap exhausted | ❌                   | ❌           |
+| Winston  | ⚠️ 111 MB / 51K LPS           | ❌ estimated 60+ min | ❌           |
+
+### 1 Billion Log Run
+
+```
+Total logs written  : 1,000,000,000
+File rotations      : 255 (automatic, zero logs dropped)
+Throughput          : 1,084,801 LPS sustained
+Memory overhead     : 125.53 MB
+CPU usage           : 1.61%
+```
+
+Pino and Winston cannot complete a 25 million log run without exhausting available heap. Silo ran 1 billion logs — 40x further — with 126MB of memory.
+
+### Sustained Load Memory Stability (60 seconds)
+
+```
+Total logs written  : 34,557,603
+Avg LPS             : 575,557
+Memory behavior     : Stable — normal GC oscillation under sustained load
+Memory slope        : 75.29 MB/min (oscillating, not accumulating)
+```
+
+---
+
+## Run The Tests Yourself
+
+```bash
+# Benchmark — Silo (time, lps, cpu, mem)
+# Default: 1,000,000 Logs Created
+npm run benchmark
+
+# Custom Benchmark Logs Creation
+npm run benchmark -- 500000
+
+# Sustained memory stability test (60 seconds)
+npm run memory-test
+
+# Multi-instance stress test
+# Default: 30 instances, 10,000 logs each
+npm run instance-stress
+
+# Custom instance count and logs per instance
+npm run instance-stress -- 500 20000
+```
+
+> Run benchmarks with `node --expose-gc` for consistent memory readings. The npm scripts include this flag automatically.
+
+---
+
+## Multi-Instance Usage
+
+Each instance is fully independent. You can run hundreds of instances simultaneously with different configurations:
+
+```js
+import Logs, { configuration } from "@flowrdesk/silo";
+
+// Service-level loggers — each with its own file, rotation, and queue
+const appLogger = new Logs({
+  filename: "app",
+  toFile: true,
+  toTerminal: false,
+});
+const errorLogger = new Logs({
+  filename: "errors",
+  toFile: true,
+  toTerminal: true,
+  level: "error",
+});
+const auditLogger = new Logs({
+  filename: "audit",
+  toFile: true,
+  toTerminal: false,
+  maxSize: 500,
+});
+
+appLogger.logg({ event: "request", path: "/checkout" });
+errorLogger.logg({ event: "unhandled_exception", stack: err.stack });
+auditLogger.logg({ event: "payment_processed", userId: "u_882", amount: 99.0 });
+```
+
+---
+
+## Production Usage Pattern
+
+```js
+import Logs from "@flowrdesk/silo";
+
+const logger = new Logs({
+  filename: "api",
+  level: "info",
+  toFile: true,
+  toTerminal: process.env.NODE_ENV !== "production",
+});
+
+// In an Express route
+app.get("/users/:id", async (req, res) => {
+  logger.logg({
+    event: "request",
+    method: "GET",
+    path: req.path,
+    userId: req.params.id,
+  });
+
+  try {
+    const user = await db.getUser(req.params.id);
+    logger.logg({ event: "response", status: 200, userId: req.params.id });
+    res.json(user);
+  } catch (err) {
+    logger.logg({ event: "error", status: 500, message: err.message });
+    res.status(500).json({ error: "Internal server error" });
+  }
+});
+
+// Graceful shutdown
+process.on("SIGTERM", async () => {
+  await logger.flush();
+  process.exit(0);
+});
+```
+
+---
+
+## Part of the Silo Series
+
+Silo Free is the open-source core engine. The Flowrdesk Silo Series builds on this foundation:
+
+| Product        | Description                                        | Availability   |
+| -------------- | -------------------------------------------------- | -------------- |
+| **Silo Free**  | Core engine — what you're using now                | ✅ Available   |
+| **Silo Basic** | PII scrubbing + automated log lifecycle management | 🔜 Coming Soon |
+| **Silo Guard** | Enterprise compliance tier                         | 🔜 Coming Soon |
+
+Learn more at [flowrdesk.com](https://flowrdesk.com)
+
+---
+
+## License
+
+Apache-2.0 — see [LICENSE](./LICENSE) for full text.  
+Copyright 2026 John Spriggs (Flowrdesk LLC) — see [NOTICE](./NOTICE).

package/index.js

@@ -0,0 +1,20 @@
+/**
+ * Copyright 2026 John Spriggs (Flowrdesk LLC)
+ *
+ * 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.
+ */
+
+import Logs from "./src/logs.js";
+import { configuration, bufferAutoTune } from "./src/settings.js";
+
+export {Logs as default, configuration, bufferAutoTune}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@flowrdesk/silo",
+  "version": "1.0.0",
+  "description": "The core high-performance, zero-dependency logging engine behind the Flowrdesk Silo series. Built for massive scale and backpressure stability.",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "instance-stress": "node --expose-gc --max-old-space-size=12288 ./tests/log_instance_test.js",
+    "memory-test": "node --expose-gc ./tests/memory_test.js",
+    "benchmark": "node --expose-gc ./tests/demo.js"
+  },
+  "keywords": [
+    "flowrdesk",
+    "silo",
+    "performance",
+    "logger",
+    "zero-dependency",
+    "benchmark",
+    "logging",
+    "stability",
+    "backpressure"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/spriggs81/silo.git"
+  },
+  "homepage": "https://flowrdesk.com",
+  "bugs": {
+      "url": "https://github.com/spriggs81/silo/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "author": "John Spriggs <hello@flowrdesk.com> (Flowrdesk LLC)",
+  "license": "Apache-2.0"
+}