feat: Integrate Prometheus metrics support with configuration options in environment variables

Author: letnull19A

DEPLOY.md

@@ -55,6 +55,12 @@ S3_REGION=us-east-1
 # S3_ENDPOINT=https://s3.ru1.storage.beget.cloud
 # S3_PUBLIC_URL_TEMPLATE=https://{bucket}.s3.{region}.amazonaws.com/{key}
 # S3_FORCE_PATH_STYLE=true
+
+# Prometheus метрики (опционально)
+# PROMETHEUS_ENABLED=true
+# PROMETHEUS_PATH=/metrics
+# PROMETHEUS_DEFAULT_METRICS=true
+# PROMETHEUS_DEFAULT_LABELS={"app":"atom-dbro","env":"production"}
 ```
 
 **⚠️ ВАЖНО**: 
@@ -418,6 +424,12 @@ S3_ACCESS_KEY_ID=your-access-key-id
 S3_SECRET_ACCESS_KEY=your-secret-access-key
 S3_REGION=us-east-1
 
+# Prometheus метрики (опционально)
+# PROMETHEUS_ENABLED=true
+# PROMETHEUS_PATH=/metrics
+# PROMETHEUS_DEFAULT_METRICS=true
+# PROMETHEUS_DEFAULT_LABELS={"app":"atom-dbro","env":"production"}
+
 # Docker Image (для docker-compose.yml)
 # Переменная DOCKER_IMAGE будет установлена автоматически при деплое
 # Не нужно указывать в .env файле

README.md

@@ -49,6 +49,36 @@ CORS_ORIGINS=http://localhost:5173,https://yourdomain.com,https://app.yourdomain
 
 **Примечание:** В development режиме (`NODE_ENV !== 'production'`) автоматически разрешаются все локальные адреса (`localhost:*` и `127.0.0.1:*`).
 
+### Prometheus метрики
+
+Приложение поддерживает экспорт метрик Prometheus для мониторинга.
+
+**Конфигурация через переменные окружения:**
+```env
+# Включить/выключить Prometheus (по умолчанию: true)
+PROMETHEUS_ENABLED=true
+
+# Путь для endpoint метрик (по умолчанию: /metrics)
+PROMETHEUS_PATH=/metrics
+
+# Включить стандартные метрики Node.js (по умолчанию: true)
+PROMETHEUS_DEFAULT_METRICS=true
+
+# Дополнительные метки для всех метрик (JSON формат, опционально)
+PROMETHEUS_DEFAULT_LABELS={"app":"atom-dbro","env":"production"}
+```
+
+**Доступ к метрикам:**
+После запуска приложения метрики доступны по адресу (с учетом глобального префикса `admin/api`):
+```
+http://localhost:3000/admin/api/metrics
+```
+
+**Примечание:** 
+- Если `PROMETHEUS_ENABLED=false`, endpoint не будет создан
+- Путь `PROMETHEUS_PATH` указывается относительно корня приложения, но с учетом глобального префикса `admin/api`
+- Для доступа к метрикам без префикса установите `PROMETHEUS_PATH=/metrics` и используйте `http://localhost:3000/metrics`
+
 ## Запуск
 
 ```bash

package-lock.json

@@ -36,6 +36,7 @@
     "@nestjs/platform-express": "^10.0.0",
     "@nestjs/swagger": "^7.0.0",
     "@types/uuid": "^10.0.0",
+    "@willsoto/nestjs-prometheus": "^6.0.2",
     "bcrypt": "5.1.1",
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.0",
@@ -47,6 +48,7 @@
     "passport": "^0.6.0",
     "passport-jwt": "^4.0.1",
     "pg": "^8.11.0",
+    "prom-client": "^15.1.3",
     "reflect-metadata": "^0.1.13",
     "rxjs": "^7.8.0",
     "swagger-ui-express": "^5.0.0",

package.json

@@ -16,6 +16,7 @@ import { CategoryModule } from './category/category.module';
 import { QuestUpdateModule } from './quest-update/quest-update.module';
 import { OrganizationUpdateModule } from './organization-update/organization-update.module';
 import { AppController } from './app.controller';
+import { PrometheusModule } from './prometheus/prometheus.module';
 
 @Module({
   imports: [
@@ -39,6 +40,7 @@ import { AppController } from './app.controller';
     CategoryModule,
     QuestUpdateModule,
     OrganizationUpdateModule,
+    PrometheusModule,
   ],
   controllers: [AppController],
 })

src/app.module.ts

@@ -0,0 +1,39 @@
+import { Module } from '@nestjs/common';
+import { ConfigModule, ConfigService } from '@nestjs/config';
+import { PrometheusModule as PrometheusModuleLib } from '@willsoto/nestjs-prometheus';
+
+@Module({
+  imports: [
+    PrometheusModuleLib.forRootAsync({
+      imports: [ConfigModule],
+      useFactory: (configService: ConfigService) => {
+        const enabled = configService.get<string>('PROMETHEUS_ENABLED', 'true') === 'true';
+        const path = configService.get<string>('PROMETHEUS_PATH', '/metrics');
+        const defaultMetrics = configService.get<string>('PROMETHEUS_DEFAULT_METRICS', 'true') === 'true';
+        const defaultLabels = configService.get<string>('PROMETHEUS_DEFAULT_LABELS', '{}');
+
+        let parsedLabels = {};
+        try {
+          if (defaultLabels && defaultLabels !== '{}') {
+            parsedLabels = JSON.parse(defaultLabels);
+          }
+        } catch (e) {
+          // Если не удалось распарсить, используем пустой объект
+        }
+
+        return {
+          defaultMetrics: {
+            enabled: defaultMetrics && enabled,
+          },
+          defaultLabels: parsedLabels,
+          // Если Prometheus отключен, не создаем endpoint
+          path: enabled ? path : undefined,
+        };
+      },
+      inject: [ConfigService],
+    }),
+  ],
+  exports: [PrometheusModuleLib],
+})
+export class PrometheusModule {}
+