feat: added envs logs and metrics, added health check on start

Author: Tarens2

src/app/app.service.ts

@@ -1,11 +1,12 @@
 import { Inject, Injectable, LoggerService, OnModuleInit } from '@nestjs/common';
 import { LOGGER_PROVIDER } from '@lido-nestjs/logger';
 
-import { ConfigService } from 'common/config';
+import { ConfigService, ENV_KEYS, EnvironmentVariables } from 'common/config';
 import { PrometheusService } from 'common/prometheus';
 import { ConsensusProviderService } from 'common/consensus-provider';
 import { ExecutionProviderService } from 'common/execution-provider';
 import { APP_NAME, APP_VERSION } from './app.constants';
+import { commonPatterns, satanizer } from '@lidofinance/satanizer';
 
 @Injectable()
 export class AppService implements OnModuleInit {
@@ -20,14 +21,8 @@ export class AppService implements OnModuleInit {
 
   public async onModuleInit(): Promise<void> {
     await this.validateNetwork();
-
-    const network = await this.executionProviderService.getNetworkName();
-    const env = this.configService.get('NODE_ENV');
-    const version = APP_VERSION;
-    const name = APP_NAME;
-
-    this.prometheusService.buildInfo.labels({ env, network, name, version }).inc();
-    this.logger.log('Init app', { env, network, name, version });
+    await this.prometheusBuildInfoMetrics();
+    this.prometheusEnvsInfoMetrics();
   }
 
   /**
@@ -43,4 +38,27 @@ export class AppService implements OnModuleInit {
       throw new Error('Chain ids do not match');
     }
   }
+
+  protected async prometheusBuildInfoMetrics() {
+    const network = await this.executionProviderService.getNetworkName();
+    const env = this.configService.get('NODE_ENV');
+    const version = APP_VERSION;
+    const name = APP_NAME;
+
+    this.prometheusService.buildInfo.labels({ env, network, name, version }).inc();
+    this.logger.log('Init app', { env, network, name, version });
+  }
+
+  protected prometheusEnvsInfoMetrics() {
+    const secrets = this.configService.secrets;
+    const mask = satanizer([...commonPatterns, ...secrets]);
+
+    const allConfigEnvs = {};
+    ENV_KEYS.forEach((key: keyof EnvironmentVariables) => {
+      allConfigEnvs[key] = mask(this.configService.get(key));
+    });
+
+    this.prometheusService.envsInfo.labels(allConfigEnvs).inc();
+    this.logger.log('Init app dumping envs', allConfigEnvs);
+  }
 }

src/common/config/env.validation.ts

@@ -96,3 +96,21 @@ export function validate(config: Record<string, unknown>) {
 
   return validatedConfig;
 }
+
+export const ENV_KEYS = [
+  'NODE_ENV',
+  'PORT',
+  'CORS_WHITELIST_REGEXP',
+  'GLOBAL_THROTTLE_TTL',
+  'GLOBAL_THROTTLE_LIMIT',
+  'GLOBAL_CACHE_TTL',
+  'SENTRY_DSN',
+  'LOG_LEVEL',
+  'LOG_FORMAT',
+  'JOB_INTERVAL_VALIDATORS',
+  'JOB_INTERVAL_QUEUE_INFO',
+  'JOB_INTERVAL_CONTRACT_CONFIG',
+  'CL_API_URLS',
+  'EL_RPC_URLS',
+  'CHAIN_ID',
+];

src/common/health/health.module.ts

@@ -1,13 +1,34 @@
-import { Module } from '@nestjs/common';
+import { Inject, LoggerService, Module, OnModuleInit } from '@nestjs/common';
 import { TerminusModule } from '@nestjs/terminus';
 import { HealthController } from './health.controller';
 import { ExecutionProviderHealthIndicator } from './execution-provider.indicator';
 import { ConsensusProviderIndicator } from './consensus-provider.indicator';
 import { GenesisTimeModule } from '../genesis-time';
+import { LOGGER_PROVIDER } from '@lido-nestjs/logger';
 
 @Module({
   providers: [ExecutionProviderHealthIndicator, ConsensusProviderIndicator],
   controllers: [HealthController],
   imports: [TerminusModule, GenesisTimeModule],
 })
-export class HealthModule {}
+export class HealthModule implements OnModuleInit {
+  constructor(
+    @Inject(LOGGER_PROVIDER) protected readonly logger: LoggerService,
+    protected readonly consensusProviderIndicator: ConsensusProviderIndicator,
+    protected readonly executionProviderIndicator: ExecutionProviderHealthIndicator,
+  ) {}
+
+  async onModuleInit() {
+    await this.startUpChecks();
+  }
+
+  async startUpChecks() {
+    try {
+      await this.consensusProviderIndicator.isHealthy('consensusProvider');
+      await this.executionProviderIndicator.isHealthy('executionProvider');
+      this.logger.log(`Start up checks passed successfully`);
+    } catch (e) {
+      this.logger.error(`Start up checks failed with error: ${e}`);
+    }
+  }
+}

src/common/prometheus/prometheus.service.ts

@@ -2,6 +2,7 @@ import { getOrCreateMetric } from '@willsoto/nestjs-prometheus';
 import { Options, Metrics, Metric } from './interfaces';
 import { METRICS_PREFIX } from './prometheus.constants';
 import { RequestSourceType } from '../../http/request-time/headers/request-source-type';
+import { ENV_KEYS } from '../config';
 
 export class PrometheusService {
   protected prefix = METRICS_PREFIX;
@@ -25,7 +26,13 @@ export class PrometheusService {
   public buildInfo = this.getOrCreateMetric('Gauge', {
     name: 'build_info',
     help: 'Build information',
-    labelNames: ['name', 'version', 'env', 'network', 'startSlot'],
+    labelNames: ['name', 'version', 'env', 'network'],
+  });
+
+  public envsInfo = this.getOrCreateMetric('Gauge', {
+    name: 'envs_info',
+    help: 'Environment variables information',
+    labelNames: ENV_KEYS,
   });
 
   public clApiRequestDuration = this.getOrCreateMetric('Histogram', {

src/http/common/middleware/logger.middleware.ts

@@ -1,7 +1,6 @@
 import { Inject, Injectable, LoggerService, NestMiddleware } from '@nestjs/common';
 import { WINSTON_MODULE_NEST_PROVIDER } from 'nest-winston';
 import { Request, Reply } from './interfaces';
-import { FastifyRequest } from 'fastify';
 
 @Injectable()
 export class LoggerMiddleware implements NestMiddleware {
@@ -10,15 +9,13 @@ export class LoggerMiddleware implements NestMiddleware {
     private readonly logger: LoggerService,
   ) {}
 
-  use(request: any, reply: Reply, next: () => void) {
+  use(request: Request, reply: Reply, next: () => void) {
     const { ip, method, headers, originalUrl } = request;
     const userAgent = headers['user-agent'] ?? '';
 
-    const ips = request.ips ? request.ips : [];
-
     reply.on('finish', () => {
       const { statusCode } = reply;
-      const log = { method, originalUrl, statusCode, userAgent, ip, ips };
+      const log = { method, originalUrl, statusCode, userAgent, ip };
 
       this.logger.log(JSON.stringify(log));
     });