@newtral/nestjs-jaeger NPM

@newtral/nestjs-jaeger

Getting Started

Setting up the Jaeger Module

import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
import { NestFactory } from '@nestjs/core';
import { JaegerMiddleware, JaegerModule, SpanService } from '@newtral/nestjs-jaeger';

@Module({
  imports: [
    JaegerModule.forRoot({
      config: {
        serviceName: 'my-service-name',
        reporter: {
          agentHost: 'localhost',
          agentPort: 6831
        }
      }
    })
  ]
})
class AppModule implements NestModule {
  configure(consumer: MiddlewareConsumer): void {
    consumer.apply(JaegerMiddleware).forRoutes('*');
  }
}

const app = await NestFactory.create(AppModule);

await app.listen(3000);

Using in conjunction with the logger

import { MiddlewareConsumer, Module, NestModule } from '@nestjs/common';
import { NestFactory } from '@nestjs/core';
import { JaegerLoggerService, JaegerMiddleware, JaegerModule } from '@newtral/nestjs-jaeger';
import { LoggerModule, LoggerService } from '@newtral/nestjs-logger';

@Module({
  imports: [
    LoggerModule.forRoot({
      prettyPrint: true,
      logLevel: 'info'
    }),
    JaegerModule.forRoot({
      config: {
        serviceName: 'my-service-name',
        reporter: {
          agentHost: 'localhost',
          agentPort: 6832
        },
        sampler: {
          type: 'const',
          param: 1
        }
      }
    })
  ],
  // Override the LoggerService provide so we get an instance of
  // JaegerLoggerService instead
  providers: [
    {
      provide: LoggerService,
      useClass: JaegerLoggerService
    }
  ]
})
class AppModule implements NestModule {
  configure(consumer: MiddlewareConsumer): void {
    consumer.apply(JaegerMiddleware).forRoutes('*');
  }
}

const app = await NestFactory.create(AppModule);

await app.listen(3000);

Development

The project use husky and lint-staged for linting and fixing possible errors on source code before commit

Git hooks scripts are installed after running npm install the first time

npm run build:commonjs

Compile typescript files from the src folder inside the lib folder

npm run build:esm

Compile typescript files from the src folder inside the esm folder using es modules

npm run build

Concurrently run both build:commonjs and build:esm

npm run clean

Remove the following directories/files

lib
esm
reports

npm test

Run tests files inside the tests folder that matches the following patterns. Exit with code > 0 on error

*.test.ts
*.spec.ts

npm run cover

The same as as npm test and generates coverages reports in reports/coverage. Exit with code > 0 on error

npm run lint

Check eslint errors according to .eslintrc

npm run lint:fix

Run npm run lint applying fixes and run prettier on every typescript file

npm run health

Check for:

Build errors
Tests failures
Lint errors

npm run ci

Run test and generate every possible report. Do not exit with error code > 0 if the tests fail. It generates a report file instead

reports/lint-checkstyle.xml Lint report in chackstyle format
reports/test-results.xml Test report in xUnit format
reports/coverage/clover.xml Coverage report in clover format
reports/coverage/cobertura-coverage.xml Coverage report in cobertura format
reports/coverage/lcov.info Coverage report in lcov
reports/coverage/index.html Coverage report in html

npm run release

Bump package.json version accordingly to the commit messages
Generate changelog for the new version from the commit messages
Commit package.json and CHANGELOG.md with the new changes
Create a git tag with the new version
You'll need to execute git push --follow-tags origin master after generating a release