aigoncharov / cls-proxify

Logging on steroids with CLS and Proxy. Integrated with express, koa, fastify.

Hi there 👋

ℹ️ My name is Andrey. Rockstar wannabe -> software engineer at Meta hypnotized by AI.

📌 London, UK. UK Global Talent alumni.

💼 Blockchain, web, and a bit of embedded at software consultancies (DSR, DataArt) ➡️ Headed front-end at Hazelcast ➡️ Worked on web perf and WASM integration at Bricks ➡️ Enhancing DevX for mobile devs at Meta.

🎓 Voronezh State University -> Georgia Tech.

📝 Blog about life, career, and tech in English and in Russian.

🎤 Fighting my stage fright at conferences. Founded BeerJS in my home town - Voronezh. Program committee member at Geekle.

❤️ Philosophy, music (🥁 -> 🎹+🎙), Tolstoy and Dostoevsky, Yesenin, weightlifting, boxing, cycling, hiking, snowboarding.

📫 LinkedIn, Instagram, Twitter, Telegram.

cls-proxify's Issues

No private property forwarding

Hi,

Based on the current implementation, proxy method calls are not able to update the wrapped object private members. It is related to the No private property forwarding topic.

I was wondering if implementing the proposed solution in the above link would be acceptable for this project:

get(target, prop, receiver) {
    const value = target[prop];
    if (value instanceof Function) {
      return function (...args) {
        return value.apply(this === receiver ? target : this, args);
      };
    }
    return value;
}

I am not sure about side-effects and implications this could have for other use cases, but this does fix my issue.

If this is an option, I will gladly submit a PR. I will use a locally patched version of this library until then.

Thank you

how to use with koa1

i use with koa1 like this but it only console 1
it seems clsProxifyKoaMiddleware is not worked

app.use(
    function *(next){
      console.log(1)
      clsProxifyKoaMiddleware(
         'clsKeyLogger',
         ctx => {
           console.log(2);
         }
       )
      yield next;
    }
  );

Recommended way to log with hapi-pino

I read this article about adding tracing to logs and it inspired me to want to enable this inside my hapi/hapi-pino project.

I registered hapi-pino as a hapi plugin just like the docs recommend (below). I'm wondering if it would make more sense to register a separate cls-pino-logger plugin or if it would be recommended to do it somehow inside of hapi-pino? Thanks in advance for any guidance.

await server.register({
    plugin: require('hapi-pino'),
    options: {
      prettyPrint: process.env.NODE_ENV !== 'production',
      // Redact Authorization headers, see https://getpino.io/#/docs/redaction
      redact: ['req.headers.authorization']
    }
  })

I created a plugin per the hapi plugin docs:

import { clsProxify, clsProxifyNamespace, setClsProxyValue } from 'cls-proxify'
import * as Pino from "pino";

const logger = Pino();
const loggerCls = clsProxify('clsKeyLogger', logger)

const handler = function (request, h) {
    clsProxifyNamespace.bindEmitter(request);
    clsProxifyNamespace.bindEmitter(request.response);

    clsProxifyNamespace.run(() => {
        const headerRequestID = request.headers.Traceparent
        // this value will be accesible in CLS by key 'clsKeyLogger'
        // it will be used as a proxy for `loggerCls`
        const loggerProxy = {
            info: (msg: string) => `${headerRequestID}: ${msg}`,
        }
        setClsProxyValue('clsKeyLogger', loggerProxy)
    })
};

exports.plugin = {
    name: 'cls-trace-logger',
    register: function (server, options) {
        server.route({ method: 'GET', path: '/test/cls', handler });

        loggerCls.info('My message!');
    }
};

But I get this error:
[```
1597365833550] ERROR (55306 on ip-192-168-2-50.ec2.internal): request error
err: {
"type": "AssertionError",
"message": "can only bind real EEs",
"stack":
AssertionError [ERR_ASSERTION]: can only bind real EEs

What would be the recommended way to use with Hapi and specifically hapi-pino

I read this article about adding tracing to logs and it inspired me to want to enable this inside my hapi/hapi-pino project.

I registered hapi-pino as a hapi plugin just like the docs recommend (below). I'm wondering if it would make more sense to register a separate cls-pino-logger plugin or if it would be recommended to do it somehow inside of hapi-pino? Thanks in advance for any guidance.

await server.register({
    plugin: require('hapi-pino'),
    options: {
      prettyPrint: process.env.NODE_ENV !== 'production',
      // Redact Authorization headers, see https://getpino.io/#/docs/redaction
      redact: ['req.headers.authorization']
    }
  })

I created a plugin per the hapi plugin docs:

import { clsProxify, clsProxifyNamespace, setClsProxyValue } from 'cls-proxify'
import * as Pino from "pino";

const logger = Pino();
const loggerCls = clsProxify('clsKeyLogger', logger)

const handler = function (request, h) {
    clsProxifyNamespace.bindEmitter(request);
    clsProxifyNamespace.bindEmitter(request.response);

    clsProxifyNamespace.run(() => {
        const headerRequestID = request.headers.Traceparent
        // this value will be accesible in CLS by key 'clsKeyLogger'
        // it will be used as a proxy for `loggerCls`
        const loggerProxy = {
            info: (msg: string) => `${headerRequestID}: ${msg}`,
        }
        setClsProxyValue('clsKeyLogger', loggerProxy)
    })
};

exports.plugin = {
    name: 'cls-trace-logger',
    register: function (server, options) {
        server.route({ method: 'GET', path: '/test/cls', handler });

        loggerCls.info('My message!');
    }
};

But I get this error:

1597365833550] ERROR (55306 on ip-192-168-2-50.ec2.internal): request error
    err: {
      "type": "AssertionError",
      "message": "can only bind real EEs",
      "stack":
          AssertionError [ERR_ASSERTION]: can only bind real EEs

Koa & pino - not work

node: 11.7.0
OS: MacOS

I've created a logger module:

import pino, { Logger } from 'pino';
import { clsProxify } from 'cls-proxify';
import { clsProxifyKoaMiddleware } from 'cls-proxify/integration/koa';
import uuidv4 from '../../common/utils/uuid';

let logger: Logger;

switch (process.env.NODE_ENV) {
    case 'development':
        logger = pino({ prettyPrint: { colorize: true } });
        break;

    case 'production':
        const dest = pino.extreme(); // logs to stdout with no args
        logger = pino(dest);
        break;

    default:
        throw new Error('Logger must be initialized! Set up process.env.NODE_ENV');
}

const loggerCls = clsProxify('clsKeyLogger', logger);

export const middleware = () =>
    clsProxifyKoaMiddleware('clsKeyLogger', () => {
        const headerRequestID = uuidv4(); 
        const loggerProxy = {
            info: (msg: string) => {`${headerRequestID}: ${msg}`,
        };
        return loggerProxy;
    });

setInterval(() => loggerCls && process.env.NODE_ENV === 'production' && loggerCls.flush(), 10000).unref();

export default loggerCls;

and then use it in app

import http from 'http';
import Koa from 'koa';
import send from 'koa-send';
import serve from 'koa-static';
import body from 'koa-body';
import logger, { middleware } from './utils/getServerLogger';

const app = new Koa();
const server = http.createServer(app.callback());

app.use(middleware());
app.use(body());

app.use(async (ctx, next) => {
   logger.info('Now', Date.now());
   await nex();
})

......

there is no above log item in log - everything else is present but not the item above

what is wrong in the code?

FR: provide namespace to use

There are cases when the app already has a namespace and it would be very helpful to use the same namespace in cls proxify.

How to add co-relationId to pino logger with middy in serverless application using cls-proxify

Our logger.js that uses pino library looks like this:

  import pino from "pino";
   const logger = pino({ name: 'viewLinc', level: process.env.STAGE == 'prod' ? 'info' : 'debug' });
   export default logger;

When using logger, we simply say

    import logger.js
    logger.info("bla bla bla:)

we are also using middy in the application. Middy generates traces with requestId in traces in the ServiceLens but we do not see our custom logs there. For that matter, we will need to add our requestId/co-relationId to the logger object.

Common-middleware.js in our application looks like this:

    export default handler => middy(handler).use([
    loggerMiddleware({ logger: logger }), 
    //.....other middleware 
    httpErrorHandler(), ]);

How can I centrally add co-relationId in my custom logs using cls-proxify so that they will show up in the traces without having to leave it up to the developers to do it?

Fastify Plugin Decorators

Hello!

Your project looks awesome. Just out of curiosity, do you have any plans to add Fastify plugin decorators to it?

Error on Koa.js with bunyan

On this code:

const Koa = require('koa');
const bunyan = require('bunyan');
const {clsProxify} = require('cls-proxify');
const {clsProxifyKoaMiddleware} = require('cls-proxify/integration/koa');

const app = new Koa();

const logger = bunyan.createLogger({
  name: 'cls-test',
  streams: [
    {
      level: 'error',
      stream: process.stderr,
    },
  ]
});

const loggerCls = clsProxify('clsKeyLogger', logger);

app.use(clsProxifyKoaMiddleware('clsKeyLogger', (ctx) => {
  return logger.child({
    requestId: Math.random(),
    level: 'error',
  });
}));

app.use(async (ctx, next) => {
  try {
    await next();
  } catch (err) {
    loggerCls.error(err);
  }
});

app.use(async ctx => {
  ctx.throw(new Error('boom'));
});

app.listen(3000, () => { console.log('Server listening on port', 3000); });

I'm got an error:

 TypeError [ERR_INVALID_ARG_TYPE]: The "chunk" argument must be of type string or an instance of Buffer or Uint8Array. Received undefined
      at new NodeError (node:internal/errors:278:15)
      at WriteStream.Writable.write (node:internal/streams/writable:322:13)