@qiwi/nestjs-enterprise-metric NPM

@qiwi/nestjs-enterprise-metric

Nestjs metric module

Installation

yarn add @qiwi/nestjs-enterprise-metric

Usage

// main.ts
async function bootstrap() {
  const app = await NestFactory.create(AppModule)
  metricService = app.get('IMetricService')
  metricService.attach(getNodeMetrics)
  
  // ...etc
}

import {
  GraphiteService, 
  MetricDecorator, 
  MetricService,
  ErrorDecorator,
  MeteredDecorator,
  RequestRateDecorator,
} from '@qiwi/nestjs-enterprise-metric'
import {Controller, Get, Module} from "@nestjs/common";

@Controller()
export class TestClassController {
    @Get('MeteredDecorator')
    @MetricDecorator('Controller')
    async test() {
        return 'foo'
    }
    
    @Get('ErrorDecorator')
    @ErrorDecorator('Controller')
    async error() {
      return 'foo'
    }

    @Get('MeteredDecorator')
    @MeteredDecorator('Controller')
    async meter() {
      return 'foo'
    }
    
    @Get('RequestRateDecorator')
    @RequestRateDecorator('Controller')
    async rate() {
      return 'foo'
    }
}

@Module({
    controllers: [TestClassController],
    providers: [{
        provide: 'IMetricService',
        useFactory: (graphiteService)=>{
            return new MetricService(graphiteService).register({prefix: '$some$your$metric-prefix', interval: 1000})
        }
    }, {
        provide: 'IGraphiteService',
        useFactory: ()=>{
            return new GraphiteService('yourGraphiteApiEndpoint')
        }
    }]
})

export class AppModule {}

MetricModule

The MetricModule provides functionality for working with metrics in your application. It adds the MetricService to the application using the IMetricService token and GraphiteService using the IGraphiteService token. ConfigModule and LoggerModule are required for MetricModule to work

Static import

import { Module } from '@nestjs/common'
import { MetricModule} from '@qiwi/nestjs-enterprise-metric'
import { ConfigModule } from '@qiwi/nestjs-enterprise-config'
import { LoggerModule } from '@qiwi/nestjs-enterprise-logger'

@Module({
  imports: [
    MetricModule, 
    ConfigModule,
    LoggerModule
  ],
})
export class AppModule {}

In this case you should specify parameters in config file

{
    "data": {
      "name": "test-name-app",

      "graphite": {
        "url": "http://graphite-url.com"
      },

      "metric":{
        "prefix": "metric",
        "interval": 30
      },
  }
}

Dynamic import

import { Module } from '@nestjs/common'
import { MetricModule} from '@qiwi/nestjs-enterprise-metric'
import { ConfigModule } from '@qiwi/nestjs-enterprise-config'
import { LoggerModule } from '@qiwi/nestjs-enterprise-logger'

@Module({
  imports: [
    MetricModule.register({
      graphiteApiEndpoint: 'https://localhost:8080',
      metricsConfig: { prefix: 'some-prefix'; interval: 5000 },
    }),
    ConfigModule.register({ path: 'some/path' }),
    LoggerModule
  ],
})
export class AppModule {}

You can pass parameters to a MetricModule.register() method

graphiteUrlOrService - URL for connecting to the Graphite API or your own implementation of IGraphiteService
metricsConfig.prefix - prefix for metric entry name
metricsConfig.interval - period of metric sending in ms