From eeb8f411ac471df354a2c854b8ca9f0506788053 Mon Sep 17 00:00:00 2001 From: SavelyG Date: Wed, 5 Feb 2025 11:39:19 +0000 Subject: [PATCH] add prometheus module --- package-lock.json | 44 ++++++++++++++--- package.json | 1 + src/app.controller.spec.ts | 22 --------- src/app.controller.ts | 12 ----- src/app.module.ts | 7 +-- src/app.service.ts | 8 ---- src/main.ts | 2 +- src/prometheus/dto/prometheus.dto.ts | 0 .../interface/prometheus.interface.ts | 48 +++++++++++++++++++ src/prometheus/prometheus.controller.ts | 15 ++++++ src/prometheus/prometheus.module.ts | 9 ++++ src/prometheus/prometheus.service.spec.ts | 18 +++++++ src/prometheus/prometheus.service.ts | 32 +++++++++++++ 13 files changed, 164 insertions(+), 54 deletions(-) delete mode 100644 src/app.controller.spec.ts delete mode 100644 src/app.controller.ts delete mode 100644 src/app.service.ts create mode 100644 src/prometheus/dto/prometheus.dto.ts create mode 100644 src/prometheus/interface/prometheus.interface.ts create mode 100644 src/prometheus/prometheus.controller.ts create mode 100644 src/prometheus/prometheus.module.ts create mode 100644 src/prometheus/prometheus.service.spec.ts create mode 100644 src/prometheus/prometheus.service.ts diff --git a/package-lock.json b/package-lock.json index a26d81f..bde7585 100644 --- a/package-lock.json +++ b/package-lock.json @@ -12,6 +12,7 @@ "@nestjs/common": "^11.0.1", "@nestjs/core": "^11.0.1", "@nestjs/platform-express": "^11.0.1", + "axios": "^1.7.9", "reflect-metadata": "^0.2.2", "rxjs": "^7.8.1" }, @@ -4025,9 +4026,19 @@ "version": "0.4.0", "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", "integrity": "sha512-Oei9OH4tRh0YqU3GxhX79dM/mwVgvbZJaSNaRk+bshkj0S5cfHcgYakreBjrHwatXKbz+IoIdYLxrKim2MjW0Q==", - "dev": true, "license": "MIT" }, + "node_modules/axios": { + "version": "1.7.9", + "resolved": "https://registry.npmjs.org/axios/-/axios-1.7.9.tgz", + "integrity": "sha512-LhLcE7Hbiryz8oMDdDptSrWowmB4Bl6RCt6sIJKpRB4XtVf0iEgewX3au/pJqm+Py1kCASkb/FFKjxQaLtxJvw==", + "license": "MIT", + "dependencies": { + "follow-redirects": "^1.15.6", + "form-data": "^4.0.0", + "proxy-from-env": "^1.1.0" + } + }, "node_modules/b4a": { "version": "1.6.7", "resolved": "https://registry.npmjs.org/b4a/-/b4a-1.6.7.tgz", @@ -4834,7 +4845,6 @@ "version": "1.0.8", "resolved": "https://registry.npmjs.org/combined-stream/-/combined-stream-1.0.8.tgz", "integrity": "sha512-FQN4MRfuJeHf7cBbBMJFXhKSDq+2kAArBlmRBvcvFE5BB1HZKXtSFASDhdlz9zOYwxh8lDdnvmMOe/+5cdoEdg==", - "dev": true, "license": "MIT", "dependencies": { "delayed-stream": "~1.0.0" @@ -5160,7 +5170,6 @@ "version": "1.0.0", "resolved": "https://registry.npmjs.org/delayed-stream/-/delayed-stream-1.0.0.tgz", "integrity": "sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==", - "dev": true, "license": "MIT", "engines": { "node": ">=0.4.0" @@ -6157,6 +6166,26 @@ "dev": true, "license": "ISC" }, + "node_modules/follow-redirects": { + "version": "1.15.9", + "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.15.9.tgz", + "integrity": "sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==", + "funding": [ + { + "type": "individual", + "url": "https://github.com/sponsors/RubenVerborgh" + } + ], + "license": "MIT", + "engines": { + "node": ">=4.0" + }, + "peerDependenciesMeta": { + "debug": { + "optional": true + } + } + }, "node_modules/foreground-child": { "version": "3.3.0", "resolved": "https://registry.npmjs.org/foreground-child/-/foreground-child-3.3.0.tgz", @@ -6271,7 +6300,6 @@ "version": "4.0.1", "resolved": "https://registry.npmjs.org/form-data/-/form-data-4.0.1.tgz", "integrity": "sha512-tzN8e4TX8+kkxGPK8D5u0FNmjPUjw3lwC9lSLxxoB/+GtsJG91CO8bSWy73APlgAZzZbXEYZJuxjkHH2w+Ezhw==", - "dev": true, "license": "MIT", "dependencies": { "asynckit": "^0.4.0", @@ -6296,7 +6324,6 @@ "version": "1.52.0", "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.52.0.tgz", "integrity": "sha512-sPU4uV7dYlvtWJxwwxHD0PuihVNiE7TyAbQ5SWxDCB9mUYvOgroQOwYQQOKPJ8CIbE+1ETVlOoK1UC2nU3gYvg==", - "dev": true, "license": "MIT", "engines": { "node": ">= 0.6" @@ -6306,7 +6333,6 @@ "version": "2.1.35", "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.35.tgz", "integrity": "sha512-ZDY+bPm5zTTF+YpCrAU9nK0UgICYPT0QtT1NZWFv4s++TNkcgVaT0g6+4R2uI4MjQjzysHB1zxuWL50hzaeXiw==", - "dev": true, "license": "MIT", "dependencies": { "mime-db": "1.52.0" @@ -8996,6 +9022,12 @@ "node": ">= 0.10" } }, + "node_modules/proxy-from-env": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/proxy-from-env/-/proxy-from-env-1.1.0.tgz", + "integrity": "sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==", + "license": "MIT" + }, "node_modules/punycode": { "version": "2.3.1", "resolved": "https://registry.npmjs.org/punycode/-/punycode-2.3.1.tgz", diff --git a/package.json b/package.json index 85160c4..f8b8189 100644 --- a/package.json +++ b/package.json @@ -23,6 +23,7 @@ "@nestjs/common": "^11.0.1", "@nestjs/core": "^11.0.1", "@nestjs/platform-express": "^11.0.1", + "axios": "^1.7.9", "reflect-metadata": "^0.2.2", "rxjs": "^7.8.1" }, diff --git a/src/app.controller.spec.ts b/src/app.controller.spec.ts deleted file mode 100644 index d22f389..0000000 --- a/src/app.controller.spec.ts +++ /dev/null @@ -1,22 +0,0 @@ -import { Test, TestingModule } from '@nestjs/testing'; -import { AppController } from './app.controller'; -import { AppService } from './app.service'; - -describe('AppController', () => { - let appController: AppController; - - beforeEach(async () => { - const app: TestingModule = await Test.createTestingModule({ - controllers: [AppController], - providers: [AppService], - }).compile(); - - appController = app.get(AppController); - }); - - describe('root', () => { - it('should return "Hello World!"', () => { - expect(appController.getHello()).toBe('Hello World!'); - }); - }); -}); diff --git a/src/app.controller.ts b/src/app.controller.ts deleted file mode 100644 index cce879e..0000000 --- a/src/app.controller.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { Controller, Get } from '@nestjs/common'; -import { AppService } from './app.service'; - -@Controller() -export class AppController { - constructor(private readonly appService: AppService) {} - - @Get() - getHello(): string { - return this.appService.getHello(); - } -} diff --git a/src/app.module.ts b/src/app.module.ts index 8662803..1f70431 100644 --- a/src/app.module.ts +++ b/src/app.module.ts @@ -1,10 +1,7 @@ import { Module } from '@nestjs/common'; -import { AppController } from './app.controller'; -import { AppService } from './app.service'; +import { PrometheusModule } from './prometheus/prometheus.module'; @Module({ - imports: [], - controllers: [AppController], - providers: [AppService], + imports: [PrometheusModule], }) export class AppModule {} diff --git a/src/app.service.ts b/src/app.service.ts deleted file mode 100644 index 927d7cc..0000000 --- a/src/app.service.ts +++ /dev/null @@ -1,8 +0,0 @@ -import { Injectable } from '@nestjs/common'; - -@Injectable() -export class AppService { - getHello(): string { - return 'Hello World!'; - } -} diff --git a/src/main.ts b/src/main.ts index f76bc8d..ff7d2ee 100644 --- a/src/main.ts +++ b/src/main.ts @@ -5,4 +5,4 @@ async function bootstrap() { const app = await NestFactory.create(AppModule); await app.listen(process.env.PORT ?? 3000); } -bootstrap(); +void bootstrap(); diff --git a/src/prometheus/dto/prometheus.dto.ts b/src/prometheus/dto/prometheus.dto.ts new file mode 100644 index 0000000..e69de29 diff --git a/src/prometheus/interface/prometheus.interface.ts b/src/prometheus/interface/prometheus.interface.ts new file mode 100644 index 0000000..5c63125 --- /dev/null +++ b/src/prometheus/interface/prometheus.interface.ts @@ -0,0 +1,48 @@ +export type PrometheusResultType = 'vector' | 'matrix' | 'scalar' | 'string'; + +/** Универсальный интерфейс для всех вариантов данных */ +export type PrometheusQueryResult = + | VectorData + | MatrixData + | ScalarData + | StringData; + +/** Обобщенный интерфейс ответа Prometheus */ +export interface PrometheusApiResponse { + status: 'success' | 'error'; + data: T; + errorType?: string; + error?: unknown; + warnings?: unknown[]; + infos?: unknown[]; +} + +/** Данные типа Vector (одиночные значения) */ +export interface VectorData { + resultType: 'vector'; + result: Array<{ + metric: Record; + value: [number, string]; + }>; +} + +/** Данные типа Matrix (временные ряды) */ +export interface MatrixData { + resultType: 'matrix'; + result: Array<{ + metric: Record; + values: Array<[number, string]>; + }>; +} + +/** Данные типа Scalar (одно значение) */ +export interface ScalarData { + resultType: 'scalar'; + result: [number, string]; +} + +/** Данные типа String (строковое значение) */ +export interface StringData { + resultType: 'string'; + result: string; +} diff --git a/src/prometheus/prometheus.controller.ts b/src/prometheus/prometheus.controller.ts new file mode 100644 index 0000000..320518b --- /dev/null +++ b/src/prometheus/prometheus.controller.ts @@ -0,0 +1,15 @@ +import { Controller, Get, Query } from '@nestjs/common'; +import { PrometheusService } from './prometheus.service'; +import { PrometheusQueryResult } from './interface/prometheus.interface'; + +@Controller('metrics') +export class PrometheusController { + constructor(private readonly prometheusService: PrometheusService) {} + + @Get() + async getMetrics( + @Query('name') metric: string, + ): Promise { + return this.prometheusService.getMetric(metric); + } +} diff --git a/src/prometheus/prometheus.module.ts b/src/prometheus/prometheus.module.ts new file mode 100644 index 0000000..6e18a7a --- /dev/null +++ b/src/prometheus/prometheus.module.ts @@ -0,0 +1,9 @@ +import { Module } from '@nestjs/common'; +import { PrometheusService } from './prometheus.service'; +import { PrometheusController } from './prometheus.controller'; + +@Module({ + controllers: [PrometheusController], + providers: [PrometheusService], +}) +export class PrometheusModule {} diff --git a/src/prometheus/prometheus.service.spec.ts b/src/prometheus/prometheus.service.spec.ts new file mode 100644 index 0000000..4d5e217 --- /dev/null +++ b/src/prometheus/prometheus.service.spec.ts @@ -0,0 +1,18 @@ +import { Test, TestingModule } from '@nestjs/testing'; +import { PrometheusService } from './prometheus.service'; + +describe('PrometheusService', () => { + let service: PrometheusService; + + beforeEach(async () => { + const module: TestingModule = await Test.createTestingModule({ + providers: [PrometheusService], + }).compile(); + + service = module.get(PrometheusService); + }); + + it('should be defined', () => { + expect(service).toBeDefined(); + }); +}); diff --git a/src/prometheus/prometheus.service.ts b/src/prometheus/prometheus.service.ts new file mode 100644 index 0000000..ba6962a --- /dev/null +++ b/src/prometheus/prometheus.service.ts @@ -0,0 +1,32 @@ +import { Injectable, InternalServerErrorException } from '@nestjs/common'; +import axios from 'axios'; +import { + PrometheusQueryResult, + PrometheusApiResponse, +} from './interface/prometheus.interface'; + +@Injectable() +export class PrometheusService { + private readonly prometheusUrl = 'http://prometheus:9090/api/v1/query'; + + async getMetric(metric: string): Promise { + try { + const response = await axios.get< + PrometheusApiResponse + >(this.prometheusUrl, { + params: { query: metric }, + }); + + return response.data.data; + } catch (error: unknown) { + if (error instanceof Error) { + throw new InternalServerErrorException( + `Ошибка запроса: ${error.message}`, + ); + } + throw new InternalServerErrorException( + 'Неизвестная ошибка при запросе к Prometheus', + ); + } + } +}