@mastra/loggers 0.0.0-commonjs-20250227130920

package/LICENSE

@@ -0,0 +1,44 @@
+Elastic License 2.0 (ELv2)
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,146 @@
+# @mastra/loggers
+
+A collection of logging transport implementations for Mastra, extending the `LoggerTransport` class from `@mastra/core`.
+
+## Installation
+
+```bash
+npm install @mastra/loggers
+```
+
+## Available Transports
+
+### File Transport
+
+A transport that writes logs to a local file system.
+
+```typescript
+import { FileTransport } from '@mastra/loggers';
+
+const fileLogger = new FileTransport({
+  path: '/path/to/logs/app.log',
+});
+```
+
+#### Configuration
+
+- `path`: Absolute path to the log file (must exist)
+
+#### Features
+
+- Append-mode logging
+- Automatic stream cleanup
+- JSON log parsing
+- Query logs by run ID
+- Stream-based implementation
+
+### Upstash Transport
+
+A transport that sends logs to Upstash Redis with batching and auto-trimming capabilities.
+
+```typescript
+import { UpstashTransport } from '@mastra/loggers';
+
+const upstashLogger = new UpstashTransport({
+  upstashUrl: 'https://your-instance.upstash.io',
+  upstashToken: 'your-token',
+  listName: 'application-logs', // optional
+  maxListLength: 10000, // optional
+  batchSize: 100, // optional
+  flushInterval: 10000, // optional
+});
+```
+
+#### Configuration
+
+Required:
+
+- `upstashUrl`: Your Upstash Redis instance URL
+- `upstashToken`: Your Upstash authentication token
+
+Optional:
+
+- `listName`: Redis list name for logs (default: 'application-logs')
+- `maxListLength`: Maximum number of logs to keep (default: 10000)
+- `batchSize`: Number of logs to send in one batch (default: 100)
+- `flushInterval`: Milliseconds between flush attempts (default: 10000)
+
+#### Features
+
+- Batched log writing
+- Automatic log rotation (LTRIM)
+- Configurable buffer size
+- Automatic retry on failure
+- Query logs by run ID
+- JSON log formatting
+- Timestamp auto-injection
+- Graceful shutdown with final flush
+
+## Usage with Mastra Core
+
+Both transports implement the `LoggerTransport` interface from `@mastra/core`:
+
+```typescript
+import { Logger } from '@mastra/core/logger';
+import { FileTransport, UpstashTransport } from '@mastra/loggers';
+
+// Create transports
+const fileTransport = new FileTransport({
+  path: '/var/log/app.log',
+});
+
+const upstashTransport = new UpstashTransport({
+  upstashUrl: process.env.UPSTASH_URL!,
+  upstashToken: process.env.UPSTASH_TOKEN!,
+});
+
+// Create logger with multiple transports
+const logger = new Logger({
+  transports: [fileTransport, upstashTransport],
+});
+
+// Log messages
+logger.info('Hello world', { metadata: 'value' });
+
+// Query logs
+const allLogs = await fileTransport.getLogs();
+const runLogs = await upstashTransport.getLogsByRunId({ runId: 'abc-123' });
+```
+
+## Log Message Format
+
+Both transports handle log messages in JSON format with the following structure:
+
+```typescript
+interface BaseLogMessage {
+  time?: number; // Timestamp (auto-injected if not present)
+  level?: string; // Log level
+  msg?: {
+    // Message content
+    runId?: string; // Optional run ID for grouping logs
+    [key: string]: any;
+  };
+  [key: string]: any;
+}
+```
+
+## Error Handling
+
+Both transports include robust error handling:
+
+- File Transport:
+
+  - Validates file path existence
+  - Handles stream errors
+  - Graceful cleanup on destroy
+
+- Upstash Transport:
+  - Validates required configuration
+  - Retries failed batches
+  - Buffers logs during outages
+  - Graceful shutdown with final flush
+
+## Related Links
+
+- [Upstash Redis Documentation](https://docs.upstash.com/redis)
+- [Node.js Stream Documentation](https://nodejs.org/api/stream.html)

package/dist/_tsup-dts-rollup.d.cts

@@ -0,0 +1,50 @@
+import type { BaseLogMessage } from '@mastra/core/logger';
+import { LoggerTransport } from '@mastra/core/logger';
+import type { WriteStream } from 'fs';
+
+export declare class FileTransport extends LoggerTransport {
+    path: string;
+    fileStream: WriteStream;
+    constructor({ path }: {
+        path: string;
+    });
+    _transform(chunk: any, _encoding: string, callback: (error: Error | null, chunk: any) => void): void;
+    _flush(callback: Function): void;
+    _write(chunk: any, encoding?: string, callback?: (error?: Error | null) => void): boolean;
+    _destroy(error: Error, callback: Function): void;
+    getLogs(): Promise<BaseLogMessage[]>;
+    getLogsByRunId({ runId }: {
+        runId: string;
+    }): Promise<BaseLogMessage[]>;
+}
+
+export declare class UpstashTransport extends LoggerTransport {
+    upstashUrl: string;
+    upstashToken: string;
+    listName: string;
+    maxListLength: number;
+    batchSize: number;
+    flushInterval: number;
+    logBuffer: any[];
+    lastFlush: number;
+    flushIntervalId: NodeJS.Timeout;
+    constructor(opts: {
+        listName?: string;
+        maxListLength?: number;
+        batchSize?: number;
+        upstashUrl: string;
+        flushInterval?: number;
+        upstashToken: string;
+    });
+    private executeUpstashCommand;
+    _flush(): Promise<void>;
+    _write(chunk: any, encoding?: string, callback?: (error?: Error | null) => void): boolean;
+    _transform(chunk: string, _enc: string, cb: Function): void;
+    _destroy(err: Error, cb: Function): void;
+    getLogs(): Promise<BaseLogMessage[]>;
+    getLogsByRunId({ runId }: {
+        runId: string;
+    }): Promise<BaseLogMessage[]>;
+}
+
+export { }

package/dist/_tsup-dts-rollup.d.ts

@@ -0,0 +1,50 @@
+import type { BaseLogMessage } from '@mastra/core/logger';
+import { LoggerTransport } from '@mastra/core/logger';
+import type { WriteStream } from 'fs';
+
+export declare class FileTransport extends LoggerTransport {
+    path: string;
+    fileStream: WriteStream;
+    constructor({ path }: {
+        path: string;
+    });
+    _transform(chunk: any, _encoding: string, callback: (error: Error | null, chunk: any) => void): void;
+    _flush(callback: Function): void;
+    _write(chunk: any, encoding?: string, callback?: (error?: Error | null) => void): boolean;
+    _destroy(error: Error, callback: Function): void;
+    getLogs(): Promise<BaseLogMessage[]>;
+    getLogsByRunId({ runId }: {
+        runId: string;
+    }): Promise<BaseLogMessage[]>;
+}
+
+export declare class UpstashTransport extends LoggerTransport {
+    upstashUrl: string;
+    upstashToken: string;
+    listName: string;
+    maxListLength: number;
+    batchSize: number;
+    flushInterval: number;
+    logBuffer: any[];
+    lastFlush: number;
+    flushIntervalId: NodeJS.Timeout;
+    constructor(opts: {
+        listName?: string;
+        maxListLength?: number;
+        batchSize?: number;
+        upstashUrl: string;
+        flushInterval?: number;
+        upstashToken: string;
+    });
+    private executeUpstashCommand;
+    _flush(): Promise<void>;
+    _write(chunk: any, encoding?: string, callback?: (error?: Error | null) => void): boolean;
+    _transform(chunk: string, _enc: string, cb: Function): void;
+    _destroy(err: Error, cb: Function): void;
+    getLogs(): Promise<BaseLogMessage[]>;
+    getLogsByRunId({ runId }: {
+        runId: string;
+    }): Promise<BaseLogMessage[]>;
+}
+
+export { }

package/dist/file/index.cjs

@@ -0,0 +1,63 @@
+'use strict';
+
+var fs = require('fs');
+var logger = require('@mastra/core/logger');
+
+// src/file/index.ts
+var FileTransport = class extends logger.LoggerTransport {
+  path;
+  fileStream;
+  constructor({ path }) {
+    super({ objectMode: true });
+    this.path = path;
+    if (!fs.existsSync(this.path)) {
+      console.log(this.path);
+      throw new Error("File path does not exist");
+    }
+    this.fileStream = fs.createWriteStream(this.path, { flags: "a" });
+  }
+  _transform(chunk, _encoding, callback) {
+    try {
+      this.fileStream.write(chunk);
+    } catch (error) {
+      console.error("Error parsing log entry:", error);
+    }
+    callback(null, chunk);
+  }
+  _flush(callback) {
+    this.fileStream.end(() => {
+      callback();
+    });
+  }
+  _write(chunk, encoding, callback) {
+    if (typeof callback === "function") {
+      this._transform(chunk, encoding || "utf8", callback);
+      return true;
+    }
+    this._transform(chunk, encoding || "utf8", (error) => {
+      if (error) console.error("Transform error in write:", error);
+    });
+    return true;
+  }
+  // Clean up resources
+  _destroy(error, callback) {
+    if (this.fileStream) {
+      this.fileStream.destroy(error);
+    }
+    callback(error);
+  }
+  async getLogs() {
+    return fs.readFileSync(this.path, "utf8").split("\n").filter(Boolean).map((log) => JSON.parse(log));
+  }
+  async getLogsByRunId({ runId }) {
+    try {
+      const allLogs = await this.getLogs();
+      return allLogs.filter((log) => log?.runId === runId) || [];
+    } catch (error) {
+      console.error("Error getting logs by runId from Upstash:", error);
+      return [];
+    }
+  }
+};
+
+exports.FileTransport = FileTransport;

package/dist/file/index.d.cts

@@ -0,0 +1 @@
+export { FileTransport } from '../_tsup-dts-rollup.cjs';

package/dist/file/index.d.ts

@@ -0,0 +1 @@
+export { FileTransport } from '../_tsup-dts-rollup.js';

package/dist/file/index.js

@@ -0,0 +1,61 @@
+import { existsSync, createWriteStream, readFileSync } from 'fs';
+import { LoggerTransport } from '@mastra/core/logger';
+
+// src/file/index.ts
+var FileTransport = class extends LoggerTransport {
+  path;
+  fileStream;
+  constructor({ path }) {
+    super({ objectMode: true });
+    this.path = path;
+    if (!existsSync(this.path)) {
+      console.log(this.path);
+      throw new Error("File path does not exist");
+    }
+    this.fileStream = createWriteStream(this.path, { flags: "a" });
+  }
+  _transform(chunk, _encoding, callback) {
+    try {
+      this.fileStream.write(chunk);
+    } catch (error) {
+      console.error("Error parsing log entry:", error);
+    }
+    callback(null, chunk);
+  }
+  _flush(callback) {
+    this.fileStream.end(() => {
+      callback();
+    });
+  }
+  _write(chunk, encoding, callback) {
+    if (typeof callback === "function") {
+      this._transform(chunk, encoding || "utf8", callback);
+      return true;
+    }
+    this._transform(chunk, encoding || "utf8", (error) => {
+      if (error) console.error("Transform error in write:", error);
+    });
+    return true;
+  }
+  // Clean up resources
+  _destroy(error, callback) {
+    if (this.fileStream) {
+      this.fileStream.destroy(error);
+    }
+    callback(error);
+  }
+  async getLogs() {
+    return readFileSync(this.path, "utf8").split("\n").filter(Boolean).map((log) => JSON.parse(log));
+  }
+  async getLogsByRunId({ runId }) {
+    try {
+      const allLogs = await this.getLogs();
+      return allLogs.filter((log) => log?.runId === runId) || [];
+    } catch (error) {
+      console.error("Error getting logs by runId from Upstash:", error);
+      return [];
+    }
+  }
+};
+
+export { FileTransport };

package/dist/upstash/index.cjs

@@ -0,0 +1,133 @@
+'use strict';
+
+var logger = require('@mastra/core/logger');
+
+// src/upstash/index.ts
+var UpstashTransport = class extends logger.LoggerTransport {
+  upstashUrl;
+  upstashToken;
+  listName;
+  maxListLength;
+  batchSize;
+  flushInterval;
+  logBuffer;
+  lastFlush;
+  flushIntervalId;
+  constructor(opts) {
+    super({ objectMode: true });
+    if (!opts.upstashUrl || !opts.upstashToken) {
+      throw new Error("Upstash URL and token are required");
+    }
+    this.upstashUrl = opts.upstashUrl;
+    this.upstashToken = opts.upstashToken;
+    this.listName = opts.listName || "application-logs";
+    this.maxListLength = opts.maxListLength || 1e4;
+    this.batchSize = opts.batchSize || 100;
+    this.flushInterval = opts.flushInterval || 1e4;
+    this.logBuffer = [];
+    this.lastFlush = Date.now();
+    this.flushIntervalId = setInterval(() => {
+      this._flush().catch((err) => {
+        console.error("Error flushing logs to Upstash:", err);
+      });
+    }, this.flushInterval);
+  }
+  async executeUpstashCommand(command) {
+    const response = await fetch(`${this.upstashUrl}/pipeline`, {
+      method: "POST",
+      headers: {
+        Authorization: `Bearer ${this.upstashToken}`,
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify([command])
+    });
+    if (!response.ok) {
+      throw new Error(`Failed to execute Upstash command: ${response.statusText}`);
+    }
+    return response.json();
+  }
+  async _flush() {
+    if (this.logBuffer.length === 0) {
+      return;
+    }
+    const now = Date.now();
+    const logs = this.logBuffer.splice(0, this.batchSize);
+    try {
+      const command = ["LPUSH", this.listName, ...logs.map((log) => JSON.stringify(log))];
+      if (this.maxListLength > 0) {
+        command.push("LTRIM", this.listName, 0, this.maxListLength - 1);
+      }
+      await this.executeUpstashCommand(command);
+      this.lastFlush = now;
+    } catch (error) {
+      this.logBuffer.unshift(...logs);
+      throw error;
+    }
+  }
+  _write(chunk, encoding, callback) {
+    if (typeof callback === "function") {
+      this._transform(chunk, encoding || "utf8", callback);
+      return true;
+    }
+    this._transform(chunk, encoding || "utf8", (error) => {
+      if (error) console.error("Transform error in write:", error);
+    });
+    return true;
+  }
+  _transform(chunk, _enc, cb) {
+    try {
+      const log = typeof chunk === "string" ? JSON.parse(chunk) : chunk;
+      if (!log.time) {
+        log.time = Date.now();
+      }
+      this.logBuffer.push(log);
+      if (this.logBuffer.length >= this.batchSize) {
+        this._flush().catch((err) => {
+          console.error("Error flushing logs to Upstash:", err);
+        });
+      }
+      cb(null, chunk);
+    } catch (error) {
+      cb(error);
+    }
+  }
+  _destroy(err, cb) {
+    clearInterval(this.flushIntervalId);
+    if (this.logBuffer.length > 0) {
+      this._flush().then(() => cb(err)).catch((flushErr) => {
+        console.error("Error in final flush:", flushErr);
+        cb(err || flushErr);
+      });
+    } else {
+      cb(err);
+    }
+  }
+  async getLogs() {
+    try {
+      const command = ["LRANGE", this.listName, 0, -1];
+      const response = await this.executeUpstashCommand(command);
+      return response?.[0]?.result.map((log) => {
+        try {
+          return JSON.parse(log);
+        } catch {
+          return "";
+        }
+      });
+    } catch (error) {
+      console.error("Error getting logs from Upstash:", error);
+      return [];
+    }
+  }
+  async getLogsByRunId({ runId }) {
+    try {
+      const allLogs = await this.getLogs();
+      const logs = allLogs.filter((log) => log.runId === runId) || [];
+      return logs;
+    } catch (error) {
+      console.error("Error getting logs by runId from Upstash:", error);
+      return [];
+    }
+  }
+};
+
+exports.UpstashTransport = UpstashTransport;

package/dist/upstash/index.d.cts

@@ -0,0 +1 @@
+export { UpstashTransport } from '../_tsup-dts-rollup.cjs';

package/dist/upstash/index.d.ts

@@ -0,0 +1 @@
+export { UpstashTransport } from '../_tsup-dts-rollup.js';

package/dist/upstash/index.js

@@ -0,0 +1,131 @@
+import { LoggerTransport } from '@mastra/core/logger';
+
+// src/upstash/index.ts
+var UpstashTransport = class extends LoggerTransport {
+  upstashUrl;
+  upstashToken;
+  listName;
+  maxListLength;
+  batchSize;
+  flushInterval;
+  logBuffer;
+  lastFlush;
+  flushIntervalId;
+  constructor(opts) {
+    super({ objectMode: true });
+    if (!opts.upstashUrl || !opts.upstashToken) {
+      throw new Error("Upstash URL and token are required");
+    }
+    this.upstashUrl = opts.upstashUrl;
+    this.upstashToken = opts.upstashToken;
+    this.listName = opts.listName || "application-logs";
+    this.maxListLength = opts.maxListLength || 1e4;
+    this.batchSize = opts.batchSize || 100;
+    this.flushInterval = opts.flushInterval || 1e4;
+    this.logBuffer = [];
+    this.lastFlush = Date.now();
+    this.flushIntervalId = setInterval(() => {
+      this._flush().catch((err) => {
+        console.error("Error flushing logs to Upstash:", err);
+      });
+    }, this.flushInterval);
+  }
+  async executeUpstashCommand(command) {
+    const response = await fetch(`${this.upstashUrl}/pipeline`, {
+      method: "POST",
+      headers: {
+        Authorization: `Bearer ${this.upstashToken}`,
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify([command])
+    });
+    if (!response.ok) {
+      throw new Error(`Failed to execute Upstash command: ${response.statusText}`);
+    }
+    return response.json();
+  }
+  async _flush() {
+    if (this.logBuffer.length === 0) {
+      return;
+    }
+    const now = Date.now();
+    const logs = this.logBuffer.splice(0, this.batchSize);
+    try {
+      const command = ["LPUSH", this.listName, ...logs.map((log) => JSON.stringify(log))];
+      if (this.maxListLength > 0) {
+        command.push("LTRIM", this.listName, 0, this.maxListLength - 1);
+      }
+      await this.executeUpstashCommand(command);
+      this.lastFlush = now;
+    } catch (error) {
+      this.logBuffer.unshift(...logs);
+      throw error;
+    }
+  }
+  _write(chunk, encoding, callback) {
+    if (typeof callback === "function") {
+      this._transform(chunk, encoding || "utf8", callback);
+      return true;
+    }
+    this._transform(chunk, encoding || "utf8", (error) => {
+      if (error) console.error("Transform error in write:", error);
+    });
+    return true;
+  }
+  _transform(chunk, _enc, cb) {
+    try {
+      const log = typeof chunk === "string" ? JSON.parse(chunk) : chunk;
+      if (!log.time) {
+        log.time = Date.now();
+      }
+      this.logBuffer.push(log);
+      if (this.logBuffer.length >= this.batchSize) {
+        this._flush().catch((err) => {
+          console.error("Error flushing logs to Upstash:", err);
+        });
+      }
+      cb(null, chunk);
+    } catch (error) {
+      cb(error);
+    }
+  }
+  _destroy(err, cb) {
+    clearInterval(this.flushIntervalId);
+    if (this.logBuffer.length > 0) {
+      this._flush().then(() => cb(err)).catch((flushErr) => {
+        console.error("Error in final flush:", flushErr);
+        cb(err || flushErr);
+      });
+    } else {
+      cb(err);
+    }
+  }
+  async getLogs() {
+    try {
+      const command = ["LRANGE", this.listName, 0, -1];
+      const response = await this.executeUpstashCommand(command);
+      return response?.[0]?.result.map((log) => {
+        try {
+          return JSON.parse(log);
+        } catch {
+          return "";
+        }
+      });
+    } catch (error) {
+      console.error("Error getting logs from Upstash:", error);
+      return [];
+    }
+  }
+  async getLogsByRunId({ runId }) {
+    try {
+      const allLogs = await this.getLogs();
+      const logs = allLogs.filter((log) => log.runId === runId) || [];
+      return logs;
+    } catch (error) {
+      console.error("Error getting logs by runId from Upstash:", error);
+      return [];
+    }
+  }
+};
+
+export { UpstashTransport };