logestic

Logestic

An advanced and customisable logging library for ElysiaJS

Table of Contents

• Logestic
• Table of Contents
• Installation
• Usage
  • Preset request logging
  • Custom request logging
• Contributing Guidelines
• License
• Authors

Installation

Add the package with your favourite package manager to your Elysia Project.

  npm install --save logestic

  # or
  yarn add logestic

  # or
  pnpm add logestic

  # or
  bun add logestic

Note: You must have elysia@1.0 installed in your project.

Usage

There are two ways to add logging to your Elysia application.

Preset request logging

Currently there are these presets availble to use.

import { Elysia } from 'elysia';
import { Logestic } from 'logestic';

const app = new Elysia()
  .use(Logestic.preset('common'))
  .get('/', () => "Hello from server")
  .listen(5566);

Custom request logging

If you don't like any of presets, you can configure Logestic to log your requests in your way.

1. Create a Logestic instance, optionally where you wish to log.
2. Call use to tell Logestic the information you wish to use.
3. Finally, create an Elysia instance on custom with the formating function.

// ./logger.ts
import { Logestic } from 'logestic';

const fileLogger = (msg: string) => {
  const logFile = Bun.file('requests.log');
  const writer = logFile.writer();

  writer.write(msg);
  writer.flush();
}

// exports an Elysia instance
export new Logestic(fileLogger)
  .use(['method', 'path', 'time', 'status'])
  .custom(({ method, path, time, status }) => {
    return `[${time}]: ${method} ${path} | ${status}`
  })


// ./index.ts
import myLogger from './logger'

const app = new Elysia()
  .use(myLogger)
  .get('/', () => "Hello from server")
  .listen(5566);

Consider contibuting your own preset; check contributing guidelines.

Contributing Guidelines

See CONTRIBUTING.md

License

MIT

Authors

• @cybercoder-naj