Nautical Pirate Moustache

    cls-proxify
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    cls-proxify Build Status Coverage Status Tweet

    Logging on steroids with CLS and Proxy. A small library that proxies any arbitrary object with a proxy from Continuation-Local Storage a.k.a. CLS if found one. Super-useful for creating child loggers per each request with dynamic context from the request itself (e.g. adding request trace ID, adding request payload). Integrated with express, koa, fastify out-of-the-box.

    Many thanks to @mcollina for the idea of combining Proxy and CLS.

    Installation

    npm i cls-proxify cls-hooked
    

    Quick start

    Express

    TypeScript users, clsProxifyExpressMiddleware uses typings from @types/express. Please, run npm i -D @types/express

    import { clsProxify } from 'cls-proxify'
    import { clsProxifyExpressMiddleware } from 'cls-proxify/integration/express'
    import * as express from 'express'
    
    const logger = {
      info: (msg: string) => console.log(msg),
    }
    const loggerCls = clsProxify(logger)
    
    const app = express()
    app.use(
      clsProxifyExpressMiddleware((req) => {
        const headerRequestID = req.headers.Traceparent
        const loggerProxy = {
          info: (msg: string) => `${headerRequestID}: ${msg}`,
        }
        // this value will be accesible in CLS by key 'cls-proxify'
        // it will be used as a proxy for `loggerCls`
        return loggerProxy
      }),
    )
    
    app.get('/test', (req, res) => {
      loggerCls.info('My message!')
      // Logs `${headerRequestID}: My message!` into the console
      // Say, we send GET /test with header 'Traceparent' set to 12345
      // It's going to log '12345: My message!'
      // If it doesn't find anything in CLS by key 'cls-proxify' it uses the original `logger` and logs 'My message!'
    })

    Koa

    TypeScript users, clsProxifyKoaMiddleware uses typings from @types/koa. Please, run npm i -D @types/koa

    import { clsProxify } from 'cls-proxify'
    import { clsProxifyKoaMiddleware } from 'cls-proxify/integration/koa'
    import * as Koa from 'koa'
    
    const logger = {
      info: (msg: string) => console.log(msg),
    }
    const loggerCls = clsProxify(logger)
    
    const app = new Koa()
    app.use(
      clsProxifyKoaMiddleware((ctx) => {
        const headerRequestID = ctx.req.headers.Traceparent
        const loggerProxy = {
          info: (msg: string) => `${headerRequestID}: ${msg}`,
        }
        // this value will be accesible in CLS by key 'cls-proxify'
        // it will be used as a proxy for `loggerCls`
        return loggerProxy
      }),
    )
    
    app.use((ctx) => {
      loggerCls.info('My message!')
      // Logs `${headerRequestID}: My message!` into the console
      // Say, we send GET / with header 'Traceparent' set to 12345
      // It's going to log '12345: My message!'
      // If it doesn't find anything in CLS by key 'cls-proxify' it uses the original `logger` and logs 'My message!'
    })

    Fastify

    import { clsProxify } from 'cls-proxify'
    import { clsProxifyFastifyMiddleware } from 'cls-proxify/integration/fastify'
    import * as fastify from 'fastify'
    
    const logger = {
      info: (msg: string) => console.log(msg),
    }
    const loggerCls = clsProxify(logger)
    
    const app = fastify()
    app.use(
      clsProxifyFastifyMiddleware((req) => {
        const headerRequestID = ctx.req.headers.Traceparent
        const loggerProxy = {
          info: (msg: string) => `${headerRequestID}: ${msg}`,
        }
        // this value will be accesible in CLS by key 'cls-proxify'
        // it will be used as a proxy for `loggerCls`
        return loggerProxy
      }),
    )
    
    app.get('/test', (req, res) => {
      loggerCls.info('My message!')
      // Logs `${headerRequestID}: My message!` into the console
      // Say, we send GET /test with header 'Traceparent' set to 12345
      // It's going to log '12345: My message!'
      // If it doesn't find anything in CLS by key 'cls-proxify' it uses the original `logger` and logs 'My message!'
    })

    Any other framework or library

    import { clsProxify, getClsHookedStorage } from 'cls-proxify'
    import AbstractWebServer from 'abstract-web-server'
    
    const logger = {
      info: (msg: string) => console.log(msg),
    }
    const loggerCls = clsProxify(logger)
    
    const app = new AbstractWebServer()
    // Assuming this AbstractWebServer supports some form of middlewares
    app.use((request, response, next) => {
      // Assuming your request and response are event emitters
      getClsHookedStorage().namespace.bindEmitter(request)
      getClsHookedStorage().namespace.bindEmitter(response)
    
      getClsHookedStorage().namespace.run(() => {
        const headerRequestID = request.headers.Traceparent
        // this value will be accesible in CLS by key 'cls-proxify'
        // it will be used as a proxy for `loggerCls`
        const loggerProxy = {
          info: (msg: string) => `${headerRequestID}: ${msg}`,
        }
        getClsHookedStorage().set(loggerProxy)
    
        next()
      })
    })
    
    app.get('/test', (req, res) => {
      loggerCls.info('My message!')
      // Logs `${headerRequestID}: My message!` into the console
      // Say, we send GET /test with header 'Traceparent' set to 12345
      // It's going to log '12345: My message!'
      // If it doesn't find anything in CLS by key 'cls-proxify' it uses the original `logger` and logs 'My message!'
    })

    Set custom CLS storage

    import { clsProxify, setClsHookedStorage, ClsHookedStorage, ClsProxifyStorage } from 'cls-proxify'
    import AbstractWebServer from 'abstract-web-server'
    
    // You can subclass existing ClsHookedStorage
    class CustomClsStorage extends ClsHookedStorage {
      // Override namespace
      public readonly namespace = createNamespace('myNamespace')
      // Or override CLS key
      protected readonly key = 'yoda'
    }
    setClsHookedStorage(new CustomClsStorage())
    
    // Or you can implement your own storage from scratch.
    // Just make sure it conforms to `ClsProxifyStorage` interface.
    class SecretStorage<T> implements ClsProxifyStorage<T> {
      set(proxy: T): void {}
      get(): T | undefined {}
    }
    setClsHookedStorage(new SecretStorage())

    In depth

    How it works

    If you're struggling to grasp the idea behind CLS at these two articles: Request Id Tracing in Node.js Applications, A Pragmatic Overview of Async Hooks API in Node.js.

    Take a look at this article which overviews how CLS works and covers the idea behind this library.

    We wrap our original logger in a Proxy. Every time we try to access any property of that object we first check if there's an updated logger in CLS available. If it's there we take the property from it. If it's not we take the property from the original logger. Then for every request we create a CLS context using run and bindEmitter. Once the context is created we enhance our original logger with some extra data and put the updated logger in the context. Once we try to call any method of our logger we'll actually call the same method on our logger in CLS.

    Does it work only for loggers?

    No. You can proxify any object you want. Moreover you can even proxify functions and class constructors.

    Here's a list of traps cls-proxify provides:

    Take a look at the tests to get an idea of how you can utilize them.

    Live demos

    Usage with pino and fastify

    Usage with pino and express

    Troubleshooting

    My context got lost

    Note that some middlewares may cause CLS context to get lost. To avoid it use any third party middleware that does not need access to request ids before you use this middleware.

    I'm experiencing a memory leak

    Make sure you don't keep any external references to the objects inside of CLS. It may prevent them from being collected by GC. Take a look at this issues: #21, #11.

    Install

    npm i cls-proxify

    DownloadsWeekly Downloads

    6,897

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    21.9 kB

    Total Files

    23

    Last publish

    Collaborators

    • keenondrums
    • aigoncharov