npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

express-logging-utility

v1.0.1

Published

A node-express middleware which creates a unique transaction id for each request. This unique transaction id can be retrieved anywhere in the request process and can be injected into the logs. Thus helps to identify the logs for each request uniquely. It

Downloads

7

Readme

Express Logging Utility

Express logging utility is a light-weight express middleware that provides a unique transaction id for each request. This unique transaction id can be retrieved anywhere in the request process and can be injected into the logs. Thus helps to identify the logs for each request uniquely. This can be used in Express, Nestjs or any other node.js server side frameworks along with logging libraries like Winston, bunyan etc.,

It's built on top of Async Hooks, a high level api that provides life cycle hooks for asynchronous resources, which can be registered to track asynchronous operations in the node.js request process. This middleware also helps to create and retrieve variables for each request context individually.

Getting Started

Prerequisites

Nodejs version >= 8.2.1

Using npm :

npm install -g npm

Installation

npm install --save express-logging-utility

Usage

Express.js

To get unique logging id for each request :

const express = require('express')
const app = express();

// Express logging utility
const { middleware, get } = require('express-logging-utility');

app.use(middleware); // Inject express logging utility middleware

app.get('/', (req, res) => {
    // Get unique logging transaction id
    const loggingId = get('loggingId'); 
    console.log(`Request logging id : ${loggingId}`);
    res.send('Hello World!')
})

app.listen(3000, () => console.log('Example app listening on port 3000!'))

To share variables across each request :

In index.js

const express = require('express')
const app = express();

// Express logging utility
const { middleware, set } = require('express-logging-utility');

const service = require('./service');

app.use(middleware); // Inject express logging utility middleware

app.get('/', (req, res) => {
    // Set test variable
    set('test', 'testing_purpose');
    res.send(service());
})

app.listen(3000, () => console.log('Example app listening on port 3000!'))

In service.js

// Express logging utility
const { get } = require('express-logging-utility');

module.exports = () => {
    // Get test variable
    const test = get('test'); 
    console.log(`test : ${test}`);
    return 'hello world'
}

Nest.js :

To get unique logging id for each request :

In main.ts

import { NestFactory } from '@nestjs/core';
// Express logging utility
import { middleware } from 'express-logging-utility';

// Your application module
import { ApplicationModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(ApplicationModule);
  app.use(middleware); // Inject express logging utility middleware
  await app.listen(3000);
}
bootstrap();

In app.controller.ts

import { Controller, Get } from '@nestjs/common';
import { get } from 'express-logging-utility'; // import get from express-logging-utility

@Controller('cats')
export class CatsController {
  @Get()
  findAll() {
    const loggingId = get('loggingId'); // Get unique logging transaction id
    console.log(`Request logging id : ${loggingId}`);
    return 'This action returns all cats';
  }
}

To share variables across each request :

In main.ts

import { NestFactory } from '@nestjs/core';
// Express logging utility
import { middleware } from 'express-logging-utility';

// Your application module
import { ApplicationModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(ApplicationModule);
  app.use(middleware); // Inject express logging utility middleware
  await app.listen(3000);
}
bootstrap();

In app.controller.ts

import { Controller, Get } from '@nestjs/common';
import { set } from 'express-logging-utility'; // import set from express-logging-utility

@Controller('cats')
export class CatsController {
  @Get()
  findAll() {
    const loggingId = set('test', 'testing_purpose'); // set variable that will be shared across the request individually.
    console.log(`Request logging id : ${loggingId}`);
    return 'This action returns all cats';
  }
}

In app.service.ts

import { Injectable } from '@nestjs/common';
import { Cat } from './interfaces/cat.interface';
import { get } from 'express-logging-utility'; // import get from express-logging-utility

@Injectable()
export class CatsService {
  private readonly cats: Cat[] = [];

  findAll(): Cat[] {
    // Get the variable 'test'
    const test = get('test'); 
    console.log(`test variable : ${test}`);
    return this.cats;
  }
}

Authors

  • Sai Chandesh Gurramkonda - Github