@llmaudit/logship

Logship (by @llmaudit)

A high-performance, lightweight Node.js log shipping agent designed to tail files and pump logs to the LLM Audit Ingestion Server.

Features

• Zero Dependencies: Built entirely with native Node.js modules for maximum stability and security.
• Smart Tailing: Monitors multiple files simultaneously and resumes from where it left off.
• Resilient: Automatic reconnection with exponential backoff and persistent registry for tracking file positions across restarts.
• Performance Focused: Batches logs automatically to minimize HTTP overhead and server load.
• Zero Config Mode: Run it entirely using CLI flags without creating any files.

Installation

npm install @llmaudit/logship

CLI Usage (The easy way)

Option A: Using CLI Flags (Zero Config)

Run Logship without creating a configuration file:

npx @llmaudit/logship -k your-key -f access.log,error.log

Option B: Using a Config File

If you have many logs or complex settings, use a JSON file:

npx @llmaudit/logship logship.config.json

Option C: Default Lookup

If you have a file named logship.config.json in your current folder, simply run:

npx @llmaudit/logship

CLI Configuration Options

Flag	Short	Description
--api-key	-k	Your unique API Key
--endpoint	-e	Ingestion Server URL (Defaults to https://log.llmaudit.ai)
--files	-f	Comma-separated list of log files
--env		Environment tag (prod, staging, dev)
--service	-s	Name of the service
--interval		Flush interval in ms
--batch-size		Max logs per batch

Library Usage

const { initLogger } = require('@llmaudit/logship');

const agent = initLogger({
  apiKey: "your-api-key",
  logFiles: ["./app.log"],
  env: "prod",
  service: "my-app"
  // endpoint: "https://log.llmaudit.ai" (Optional: Defaulted for you)
});

// agent.shutdown();