🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Sign inDemoInstall
Socket

@ntlib/status-monitor-nestjs

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@ntlib/status-monitor-nestjs

Realtime Monitoring for Express-based NestJS applications

1.0.0
Source
npm
Version published
Maintainers
1
Created
Source

@ntedgi/nestjs-status-monitor

NodeJS and Nest Compatibility Matrix.

Node VersionNest Version
^18.x^9.x

NPM

Simple, self-hosted module based on Socket.io and Chart.js to report realtime server metrics for NestJS v7+ based servers.

Status monitor page

Installation & setup NestJS

  • Run npm install nestjs-status-monitor --save
  • Setup module import:
@Module({
  imports: [StatusMonitorModule.forRoot()] //default config
})
  • Run server and visit /status

Options

Monitor can be configured by passing options object during initialization of module.

@Module({
  imports: [StatusMonitorModule.forRoot(config)]
})

Default config:

{
  title: 'NestJS Status',
  path: '/status',
  socketPath: '/socket.io',
  port: null, 
  spans: [
    {
      interval: 1, 
      retention: 60, 
    },
    {
      interval: 5,
      retention: 60,
    },
    {
      interval: 15, 
      retention: 60,
    },
  ],
  chartVisibility: {
    cpu: true,
    mem: true,
    load: true,
    eventLoop: true,
    heap: true,
    responseTime: true,
    rps: true,
    statusCodes: true,
  },
  ignoreStartsWith: ['/admin'],
  healthChecks: [],
}

Health Checks

You can add a series of health checks to the configuration that will appear below the other stats. The health check will be considered successful if the endpoint returns a 200 status code.

// config
healthChecks: [
  {
    protocol: 'http',
    host: 'localhost',
    path: '/health/alive',
    port: 3001,
  },
  {
    protocol: 'http',
    host: 'localhost',
    path: '/health/dead',
    port: 3001,
  },
];

Local demo

  • Run the following:
npm i
cd examples/integrate-status-monitor
npm i
npm start

Keywords

nestjs

FAQs

Package last updated on 28 Aug 2023

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