Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@treelab/logger-metrics-middleware

Package Overview
Dependencies
Maintainers
12
Versions
37
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@treelab/logger-metrics-middleware

nest js logger-metrics-middleware

  • 1.0.20
  • Source
  • npm
  • Socket score

Version published
Maintainers
12
Created
Source

HTTP Log使用

Log中间件配置说明

{
  serviceName?: string        // 当前服务名
  prettyPrint?: boolean       // 是否以json方式输出, 默认false
  ...                         // 后续新增..
}

服务名配置说明

下面2种方法任选一个:

  1. 配置环境变量 SERVICE_NAME 为当前服务名,log中的serviceName会读env中 SERVICE_NAME 的值.


  2. 初始化时,传递serviceName参数

HTTP:

  app.use(ExpressHttpLoggerMiddleware({serviceName: 'svcName'}))

Grpc:

  @UseInterceptors(new GrpcLoggerMiddleware({ serviceName: 'svcName' }))

Express || Nestjs 使用

1.导入

import { ExpressHttpLoggerMiddleware } from '@treelab/logger-metrics-middleware'
import * as Prometheus from 'prom-client'

2. 使用中间件

  // 日志
  app.use(ExpressHttpLoggerMiddleware())

  // 指标
  app.use('/metrics', async (req, res) => {
    res.set('Content-Type', Prometheus.register.contentType)
    const end = await Prometheus.register.metrics()
    res.end(end)
  })
}

完整例子

import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';
import { ExpressHttpLoggerMiddleware } from '@treelab/logger-metrics-middleware'
import * as Prometheus from 'prom-client'
import bodyParser = require('body-parser');

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.use(bodyParser.json());
  app.use(ExpressHttpLoggerMiddleware())

  app.use('/metrics', async (req, res) => {
    res.set('Content-Type', Prometheus.register.contentType)
    const end = await Prometheus.register.metrics()
    res.end(end)
  })

  await app.listen(3000);
}
bootstrap();

Koa 使用

1.导入

import { KoaHttpLoggerMiddleware } from '@treelab/logger-metrics-middleware/dist/http-logger'
import * as Prometheus from 'prom-client'

2. 使用中间件

  // 日志
  app.use(KoaHttpLoggerMiddleware())

  // 指标
  router.get('/metrics',async (ctx) => {
    ctx.header.set('Content-Type', Prometheus.register.contentType)
    const end = await Prometheus.register.metrics()
    ctx.body = end
  })
}

Grpc Log 使用(仅支持Nestjs)

导入

import { GrpcLoggerMiddleware } from '@treelab/logger-metrics-middleware';

使用

 // 在grpc Controller 上使用

@UseInterceptors(GrpcLoggerMiddleware)
@Controller()
export class GrpcController {
  constructor(){}

}

FAQs

Package last updated on 07 Apr 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc