skoshx / logpile

🪵 A simple & tiny logging library with supercharged search features

🪵 A simple & tiny logging library with supercharged search features

Logs are an integral part of building good software, especially APIs. It's important for logs to be easy to write in code, and easy to connect to some larger entity. This is where logpile comes in. This library is perfect for needing a versatile logger that works for anything, and that can flexibly search logs.

A perfect example is an API, where errors are logged with a reference to the users account. You can use logpile to search for all the error logs associated with that user, and display them to the API user.

Install

$ yarn add logpile

or with npm

$ npm install --save logpile

Features

• Tiny, Simple & Extendable
• Extendable output medium (stdout, file, database or custom)
• Supercharged search features (text, object, fuzzy)
• Hides sensitive values from the logs
• Fully TypeScript

Usage

import { createLogger } from 'logpile';

const logger = createLogger({
  persist: [consolePersist({ level: 'error' }), filePersist()],
  retrieve: fileRetrieve(),
});

// you can pass anything to the function
logger.warn('hello world', { some: 'object' }, 'another message');
/*=> {
  timestamp: "2022-05-13T01:19:18.402Z",
  level: "warning",
  message: "hello world",
  message2: "another message",
  some: "object"
}*/

// you can search all logs with useful features
// search logs containing value 'hello world', in the last hour

/**
 * You can search all logs with useful features.
 * Search logs containing value 'hello world', from the last hour
 */
const logs = logger.searchLogs('hello world', { time: '1h' });

License

logpile is released under the MIT License.

TODO

• Improved search functionality
  • Search options for time (vercel's ms type eg. { time: '1wk' })
  • Search where timestamp between 2 values
  • Search items can be ranges (eg. { count > 2 && count < 4 })
• Deno release