@bogeychan/elysia-logger

@bogeychan/elysia-logger

A plugin for Elysia.js for logging using the pino library

Installation

bun add @bogeychan/elysia-logger

Usage

import { Elysia } from 'elysia';
import { logger } from '@bogeychan/elysia-logger';

const app = new Elysia()
  .use(
    logger({
      level: 'error'
    })
  )
  .get('/', (ctx) => {
    ctx.log.error(ctx, 'Context');
    ctx.log.info(ctx.request, 'Request'); // noop

    return 'Hello World';
  })
  .listen(8080);

console.log(`Listening on http://${app.server!.hostname}:${app.server!.port}`);

Log to a file, or

import { fileLogger } from '@bogeychan/elysia-logger';

fileLogger({
  file: './my.log'
});

Pipe the log entries into a stream

import { logger } from '@bogeychan/elysia-logger';

logger({
  stream: ... // default -> console output
});

Include additional request context info for debugging tools

import { logger } from '@bogeychan/elysia-logger';

const myPlugin = () => (app: Elysia) => app.decorate('myProperty', 42);

// ...

app = app.use(myPlugin());

app
  .use(
    logger({
      /**
       * This function will be invoked for each `log`-method called with `context`
       * where you can pass additional properties that need to be logged
       */
      customProps(
        ctx: ElysiaContextForInstance<InferElysiaInstance<typeof app>>
      ) {
        return {
          params: ctx.params,
          query: ctx.query,
          myProperty: ctx.myProperty
        };
      }
    })
  )
  .get('/', (ctx) => {
    ctx.log.info(ctx, 'Context');

    return 'with-context';
  })
  .listen(8080);

You can find the entire example in the examples folder.

Customize the logger name in the request context

import { Elysia } from 'elysia';
import { logger } from '@bogeychan/elysia-logger';

const app = new Elysia()
  .use(
    logger({
      contextKeyName: 'myLogger'
    })
  )
  .get('/', (ctx) => {
    // property "myLogger" is available instead of "log"
    ctx.myLogger.info(ctx.request, 'Request');

    return 'Hello World';
  })
  .listen(8080);

console.log(`Listening on http://${app.server!.hostname}:${app.server!.port}`);

Checkout the examples folder on github for further use cases such as the integration of pino-pretty for readable console outputs.

Author

bogeychan

License

MIT

Changelog

0.0.5 - 08 Sep 2023

Feature:

• update to elysia 0.6.19