From ef6ee94e7f904418151c03d6f61df6dda15e256d Mon Sep 17 00:00:00 2001 From: "@LeopoldHock" Date: Mon, 15 Jan 2024 12:56:00 +0100 Subject: [PATCH 1/3] feat: Implemented metrics endpoint for prometheus. --- CHANGELOG.md | 4 ++ package-lock.json | 47 +++++++++++++++++++ package.json | 1 + src/auth/auth.module.ts | 11 ++++- src/config/app.config.ts | 13 +++++ src/config/cors.config.ts | 17 +++++-- src/main.ts | 29 ++++++++---- .../monitoring.dummy-controller.test.ts | 20 ++++++++ src/monitoring/monitoring.dummy-controller.ts | 9 ++++ src/monitoring/monitoring.external-module.ts | 18 +++++++ src/monitoring/monitoring.module-internal.ts | 17 +++++++ 11 files changed, 169 insertions(+), 17 deletions(-) create mode 100644 src/config/app.config.ts create mode 100644 src/monitoring/monitoring.dummy-controller.test.ts create mode 100644 src/monitoring/monitoring.dummy-controller.ts create mode 100644 src/monitoring/monitoring.external-module.ts create mode 100644 src/monitoring/monitoring.module-internal.ts diff --git a/CHANGELOG.md b/CHANGELOG.md index 8e35f27..04321d6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,10 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/). ## [2.2.5] - TODO +### Added + +- Implemented metrics endpoint for prometheus. + ### Changed - Request/response logging now utilizes both middlewares and interceptors to also log requests that were turned down (e.g. due to CORS). diff --git a/package-lock.json b/package-lock.json index 3a854de..15e8a21 100644 --- a/package-lock.json +++ b/package-lock.json @@ -18,6 +18,7 @@ "@nestjs/passport": "^9.0.3", "@nestjs/platform-express": "^9.4.3", "@nestjs/swagger": "^6.3.0", + "@willsoto/nestjs-prometheus": "^6.0.0", "axios": "^1.6.2", "class-transformer": "^0.5.1", "class-validator": "^0.14.0", @@ -1979,6 +1980,15 @@ "integrity": "sha512-Aq58f5HiWdyDlFffbbSjAlv596h/cOnt2DO1w3DOC7OJ5EHs0hd/nycJfiu9RJbT6Yk6F1knnRRXNSpxoIVZ9Q==", "dev": true }, + "node_modules/@opentelemetry/api": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/@opentelemetry/api/-/api-1.7.0.tgz", + "integrity": "sha512-AdY5wvN0P2vXBi3b29hxZgSFvdhdxPB9+f0B6s//P9Q8nibRWeA3cHm8UmLpio9ABigkVHJ5NMPk+Mz8VCCyrw==", + "peer": true, + "engines": { + "node": ">=8.0.0" + } + }, "node_modules/@sinclair/typebox": { "version": "0.25.24", "resolved": "https://registry.npmjs.org/@sinclair/typebox/-/typebox-0.25.24.tgz", @@ -2775,6 +2785,15 @@ "@xtuc/long": "4.2.2" } }, + "node_modules/@willsoto/nestjs-prometheus": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/@willsoto/nestjs-prometheus/-/nestjs-prometheus-6.0.0.tgz", + "integrity": "sha512-Krmda5CT9xDPjab8Eqdqiwi7xkZSX60A5rEGVLEDjUG6J6Rw5SCZ/BPaRk+MxNGWzUrRkM7K5FtTg38vWIOt1Q==", + "peerDependencies": { + "@nestjs/common": "^7.0.0 || ^8.0.0 || ^9.0.0 || ^10.0.0", + "prom-client": "^15.0.0" + } + }, "node_modules/@xmldom/xmldom": { "version": "0.8.10", "resolved": "https://registry.npmjs.org/@xmldom/xmldom/-/xmldom-0.8.10.tgz", @@ -3154,6 +3173,12 @@ "node": ">=8" } }, + "node_modules/bintrees": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/bintrees/-/bintrees-1.0.2.tgz", + "integrity": "sha512-VOMgTMwjAaUG580SXn3LacVgjurrbMme7ZZNYGSSV7mmtY6QQRh0Eg3pwIcntQ77DErK1L0NxkbetjcoXzVwKw==", + "peer": true + }, "node_modules/bl": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/bl/-/bl-4.1.0.tgz", @@ -7164,6 +7189,19 @@ "resolved": "https://registry.npmjs.org/process-nextick-args/-/process-nextick-args-2.0.1.tgz", "integrity": "sha512-3ouUOpQhtgrbOa17J7+uxOTpITYWaGP7/AhoR3+A+/1e9skrzelGi/dXzEYyvbxubEF6Wn2ypscTKiKJFFn1ag==" }, + "node_modules/prom-client": { + "version": "15.1.0", + "resolved": "https://registry.npmjs.org/prom-client/-/prom-client-15.1.0.tgz", + "integrity": "sha512-cCD7jLTqyPdjEPBo/Xk4Iu8jxjuZgZJ3e/oET3L+ZwOuap/7Cw3dH/TJSsZKs1TQLZ2IHpIlRAKw82ef06kmMw==", + "peer": true, + "dependencies": { + "@opentelemetry/api": "^1.4.0", + "tdigest": "^0.1.1" + }, + "engines": { + "node": "^16 || ^18 || >=20" + } + }, "node_modules/prompts": { "version": "2.4.2", "resolved": "https://registry.npmjs.org/prompts/-/prompts-2.4.2.tgz", @@ -8060,6 +8098,15 @@ "node": ">=6" } }, + "node_modules/tdigest": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/tdigest/-/tdigest-0.1.2.tgz", + "integrity": "sha512-+G0LLgjjo9BZX2MfdvPfH+MKLCrxlXSYec5DaPYP1fe6Iyhf0/fSmJ0bFiZ1F8BT6cGXl2LpltQptzjXKWEkKA==", + "peer": true, + "dependencies": { + "bintrees": "1.0.2" + } + }, "node_modules/terser": { "version": "5.17.4", "resolved": "https://registry.npmjs.org/terser/-/terser-5.17.4.tgz", diff --git a/package.json b/package.json index a16e9c6..18c96ef 100644 --- a/package.json +++ b/package.json @@ -30,6 +30,7 @@ "@nestjs/passport": "^9.0.3", "@nestjs/platform-express": "^9.4.3", "@nestjs/swagger": "^6.3.0", + "@willsoto/nestjs-prometheus": "^6.0.0", "axios": "^1.6.2", "class-transformer": "^0.5.1", "class-validator": "^0.14.0", diff --git a/src/auth/auth.module.ts b/src/auth/auth.module.ts index 137c0fe..ffe0010 100644 --- a/src/auth/auth.module.ts +++ b/src/auth/auth.module.ts @@ -1,5 +1,5 @@ import { Module } from '@nestjs/common'; -import { ConfigService } from '@nestjs/config'; +import { ConfigModule, ConfigService } from '@nestjs/config'; import { JwtModule } from '@nestjs/jwt'; import { EncodingModule } from 'src/encoding/encoding.module'; import { HttpModule } from 'src/http/http.module'; @@ -8,15 +8,22 @@ import { AuthController } from './controllers/auth.controller'; import { AuthService } from './services/auth.service'; import { JwtStrategy } from './strategies/jwt.strategy'; import { UsersModule } from 'src/users/users.module'; +import { appConfig } from 'src/config/app.config'; +import { corsConfig } from 'src/config/cors.config'; @Module({ imports: [ + ConfigModule.forRoot({ + isGlobal: true, + load: [appConfig, corsConfig], + }), + EncodingModule, HttpModule, XmlApiModule, JwtModule.registerAsync({ useFactory: async (configService: ConfigService) => ({ - secret: configService.get('AUTH_JWT_SECRET'), + secret: configService.get('application.auth.jwtSecret'), }), inject: [ConfigService], }), diff --git a/src/config/app.config.ts b/src/config/app.config.ts new file mode 100644 index 0000000..e9b1939 --- /dev/null +++ b/src/config/app.config.ts @@ -0,0 +1,13 @@ +import { registerAs } from '@nestjs/config'; + +export const appConfig = registerAs('application', () => ({ + port: parseInt(process.env.APP_PORT, 10) || 3000, + metricsPort: parseInt(process.env.APP_METRICS_PORT, 10) || 9100, + clientUrl: process.env.APP_CLIENT_URL ?? 'https://potber.de', + apiUrl: process.env.APP_API_URL ?? 'https://api.potber.de', + auth: { + jwtSecret: process.env, + }, +})); + +export type AppConfig = typeof appConfig; diff --git a/src/config/cors.config.ts b/src/config/cors.config.ts index fa97bbe..cc0797e 100644 --- a/src/config/cors.config.ts +++ b/src/config/cors.config.ts @@ -1,7 +1,14 @@ import { CorsOptions } from '@nestjs/common/interfaces/external/cors-options.interface'; +import { registerAs } from '@nestjs/config'; -export const corsConfig: CorsOptions = { - allowedHeaders: ['content-type', 'authorization'], - methods: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'], - credentials: true, -}; +export const corsConfig = registerAs( + 'cors', + (): CorsOptions => ({ + allowedHeaders: ['content-type', 'authorization'], + origin: (process.env.CORS_ALLOWED_ORIGINS ?? '').split(','), + methods: ['GET', 'POST', 'PUT', 'PATCH', 'DELETE', 'OPTIONS'], + credentials: true, + }), +); + +export type CorsConfig = typeof corsConfig; diff --git a/src/main.ts b/src/main.ts index 70a2020..72e4767 100644 --- a/src/main.ts +++ b/src/main.ts @@ -1,8 +1,7 @@ -import { ConfigService } from '@nestjs/config'; +import { ConfigService, ConfigType } from '@nestjs/config'; import { NestFactory } from '@nestjs/core'; import { SwaggerModule } from '@nestjs/swagger'; import { AppModule } from './app.module'; -import { corsConfig } from './config/cors.config'; import { swaggerConfig, swaggerOptions, @@ -10,22 +9,23 @@ import { } from './config/swagger.config'; import { Logger } from '@nestjs/common'; import { ResponseLoggingInterceptor } from './log/response.logging.interceptor'; +import { MonitoringExternalModule } from './monitoring/monitoring.external-module'; +import { AppConfig } from './config/app.config'; +import { CorsConfig } from './config/cors.config'; async function bootstrap() { const app = await NestFactory.create(AppModule); const configService = app.get(ConfigService); + const appConfig = configService.get>('application'); + const corsConfig = configService.get>('cors'); // Set up CORS - const origin = configService.get('CORS_ALLOWED_ORIGINS').split(','); Logger.log( - `CORS enabled. The following origins will be allowed: '${origin.join( - "', '", - )}'.`, - 'NestApplication', + `CORS enabled. The following origins will be allowed: '${corsConfig.origin}'.`, + 'Bootstrap', ); app.enableCors({ - origin, ...corsConfig, }); @@ -37,8 +37,17 @@ async function bootstrap() { app.useGlobalInterceptors(new ResponseLoggingInterceptor()); - const port = configService.get('APP_PORT'); + const { port } = appConfig; await app.listen(port); - Logger.log(`Application is listening on port ${port}.`, 'NestApplication'); + Logger.log(`Application is listening on port ${port}.`, 'Bootstrap'); + + // Start monitoring process + const mon = await NestFactory.create(MonitoringExternalModule); + const { metricsPort } = appConfig; + await mon.listen(metricsPort); + Logger.log( + `Metrics are available at '/metrics' and port ${metricsPort}.`, + 'Bootstrap', + ); } bootstrap(); diff --git a/src/monitoring/monitoring.dummy-controller.test.ts b/src/monitoring/monitoring.dummy-controller.test.ts new file mode 100644 index 0000000..9c8cb42 --- /dev/null +++ b/src/monitoring/monitoring.dummy-controller.test.ts @@ -0,0 +1,20 @@ +import { createTestContainer } from 'test/container'; +import { MonitoringDummyController } from './monitoring.dummy-controller'; + +describe('Monitoring | Dummy controller', () => { + let controller: MonitoringDummyController; + + beforeEach(async () => { + const container = await createTestContainer({ + controllers: [MonitoringDummyController], + }); + + controller = container.module.get( + MonitoringDummyController, + ); + }); + + it('should build', () => { + expect(controller).toBeInstanceOf(MonitoringDummyController); + }); +}); diff --git a/src/monitoring/monitoring.dummy-controller.ts b/src/monitoring/monitoring.dummy-controller.ts new file mode 100644 index 0000000..1d3bad8 --- /dev/null +++ b/src/monitoring/monitoring.dummy-controller.ts @@ -0,0 +1,9 @@ +import { Controller } from '@nestjs/common'; + +/** + * This is an empty controller that is used to disable the default /metrics route. + * /metrics should not be available within the application context, but instead + * will be exposed on a different node process. + */ +@Controller() +export class MonitoringDummyController {} diff --git a/src/monitoring/monitoring.external-module.ts b/src/monitoring/monitoring.external-module.ts new file mode 100644 index 0000000..6fd22d6 --- /dev/null +++ b/src/monitoring/monitoring.external-module.ts @@ -0,0 +1,18 @@ +import { Module } from '@nestjs/common'; +import { PrometheusModule } from '@willsoto/nestjs-prometheus'; + +/** + * The external monitoring module does not define any metrics itself, and instead + * only exposed the /metrics route. The module will be served on a seperate process + * and listens to another port. + */ +@Module({ + imports: [ + PrometheusModule.register({ + defaultMetrics: { + enabled: false, + }, + }), + ], +}) +export class MonitoringExternalModule {} diff --git a/src/monitoring/monitoring.module-internal.ts b/src/monitoring/monitoring.module-internal.ts new file mode 100644 index 0000000..3c8aec1 --- /dev/null +++ b/src/monitoring/monitoring.module-internal.ts @@ -0,0 +1,17 @@ +import { Module } from '@nestjs/common'; +import { PrometheusModule } from '@willsoto/nestjs-prometheus'; +import { MonitoringDummyController } from './monitoring.dummy-controller'; + +/** + * The internal monitoring module does not expose a /metrics route, but defines and + * collects metrics from the application. It is included into the main application module. + */ +@Module({ + imports: [ + PrometheusModule.register({ + controller: MonitoringDummyController, + }), + ], +}) +export class MonitoringInteralModule {} + From 0a57e700714327aa636776f5e9cf75b012956216 Mon Sep 17 00:00:00 2001 From: "@LeopoldHock" Date: Mon, 15 Jan 2024 12:58:36 +0100 Subject: [PATCH 2/3] style: removed a linebreak --- src/monitoring/monitoring.module-internal.ts | 1 - 1 file changed, 1 deletion(-) diff --git a/src/monitoring/monitoring.module-internal.ts b/src/monitoring/monitoring.module-internal.ts index 3c8aec1..f8381e7 100644 --- a/src/monitoring/monitoring.module-internal.ts +++ b/src/monitoring/monitoring.module-internal.ts @@ -14,4 +14,3 @@ import { MonitoringDummyController } from './monitoring.dummy-controller'; ], }) export class MonitoringInteralModule {} - From ac23827cfd842af40433791b90253db7f8b1e0be Mon Sep 17 00:00:00 2001 From: "@LeopoldHock" Date: Mon, 15 Jan 2024 13:42:53 +0100 Subject: [PATCH 3/3] fix: enabled default metrics --- src/monitoring/monitoring.external-module.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/monitoring/monitoring.external-module.ts b/src/monitoring/monitoring.external-module.ts index 6fd22d6..64c9eec 100644 --- a/src/monitoring/monitoring.external-module.ts +++ b/src/monitoring/monitoring.external-module.ts @@ -10,7 +10,7 @@ import { PrometheusModule } from '@willsoto/nestjs-prometheus'; imports: [ PrometheusModule.register({ defaultMetrics: { - enabled: false, + enabled: true, }, }), ],