Enable all configuration except authentication

Author: ivanvs

examples/test-status-monitor/src/app.module.ts

@@ -2,10 +2,59 @@ import { Module } from '@nestjs/common';
 import { AppController } from './app.controller';
 import { AppService } from './app.service';
 import { StatusMonitorModule } from '../../../dist/status.monitor.module';
+import { StatusMonitorConfiguration } from '../../../dist/config/status.monitor.configuration';
 import { HealtController } from './healtController';
 
+const statusMonitorConfig: StatusMonitorConfiguration = {
+  pageTitle: 'Nest.js Monitoring Page',
+  port: 3001,
+  path: 'status',
+  theme: 'default.css',
+  ignoreStartsWith: '',
+  healthChecks: [
+    {
+      protocol: 'http',
+      host: 'localhost',
+      path: '/healt/alive',
+      port: 3001,
+    },
+    {
+      protocol: 'http',
+      host: 'localhost',
+      path: '/healt/dead',
+      port: 3001,
+    },
+  ],
+  spans: [
+    {
+      interval: 1, // Every second
+      retention: 60, // Keep 60 datapoints in memory
+    },
+    {
+      interval: 5, // Every 5 seconds
+      retention: 60,
+    },
+    {
+      interval: 15, // Every 15 seconds
+      retention: 60,
+    },
+    {
+      interval: 60, // Every 60 seconds
+      retention: 600,
+    },
+  ],
+  chartVisibility: {
+    cpu: true,
+    mem: true,
+    load: true,
+    responseTime: true,
+    rps: true,
+    statusCodes: true,
+  },
+};
+
 @Module({
-  imports: [StatusMonitorModule],
+  imports: [StatusMonitorModule.setUp(statusMonitorConfig)],
   controllers: [AppController, HealtController],
   providers: [AppService],
 })

examples/test-status-monitor/src/main.hmr.ts

@@ -5,7 +5,7 @@ declare const module: any;
 
 async function bootstrap() {
   const app = await NestFactory.create(AppModule);
-  await app.listen(3000);
+  await app.listen(3001);
 
   if (module.hot) {
     module.hot.accept();

src/config/chart.visibility.configuration.ts

@@ -0,0 +1,8 @@
+export interface ChartVisibilityConfiguration {
+  cpu: boolean;
+  mem: boolean;
+  load: boolean;
+  responseTime: boolean;
+  rps: boolean;
+  statusCodes: boolean;
+}

src/config/health.check.configuration.ts

@@ -0,0 +1,6 @@
+export interface HealthCheckConfiguration {
+  protocol: string;
+  host: string;
+  path: string;
+  port: number;
+}

src/config/spans.configuration.ts

@@ -0,0 +1,4 @@
+export interface SpansConfiguration {
+  interval: number;
+  retention: number;
+}

src/config/status.monitor.configuration.ts

@@ -0,0 +1,14 @@
+import { HealthCheckConfiguration } from './health.check.configuration';
+import { SpansConfiguration } from './spans.configuration';
+import { ChartVisibilityConfiguration } from './chart.visibility.configuration';
+
+export interface StatusMonitorConfiguration {
+  path: string;
+  port: number;
+  pageTitle: string;
+  theme: string;
+  ignoreStartsWith: string;
+  healthChecks: HealthCheckConfiguration[];
+  spans: SpansConfiguration[];
+  chartVisibility: ChartVisibilityConfiguration;
+}

src/healt.check.service.ts src/health.check.service.tssrc/healt.check.service.ts renamed to src/health.check.service.ts

@@ -1,8 +1,8 @@
-import { Injectable, Inject, forwardRef } from '@nestjs/common';
+import { Injectable } from '@nestjs/common';
 import axios from 'axios';
 
 @Injectable()
-export class HealtCheckService {
+export class HealthCheckService {
   healthChecks = [
     {
       protocol: 'http',

src/status.monitor.constants.ts

@@ -0,0 +1,2 @@
+export const STATUS_MONITOR_OPTIONS_PROVIDER =
+  'STATUS_MONITOR_OPTIONS_PROVIDER';

src/status.monitor.controller.ts

@@ -1,21 +1,35 @@
-import { Get, Controller, HttpCode } from '@nestjs/common';
+import { Get, Controller, HttpCode, Inject } from '@nestjs/common';
 import * as fs from 'fs';
 import * as path from 'path';
 import Handlebars from 'handlebars';
-import { HealtCheckService } from './healt.check.service';
+import { HealthCheckService } from './health.check.service';
+import { PATH_METADATA } from '@nestjs/common/constants';
+import { STATUS_MONITOR_OPTIONS_PROVIDER } from './status.monitor.constants';
+import { StatusMonitorConfiguration } from './config/status.monitor.configuration';
 
-const controllerPath = 'monitor';
-
-@Controller(controllerPath)
+@Controller()
 export class StatusMonitorController {
   data;
   render;
 
-  constructor(private readonly healtCheckService: HealtCheckService) {
+  constructor(
+    private readonly healtCheckService: HealthCheckService,
+    @Inject(STATUS_MONITOR_OPTIONS_PROVIDER)
+    private readonly config: StatusMonitorConfiguration,
+  ) {
+    const bodyClasses = Object.keys(config.chartVisibility)
+      .reduce((accumulator, key) => {
+        if (config.chartVisibility[key] === false) {
+          accumulator.push(`hide-${key}`);
+        }
+        return accumulator;
+      }, [])
+      .join(' ');
+
     this.data = {
-      title: 'Nest.js Status',
-      port: 3001,
-      bodyClasses: '',
+      title: config.pageTitle,
+      port: config.port,
+      bodyClasses: bodyClasses,
       script: fs.readFileSync(
         path.join(__dirname, '../src/public/javascripts/app.js'),
       ),
@@ -31,6 +45,11 @@ export class StatusMonitorController {
     this.render = Handlebars.compile(htmlTmpl, { strict: true });
   }
 
+  public static forRoot(rootPath: string = 'monitor') {
+    Reflect.defineMetadata(PATH_METADATA, rootPath, StatusMonitorController);
+    return StatusMonitorController;
+  }
+
   @Get()
   @HttpCode(200)
   async root() {

src/status.monitor.gateway.ts

@@ -2,7 +2,6 @@ import {
   SubscribeMessage,
   WebSocketGateway,
   WebSocketServer,
-  WsResponse,
   OnGatewayConnection,
 } from '@nestjs/websockets';
 import { StatusMonitoringService } from './status.monitoring.service';