nest-opentracing v1.2.1

nest-opentracing

Implementation of Distributed Tracing for Nest.js modules.

So far only the express framework is supported.

Usage

Installing

npm i nest-opentracing jaeger-client@3.18.1

Initialization

Import tracing module in your root module just once.

Jaeger tracer

import { JaegerTracingModule } from "nest-opentracing";

@Module({
  imports: [
    JaegerTracingModule.forRoot({ applyRoutes: ["v1/*"], ignoreRoutes: [] })
  ],
  controllers: [AppController]
})
export class AppModule {}

Custom tracer

import { OpenTracingModule } from "nest-opentracing";

const someTracerInstance = initSomeTracer(options);

@Module({
  imports: [
    OpenTracingModule.forRoot({ tracer: someTracerInstance, applyRoutes: ["v1/*"], ignoreRoutes: [] })
  ],
  controllers: [AppController]
})
export class AppModule {}

Tracing Nest.js HttpModule

import { JaegerTracingModule, TracedHttpModule } from "nest-opentracing";

@Module({
  imports: [
    JaegerTracingModule.forRoot({ applyRoutes: [AppController], ignoreRoutes: [] }),
    TracedHttpModule.registerAsync({
      useFactory: async () => ({
        timeout: 2000, // timeout 2000ms for every request throught HttpService
      }),
    })
  ],
  controllers: [AppController]
})
export class AppModule {}

Configuration

Jaeger tracer

Configures by Jaeger environment variables and next variables:

npm_package_version
NAMESPACE
NODE_ENV

Traced HTTP module

TracedHttpModule has same initialization interface like a HttpModule.

Async functions tracing

import { TracingService } from "nest-opentracing";

@Controller()
class AppController {
  constructor(private readonly TracingService tracingService) {}

  @Get("foo")
  async bar() {
    /* some code here */

    const asyncResult = await this.tracingService.traceAsyncFunction(async () => await someAsyncAction("foo", "bar"));

    /* some code here */
  }
}