NestJS Jaeger(and others) Tracing Module for microservices. You'll loved it! ❤️

Anuwong Mongkudkornburee — Fri, 30 Apr 2021 16:41:49 +0000

Once my team have to track the application behavior after it had been deployed to production for a few months. We are looking for an easy way to add the tracing things on top of production-ready application. so we developed this package. nestjs-jaeger-tracing.

To use this module, you just import TracingModule to your AppModule and initiate with forRoot() to add app level interceptor to deserialize microservice payload. Then add serializer which will inject tracing id to payload, like this.

import { TracingModule } from '@dollarsign/nestjs-jaeger-tracing';
import { Module } from '@nestjs/common';
import { ClientsModule, Transport } from '@nestjs/microservices';

@Module({
  imports: [
    TracingModule.forRoot({
      exporterConfig: {
        serviceName: 'core-service', // service name that will be shown in jaeger dashboard
      },
      isSimpleSpanProcessor: true, // true for development.
    }),
    ClientsModule.register([
      {
        name: 'MATH_SERVICE',
        transport: Transport.TCP,
        options: {
          port: 3001,
          ...TracingModule.getParserOptions(), // this method will return serializer that inject tracing id to microservice payload.
        },
      },
    ]),
  ],
})
export class AppModule {}

Now, your application will be sent data to jaeger agent so you can trace your application in Jaeger Dashboard. hurayyyy!

It has so much work to do more, so feel free to use and contribute for your works.

DEV Community: Anuwong Mongkudkornburee

NestJS Jaeger(and others) Tracing Module for microservices. You'll loved it! ❤️