@daki/logr v2.7.0

@daki/logr - A Library for Standardizing Logs

Overview

This TypeScript log standardization library offers an easy and flexible way to standardize your application's logs. It offers the ability to customize the logging behavior of exceptions, transactions and validations, allowing you to adapt the library to the specific needs of your project.

Installation

To start using @daki/logr, you can install it via npm or yarn:

npm install @daki/logr
# or
yarn add @daki/logr

Main features

• Catch Exception
• Catch Transaction TODO

Catch exception

We provide two ways to catch exceptions:

• the CatchException decorator to use in your methods
• the catchException function so that you don't have to use classes to use the library

Configuration options

Basic usage

Decorator:

import { CatchException } from '@daki/logr';

export class UserController {
  @CatchException({
    kind: 'Application',
  })
  public async getById(id: string) {
    // Your logic for getting a user
  }
}

Function:

import { catchException } from '@daki/logr';

export const getUserById = catchException(async (id: string) => {
  // Your logic for getting a user
}, {
  kind: 'Application',
});

import { catchException, CatchExceptionOptions } from '@daki/logr';

const options: CatchExceptionOptions = {
  kind: 'Application',
}

async function handleGetUserById(id: string) {
  // Your logic for getting a user
}

export const getUserById = catchException(handleGetUserById, options);

Log output

User is blocked {
  "timestamp": "2023-09-12T22:45:13.468Z",
  "logger": {
    "name": "UserController",
    "method_name": "getById",
    "params": ["c4baf266-13c9-4d6e-93a7-ff8dccde0905"],
  },
  "error": {
    "name": "UserServiceError",
    "message": "User is blocked",
    "stack": {ErrorStack},
    "kind": "Application"
  }
}