@rsdk/db.typeorm 5.15.0-next.8 → 5.15.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/dist/metrics/entity-operations.subscriber.d.ts +18 -0
- package/dist/metrics/entity-operations.subscriber.js +33 -0
- package/dist/metrics/entity-operations.subscriber.js.map +1 -0
- package/dist/metrics/pg-pools.d.ts +18 -0
- package/dist/metrics/pg-pools.js +38 -0
- package/dist/metrics/pg-pools.js.map +1 -0
- package/dist/metrics/query-cache.instrumentation.d.ts +12 -0
- package/dist/metrics/query-cache.instrumentation.js +29 -0
- package/dist/metrics/query-cache.instrumentation.js.map +1 -0
- package/dist/metrics/subscribers.d.ts +7 -0
- package/dist/metrics/subscribers.js +20 -0
- package/dist/metrics/subscribers.js.map +1 -0
- package/dist/metrics/typeorm.metrics.d.ts +3 -0
- package/dist/metrics/typeorm.metrics.js +23 -0
- package/dist/metrics/typeorm.metrics.js.map +1 -0
- package/dist/modules/metrics.module.d.ts +36 -0
- package/dist/modules/metrics.module.js +99 -0
- package/dist/modules/metrics.module.js.map +1 -0
- package/dist/typeorm.plugin.js +2 -0
- package/dist/typeorm.plugin.js.map +1 -1
- package/package.json +2 -2
- package/src/metrics/entity-operations.subscriber.spec.ts +44 -0
- package/src/metrics/entity-operations.subscriber.ts +43 -0
- package/src/metrics/pg-pools.spec.ts +53 -0
- package/src/metrics/pg-pools.ts +47 -0
- package/src/metrics/query-cache.instrumentation.spec.ts +64 -0
- package/src/metrics/query-cache.instrumentation.ts +43 -0
- package/src/metrics/subscribers.spec.ts +38 -0
- package/src/metrics/subscribers.ts +23 -0
- package/src/metrics/typeorm.metrics.ts +10 -0
- package/src/modules/metrics.module.spec.ts +267 -0
- package/src/modules/metrics.module.ts +122 -0
- package/src/typeorm.plugin.ts +2 -0
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [5.15.0](https://github.com/R-Vision/rsdk/compare/v5.15.0-next.14...v5.15.0) (2026-10-30)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @rsdk/db.typeorm
|
|
9
|
+
|
|
6
10
|
## [5.14.1](https://github.com/R-Vision/rsdk/compare/v5.14.1-next.0...v5.14.1) (2026-09-16)
|
|
7
11
|
|
|
8
12
|
**Note:** Version bump only for package @rsdk/db.typeorm
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { EntityOperationsRecorder } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
2
|
+
import type { EntitySubscriberInterface, InsertEvent, LoadEvent, RemoveEvent, SoftRemoveEvent, UpdateEvent } from 'typeorm';
|
|
3
|
+
/**
|
|
4
|
+
* Пишет `orm_entity_operations_total` по событиям, которые TypeORM
|
|
5
|
+
* рассылает subscriber-ам: от EntityManager, репозиториев и QueryBuilder,
|
|
6
|
+
* если у него не выключено `callListeners(false)`. Загрузки, insert, save
|
|
7
|
+
* и remove считаются по сущностям, update и delete по условию — один раз
|
|
8
|
+
* на запрос, сколько бы строк ни изменилось
|
|
9
|
+
*/
|
|
10
|
+
export declare class EntityOperationsSubscriber implements EntitySubscriberInterface {
|
|
11
|
+
private readonly recorder;
|
|
12
|
+
constructor(recorder: EntityOperationsRecorder);
|
|
13
|
+
afterLoad(entity: object, event?: LoadEvent<object>): void;
|
|
14
|
+
afterInsert(event: InsertEvent<object>): void;
|
|
15
|
+
afterUpdate(event: UpdateEvent<object>): void;
|
|
16
|
+
afterRemove(event: RemoveEvent<object>): void;
|
|
17
|
+
afterSoftRemove(event: SoftRemoveEvent<object>): void;
|
|
18
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.EntityOperationsSubscriber = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Пишет `orm_entity_operations_total` по событиям, которые TypeORM
|
|
6
|
+
* рассылает subscriber-ам: от EntityManager, репозиториев и QueryBuilder,
|
|
7
|
+
* если у него не выключено `callListeners(false)`. Загрузки, insert, save
|
|
8
|
+
* и remove считаются по сущностям, update и delete по условию — один раз
|
|
9
|
+
* на запрос, сколько бы строк ни изменилось
|
|
10
|
+
*/
|
|
11
|
+
class EntityOperationsSubscriber {
|
|
12
|
+
recorder;
|
|
13
|
+
constructor(recorder) {
|
|
14
|
+
this.recorder = recorder;
|
|
15
|
+
}
|
|
16
|
+
afterLoad(entity, event) {
|
|
17
|
+
this.recorder.record(event?.metadata.name ?? entity.constructor.name, 'load');
|
|
18
|
+
}
|
|
19
|
+
afterInsert(event) {
|
|
20
|
+
this.recorder.record(event.metadata.name, 'insert');
|
|
21
|
+
}
|
|
22
|
+
afterUpdate(event) {
|
|
23
|
+
this.recorder.record(event.metadata.name, 'update');
|
|
24
|
+
}
|
|
25
|
+
afterRemove(event) {
|
|
26
|
+
this.recorder.record(event.metadata.name, 'delete');
|
|
27
|
+
}
|
|
28
|
+
afterSoftRemove(event) {
|
|
29
|
+
this.recorder.record(event.metadata.name, 'delete');
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
exports.EntityOperationsSubscriber = EntityOperationsSubscriber;
|
|
33
|
+
//# sourceMappingURL=entity-operations.subscriber.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"entity-operations.subscriber.js","sourceRoot":"","sources":["../../src/metrics/entity-operations.subscriber.ts"],"names":[],"mappings":";;;AAUA;;;;;;GAMG;AACH,MAAa,0BAA0B;IACR;IAA7B,YAA6B,QAAkC;QAAlC,aAAQ,GAAR,QAAQ,CAA0B;IAAG,CAAC;IAEnE,SAAS,CAAC,MAAc,EAAE,KAAyB;QACjD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAClB,KAAK,EAAE,QAAQ,CAAC,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,EAC/C,MAAM,CACP,CAAC;IACJ,CAAC;IAED,WAAW,CAAC,KAA0B;QACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,WAAW,CAAC,KAA0B;QACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,WAAW,CAAC,KAA0B;QACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;IAED,eAAe,CAAC,KAA8B;QAC5C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACtD,CAAC;CACF;AAzBD,gEAyBC"}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { DataSource } from 'typeorm';
|
|
2
|
+
export interface PgPoolResource {
|
|
3
|
+
resource: string;
|
|
4
|
+
pool: unknown;
|
|
5
|
+
}
|
|
6
|
+
/**
|
|
7
|
+
* Пулы `pg` у драйверов postgres и cockroachdb: master первым, за ним
|
|
8
|
+
* реплики (если `driver.slaves` — массив). Для остальных драйверов список
|
|
9
|
+
* пуст.
|
|
10
|
+
*
|
|
11
|
+
* Здесь пулы только находятся: что это действительно пул `pg`, проверяет
|
|
12
|
+
* `DbClientMetrics.instrumentPool`.
|
|
13
|
+
*
|
|
14
|
+
* `resource` — вторая часть значения метки `pool`: `typeorm` у master,
|
|
15
|
+
* `typeorm:slave<index>` у реплик. Имя приложения из `APP_NAME` к нему
|
|
16
|
+
* добавляет `DbClientMetrics`
|
|
17
|
+
*/
|
|
18
|
+
export declare const findPgPools: (dataSource: DataSource) => PgPoolResource[];
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.findPgPools = void 0;
|
|
4
|
+
const RESOURCE = 'typeorm';
|
|
5
|
+
/**
|
|
6
|
+
* Драйверы TypeORM, которые создают пул через `pg.Pool`
|
|
7
|
+
*/
|
|
8
|
+
const PG_DRIVERS = new Set(['postgres', 'cockroachdb']);
|
|
9
|
+
/**
|
|
10
|
+
* Пулы `pg` у драйверов postgres и cockroachdb: master первым, за ним
|
|
11
|
+
* реплики (если `driver.slaves` — массив). Для остальных драйверов список
|
|
12
|
+
* пуст.
|
|
13
|
+
*
|
|
14
|
+
* Здесь пулы только находятся: что это действительно пул `pg`, проверяет
|
|
15
|
+
* `DbClientMetrics.instrumentPool`.
|
|
16
|
+
*
|
|
17
|
+
* `resource` — вторая часть значения метки `pool`: `typeorm` у master,
|
|
18
|
+
* `typeorm:slave<index>` у реплик. Имя приложения из `APP_NAME` к нему
|
|
19
|
+
* добавляет `DbClientMetrics`
|
|
20
|
+
*/
|
|
21
|
+
const findPgPools = (dataSource) => {
|
|
22
|
+
if (!PG_DRIVERS.has(dataSource.options.type)) {
|
|
23
|
+
return [];
|
|
24
|
+
}
|
|
25
|
+
// Поля драйвера внутренние, их форма не гарантирована: `master` проверяет
|
|
26
|
+
// `instrumentPool`, а если `slaves` не массив, реплик нет
|
|
27
|
+
const { master, slaves } = dataSource.driver;
|
|
28
|
+
const replicas = Array.isArray(slaves) ? slaves : [];
|
|
29
|
+
return [
|
|
30
|
+
{ resource: RESOURCE, pool: master },
|
|
31
|
+
...replicas.map((pool, index) => ({
|
|
32
|
+
resource: `${RESOURCE}:slave${index}`,
|
|
33
|
+
pool,
|
|
34
|
+
})),
|
|
35
|
+
];
|
|
36
|
+
};
|
|
37
|
+
exports.findPgPools = findPgPools;
|
|
38
|
+
//# sourceMappingURL=pg-pools.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pg-pools.js","sourceRoot":"","sources":["../../src/metrics/pg-pools.ts"],"names":[],"mappings":";;;AAOA,MAAM,QAAQ,GAAG,SAAS,CAAC;AAE3B;;GAEG;AACH,MAAM,UAAU,GAAwB,IAAI,GAAG,CAAC,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC,CAAC;AAE7E;;;;;;;;;;;GAWG;AACI,MAAM,WAAW,GAAG,CAAC,UAAsB,EAAoB,EAAE;IACtE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7C,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,0EAA0E;IAC1E,0DAA0D;IAC1D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,MAGrC,CAAC;IACF,MAAM,QAAQ,GAAc,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC;IAEhE,OAAO;QACL,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE;QACpC,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;YAChC,QAAQ,EAAE,GAAG,QAAQ,SAAS,KAAK,EAAE;YACrC,IAAI;SACL,CAAC,CAAC;KACJ,CAAC;AACJ,CAAC,CAAC;AApBW,QAAA,WAAW,eAoBtB"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { CounterLike, Detach } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
2
|
+
import type { QueryResultCache } from 'typeorm/cache/QueryResultCache';
|
|
3
|
+
/**
|
|
4
|
+
* Считает попадания в кеш запросов. Повторяет проверку из
|
|
5
|
+
* `SelectQueryBuilder.loadRawResults`: попадание — это запись в кеше,
|
|
6
|
+
* которая ещё не устарела
|
|
7
|
+
*/
|
|
8
|
+
export declare class QueryCacheInstrumentation {
|
|
9
|
+
private readonly counter;
|
|
10
|
+
constructor(counter: CounterLike<'result'>);
|
|
11
|
+
instrument(cache: QueryResultCache): Detach;
|
|
12
|
+
}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.QueryCacheInstrumentation = void 0;
|
|
4
|
+
const plugin_kit_1 = require("@rsdk/db/dist/metrics/plugin-kit");
|
|
5
|
+
/**
|
|
6
|
+
* Считает попадания в кеш запросов. Повторяет проверку из
|
|
7
|
+
* `SelectQueryBuilder.loadRawResults`: попадание — это запись в кеше,
|
|
8
|
+
* которая ещё не устарела
|
|
9
|
+
*/
|
|
10
|
+
class QueryCacheInstrumentation {
|
|
11
|
+
counter;
|
|
12
|
+
constructor(counter) {
|
|
13
|
+
this.counter = counter;
|
|
14
|
+
}
|
|
15
|
+
instrument(cache) {
|
|
16
|
+
const originalGetFromCache = cache.getFromCache;
|
|
17
|
+
const counter = this.counter;
|
|
18
|
+
return (0, plugin_kit_1.replaceMethod)(cache, 'getFromCache', async function (options, queryRunner) {
|
|
19
|
+
const saved = await originalGetFromCache.call(this, options, queryRunner);
|
|
20
|
+
// HACK: Redis-кеш при промахе отдаёт `null`, хотя в типах только
|
|
21
|
+
// `undefined`, поэтому проверка на truthy, как в TypeORM
|
|
22
|
+
const hit = !!saved && !this.isExpired(saved);
|
|
23
|
+
counter.inc({ result: hit ? 'hit' : 'miss' });
|
|
24
|
+
return saved;
|
|
25
|
+
});
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
exports.QueryCacheInstrumentation = QueryCacheInstrumentation;
|
|
29
|
+
//# sourceMappingURL=query-cache.instrumentation.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"query-cache.instrumentation.js","sourceRoot":"","sources":["../../src/metrics/query-cache.instrumentation.ts"],"names":[],"mappings":";;;AACA,iEAAiE;AAKjE;;;;GAIG;AACH,MAAa,yBAAyB;IACP;IAA7B,YAA6B,OAA8B;QAA9B,YAAO,GAAP,OAAO,CAAuB;IAAG,CAAC;IAE/D,UAAU,CAAC,KAAuB;QAChC,MAAM,oBAAoB,GAAG,KAAK,CAAC,YAAY,CAAC;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC;QAE7B,OAAO,IAAA,0BAAa,EAClB,KAAK,EACL,cAAc,EACd,KAAK,WAEH,OAAgC,EAChC,WAAyB;YAEzB,MAAM,KAAK,GAAG,MAAM,oBAAoB,CAAC,IAAI,CAC3C,IAAI,EACJ,OAAO,EACP,WAAW,CACZ,CAAC;YAEF,iEAAiE;YACjE,yDAAyD;YACzD,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YAE9C,OAAO,CAAC,GAAG,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;YAE9C,OAAO,KAAK,CAAC;QACf,CAAC,CACF,CAAC;IACJ,CAAC;CACF;AA/BD,8DA+BC"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Detach } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
2
|
+
import type { DataSource, EntitySubscriberInterface } from 'typeorm';
|
|
3
|
+
/**
|
|
4
|
+
* Добавляет subscriber в уже инициализированный DataSource. Detach убирает
|
|
5
|
+
* его из `dataSource.subscribers`; повторный вызов ничего не делает
|
|
6
|
+
*/
|
|
7
|
+
export declare const addSubscriber: (dataSource: DataSource, subscriber: EntitySubscriberInterface) => Detach;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.addSubscriber = void 0;
|
|
4
|
+
const plugin_kit_1 = require("@rsdk/db/dist/metrics/plugin-kit");
|
|
5
|
+
/**
|
|
6
|
+
* Добавляет subscriber в уже инициализированный DataSource. Detach убирает
|
|
7
|
+
* его из `dataSource.subscribers`; повторный вызов ничего не делает
|
|
8
|
+
*/
|
|
9
|
+
const addSubscriber = (dataSource, subscriber) => {
|
|
10
|
+
const subscribers = dataSource.subscribers;
|
|
11
|
+
subscribers.push(subscriber);
|
|
12
|
+
return (0, plugin_kit_1.once)(() => {
|
|
13
|
+
const index = subscribers.indexOf(subscriber);
|
|
14
|
+
if (index !== -1) {
|
|
15
|
+
subscribers.splice(index, 1);
|
|
16
|
+
}
|
|
17
|
+
});
|
|
18
|
+
};
|
|
19
|
+
exports.addSubscriber = addSubscriber;
|
|
20
|
+
//# sourceMappingURL=subscribers.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"subscribers.js","sourceRoot":"","sources":["../../src/metrics/subscribers.ts"],"names":[],"mappings":";;;AACA,iEAAwD;AAGxD;;;GAGG;AACI,MAAM,aAAa,GAAG,CAC3B,UAAsB,EACtB,UAAqC,EAC7B,EAAE;IACV,MAAM,WAAW,GAAG,UAAU,CAAC,WAA0C,CAAC;IAE1E,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IAE7B,OAAO,IAAA,iBAAI,EAAC,GAAG,EAAE;QACf,MAAM,KAAK,GAAG,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC9C,IAAI,KAAK,KAAK,CAAC,CAAC,EAAE,CAAC;YACjB,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAdW,QAAA,aAAa,iBAcxB"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
9
|
+
exports.TypeOrmQueryCache = void 0;
|
|
10
|
+
const core_1 = require("@rsdk/core");
|
|
11
|
+
const plugin_kit_1 = require("@rsdk/db/dist/metrics/plugin-kit");
|
|
12
|
+
let TypeOrmQueryCache = class TypeOrmQueryCache extends core_1.Counter {
|
|
13
|
+
};
|
|
14
|
+
exports.TypeOrmQueryCache = TypeOrmQueryCache;
|
|
15
|
+
exports.TypeOrmQueryCache = TypeOrmQueryCache = __decorate([
|
|
16
|
+
(0, plugin_kit_1.DbMetric)('counter', {
|
|
17
|
+
name: 'typeorm_query_cache_total',
|
|
18
|
+
help: 'Number of TypeORM query cache lookups',
|
|
19
|
+
description: 'Обращения к кешу запросов, result — hit или miss',
|
|
20
|
+
labelNames: ['result'],
|
|
21
|
+
})
|
|
22
|
+
], TypeOrmQueryCache);
|
|
23
|
+
//# sourceMappingURL=typeorm.metrics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"typeorm.metrics.js","sourceRoot":"","sources":["../../src/metrics/typeorm.metrics.ts"],"names":[],"mappings":";;;;;;;;;AAAA,qCAAqC;AACrC,iEAA4D;AAQrD,IAAM,iBAAiB,GAAvB,MAAM,iBAAkB,SAAQ,cAAiB;CAAG,CAAA;AAA9C,8CAAiB;4BAAjB,iBAAiB;IAN7B,IAAA,qBAAQ,EAAC,SAAS,EAAE;QACnB,IAAI,EAAE,2BAA2B;QACjC,IAAI,EAAE,uCAAuC;QAC7C,WAAW,EAAE,kDAAkD;QAC/D,UAAU,EAAE,CAAC,QAAQ,CAAC;KACvB,CAAC;GACW,iBAAiB,CAA6B"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { OnApplicationShutdown, OnModuleInit } from '@nestjs/common';
|
|
2
|
+
import type { DbClientMetrics, Detach, EntityOperationsRecorder } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
3
|
+
import { DbMetricsModuleBase } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
4
|
+
import { ILogger } from '@rsdk/logging';
|
|
5
|
+
import { DataSource } from 'typeorm';
|
|
6
|
+
import { TypeOrmQueryCache } from '../metrics/typeorm.metrics';
|
|
7
|
+
/**
|
|
8
|
+
* Подключает метрики БД к DataSource TypeORM: пулы `pg`, query cache и
|
|
9
|
+
* операции над сущностями. Выключатель `DB_METRICS_ENABLED`, внедрение
|
|
10
|
+
* метрик через DI (`DbClientMetrics` и `EntityOperationsRecorder` — по
|
|
11
|
+
* токенам из `plugin-kit`) и итог при остановке приложения описаны в
|
|
12
|
+
* {@link DbMetricsModuleBase}. Значение метки `pool` собирает ядро из
|
|
13
|
+
* `APP_NAME` и ресурса из {@link findPgPools}
|
|
14
|
+
*/
|
|
15
|
+
export declare class TypeOrmMetricsModule extends DbMetricsModuleBase implements OnModuleInit, OnApplicationShutdown {
|
|
16
|
+
private readonly dataSource;
|
|
17
|
+
private readonly queryCache;
|
|
18
|
+
private readonly logger;
|
|
19
|
+
/**
|
|
20
|
+
* @param queryCache `null`, только когда метрики выключены, а тогда
|
|
21
|
+
* `attach` не вызывается
|
|
22
|
+
*/
|
|
23
|
+
constructor(dataSource: DataSource, client: DbClientMetrics | null, entityOperations: EntityOperationsRecorder | null, queryCache: TypeOrmQueryCache | null, logger: ILogger);
|
|
24
|
+
protected attach(add: (detach?: Detach) => void, client: DbClientMetrics): void;
|
|
25
|
+
/**
|
|
26
|
+
* Master инструментируется первым. Если он не прошёл проверку (warning
|
|
27
|
+
* пишет `instrumentPool`), реплики не инструментируются: запись идёт
|
|
28
|
+
* через master, и без него метрики запросов и транзакций показывали бы
|
|
29
|
+
* только чтения с реплик.
|
|
30
|
+
*
|
|
31
|
+
* `instrumentQueries: true` у всех пулов: {@link findPgPools} отдаёт пулы
|
|
32
|
+
* только у postgres и cockroachdb, а их соединения — клиенты `pg`
|
|
33
|
+
*/
|
|
34
|
+
private instrumentPools;
|
|
35
|
+
private instrumentQueryCache;
|
|
36
|
+
}
|
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
var __param = (this && this.__param) || function (paramIndex, decorator) {
|
|
12
|
+
return function (target, key) { decorator(target, key, paramIndex); }
|
|
13
|
+
};
|
|
14
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
+
exports.TypeOrmMetricsModule = void 0;
|
|
16
|
+
const common_1 = require("@nestjs/common");
|
|
17
|
+
const core_1 = require("@rsdk/core");
|
|
18
|
+
const plugin_kit_1 = require("@rsdk/db/dist/metrics/plugin-kit");
|
|
19
|
+
const typeorm_1 = require("typeorm");
|
|
20
|
+
const entity_operations_subscriber_1 = require("../metrics/entity-operations.subscriber");
|
|
21
|
+
const pg_pools_1 = require("../metrics/pg-pools");
|
|
22
|
+
const query_cache_instrumentation_1 = require("../metrics/query-cache.instrumentation");
|
|
23
|
+
const subscribers_1 = require("../metrics/subscribers");
|
|
24
|
+
const typeorm_metrics_1 = require("../metrics/typeorm.metrics");
|
|
25
|
+
/**
|
|
26
|
+
* Подключает метрики БД к DataSource TypeORM: пулы `pg`, query cache и
|
|
27
|
+
* операции над сущностями. Выключатель `DB_METRICS_ENABLED`, внедрение
|
|
28
|
+
* метрик через DI (`DbClientMetrics` и `EntityOperationsRecorder` — по
|
|
29
|
+
* токенам из `plugin-kit`) и итог при остановке приложения описаны в
|
|
30
|
+
* {@link DbMetricsModuleBase}. Значение метки `pool` собирает ядро из
|
|
31
|
+
* `APP_NAME` и ресурса из {@link findPgPools}
|
|
32
|
+
*/
|
|
33
|
+
let TypeOrmMetricsModule = class TypeOrmMetricsModule extends plugin_kit_1.DbMetricsModuleBase {
|
|
34
|
+
dataSource;
|
|
35
|
+
queryCache;
|
|
36
|
+
logger;
|
|
37
|
+
/**
|
|
38
|
+
* @param queryCache `null`, только когда метрики выключены, а тогда
|
|
39
|
+
* `attach` не вызывается
|
|
40
|
+
*/
|
|
41
|
+
constructor(dataSource, client, entityOperations, queryCache, logger) {
|
|
42
|
+
super(client, entityOperations);
|
|
43
|
+
this.dataSource = dataSource;
|
|
44
|
+
this.queryCache = queryCache;
|
|
45
|
+
this.logger = logger;
|
|
46
|
+
}
|
|
47
|
+
attach(add, client) {
|
|
48
|
+
this.instrumentPools(add, client);
|
|
49
|
+
this.instrumentQueryCache(add);
|
|
50
|
+
if (this.entityOperations) {
|
|
51
|
+
add((0, subscribers_1.addSubscriber)(this.dataSource, new entity_operations_subscriber_1.EntityOperationsSubscriber(this.entityOperations)));
|
|
52
|
+
}
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
* Master инструментируется первым. Если он не прошёл проверку (warning
|
|
56
|
+
* пишет `instrumentPool`), реплики не инструментируются: запись идёт
|
|
57
|
+
* через master, и без него метрики запросов и транзакций показывали бы
|
|
58
|
+
* только чтения с реплик.
|
|
59
|
+
*
|
|
60
|
+
* `instrumentQueries: true` у всех пулов: {@link findPgPools} отдаёт пулы
|
|
61
|
+
* только у postgres и cockroachdb, а их соединения — клиенты `pg`
|
|
62
|
+
*/
|
|
63
|
+
instrumentPools(add, client) {
|
|
64
|
+
const [master, ...replicas] = (0, pg_pools_1.findPgPools)(this.dataSource);
|
|
65
|
+
if (!master) {
|
|
66
|
+
this.logger.info(`Pool and query metrics are not supported for ${this.dataSource.options.type}`);
|
|
67
|
+
return;
|
|
68
|
+
}
|
|
69
|
+
const detachMaster = client.instrumentPool('pg', master.pool, master.resource, this.logger, { instrumentQueries: true });
|
|
70
|
+
if (!detachMaster) {
|
|
71
|
+
return;
|
|
72
|
+
}
|
|
73
|
+
add(detachMaster);
|
|
74
|
+
for (const { resource, pool } of replicas) {
|
|
75
|
+
add(client.instrumentPool('pg', pool, resource, this.logger, {
|
|
76
|
+
instrumentQueries: true,
|
|
77
|
+
}));
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
instrumentQueryCache(add) {
|
|
81
|
+
const cache = this.dataSource.queryResultCache;
|
|
82
|
+
if (!cache || !this.queryCache) {
|
|
83
|
+
return;
|
|
84
|
+
}
|
|
85
|
+
add(new query_cache_instrumentation_1.QueryCacheInstrumentation(this.queryCache).instrument(cache));
|
|
86
|
+
}
|
|
87
|
+
};
|
|
88
|
+
exports.TypeOrmMetricsModule = TypeOrmMetricsModule;
|
|
89
|
+
exports.TypeOrmMetricsModule = TypeOrmMetricsModule = __decorate([
|
|
90
|
+
(0, common_1.Module)({
|
|
91
|
+
providers: (0, plugin_kit_1.dbMetricsModuleProviders)([typeorm_metrics_1.TypeOrmQueryCache]),
|
|
92
|
+
}),
|
|
93
|
+
__param(1, (0, common_1.Inject)(plugin_kit_1.DB_CLIENT_METRICS_TOKEN)),
|
|
94
|
+
__param(2, (0, common_1.Inject)(plugin_kit_1.ENTITY_OPERATIONS_RECORDER_TOKEN)),
|
|
95
|
+
__param(3, (0, common_1.Inject)(typeorm_metrics_1.TypeOrmQueryCache)),
|
|
96
|
+
__param(4, (0, core_1.InjectLogger)(TypeOrmMetricsModule)),
|
|
97
|
+
__metadata("design:paramtypes", [typeorm_1.DataSource, Object, Object, Object, Object])
|
|
98
|
+
], TypeOrmMetricsModule);
|
|
99
|
+
//# sourceMappingURL=metrics.module.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"metrics.module.js","sourceRoot":"","sources":["../../src/modules/metrics.module.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AACA,2CAAgD;AAChD,qCAA0C;AAM1C,iEAK0C;AAE1C,qCAAqC;AAErC,0FAAqF;AACrF,kDAAkD;AAClD,wFAAmF;AACnF,wDAAuD;AACvD,gEAA+D;AAE/D;;;;;;;GAOG;AAII,IAAM,oBAAoB,GAA1B,MAAM,oBACX,SAAQ,gCAAmB;IAQR;IAKA;IACoC;IAXvD;;;OAGG;IACH,YACmB,UAAsB,EACN,MAA8B,EAE/D,gBAAiD,EAEhC,UAAoC,EACA,MAAe;QAEpE,KAAK,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC;QARf,eAAU,GAAV,UAAU,CAAY;QAKtB,eAAU,GAAV,UAAU,CAA0B;QACA,WAAM,GAAN,MAAM,CAAS;IAGtE,CAAC;IAES,MAAM,CACd,GAA8B,EAC9B,MAAuB;QAEvB,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QAClC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAC;QAE/B,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC1B,GAAG,CACD,IAAA,2BAAa,EACX,IAAI,CAAC,UAAU,EACf,IAAI,yDAA0B,CAAC,IAAI,CAAC,gBAAgB,CAAC,CACtD,CACF,CAAC;QACJ,CAAC;IACH,CAAC;IAED;;;;;;;;OAQG;IACK,eAAe,CACrB,GAA8B,EAC9B,MAAuB;QAEvB,MAAM,CAAC,MAAM,EAAE,GAAG,QAAQ,CAAC,GAAG,IAAA,sBAAW,EAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3D,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,IAAI,CAAC,MAAM,CAAC,IAAI,CACd,gDAAgD,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,CAC/E,CAAC;YACF,OAAO;QACT,CAAC;QAED,MAAM,YAAY,GAAG,MAAM,CAAC,cAAc,CACxC,IAAI,EACJ,MAAM,CAAC,IAAI,EACX,MAAM,CAAC,QAAQ,EACf,IAAI,CAAC,MAAM,EACX,EAAE,iBAAiB,EAAE,IAAI,EAAE,CAC5B,CAAC;QACF,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAO;QACT,CAAC;QAED,GAAG,CAAC,YAAY,CAAC,CAAC;QAClB,KAAK,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,QAAQ,EAAE,CAAC;YAC1C,GAAG,CACD,MAAM,CAAC,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,MAAM,EAAE;gBACvD,iBAAiB,EAAE,IAAI;aACxB,CAAC,CACH,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,oBAAoB,CAAC,GAA8B;QACzD,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC;QAC/C,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YAC/B,OAAO;QACT,CAAC;QAED,GAAG,CAAC,IAAI,uDAAyB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IACxE,CAAC;CACF,CAAA;AAvFY,oDAAoB;+BAApB,oBAAoB;IAHhC,IAAA,eAAM,EAAC;QACN,SAAS,EAAE,IAAA,qCAAwB,EAAC,CAAC,mCAAiB,CAAC,CAAC;KACzD,CAAC;IAWG,WAAA,IAAA,eAAM,EAAC,oCAAuB,CAAC,CAAA;IAC/B,WAAA,IAAA,eAAM,EAAC,6CAAgC,CAAC,CAAA;IAExC,WAAA,IAAA,eAAM,EAAC,mCAAiB,CAAC,CAAA;IAEzB,WAAA,IAAA,mBAAY,EAAC,oBAAoB,CAAC,CAAA;qCANN,oBAAU;GAT9B,oBAAoB,CAuFhC"}
|
package/dist/typeorm.plugin.js
CHANGED
|
@@ -11,6 +11,7 @@ const logging_1 = require("@rsdk/logging");
|
|
|
11
11
|
const node_path_1 = __importDefault(require("node:path"));
|
|
12
12
|
const exceptions_1 = require("./internal/exceptions");
|
|
13
13
|
const initializer_1 = require("./internal/initializer");
|
|
14
|
+
const metrics_module_1 = require("./modules/metrics.module");
|
|
14
15
|
const migration_checker_module_1 = require("./modules/migration-checker.module");
|
|
15
16
|
const typeorm_override_entities_data_source_factory_1 = require("./providers/typeorm-override-entities.data-source-factory");
|
|
16
17
|
const providers_1 = require("./providers");
|
|
@@ -138,6 +139,7 @@ class TypeOrmPlugin {
|
|
|
138
139
|
},
|
|
139
140
|
}),
|
|
140
141
|
migration_checker_module_1.MigrationCheckerModule,
|
|
142
|
+
metrics_module_1.TypeOrmMetricsModule,
|
|
141
143
|
];
|
|
142
144
|
}
|
|
143
145
|
errorTransformers() {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"typeorm.plugin.js","sourceRoot":"","sources":["../src/typeorm.plugin.ts"],"names":[],"mappings":";;;;;;AAEA,6CAAgD;AAOhD,qCAAsC;AACtC,iCAKkB;AAClB,2CAA8C;AAC9C,0DAA6B;AAG7B,sDAAgE;AAChE,wDAAqD;AACrD,iFAA4E;AAC5E,6HAAqH;AACrH,2CAIqB;AACrB,6EAAuE;AAGvE,MAAa,aAAa;IAMK;IALrB,MAAM,CAAU,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAErE;;OAEG;IACH,YAA6B,OAA6B;QAA7B,YAAO,GAAP,OAAO,CAAsB;QACxD,yBAAW,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC;IACjC,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO;QACL,MAAM,UAAU,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC9C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACpD,CAAC;QAED,OAAO;YACL,uBAAa,CAAC,YAAY,CAAC;gBACzB,OAAO,EAAE;oBACP;wBACE,MAAM,EAAE,uBAAa;wBACrB,SAAS,EAAE,CAAC,kCAAsB,EAAE,gCAAoB,CAAC;wBACzD,OAAO,EAAE,CAAC,gCAAoB,CAAC;qBAChC;iBACF;gBACD,MAAM,EAAE,CAAC,+BAAmB,EAAE,gCAAoB,EAAE,eAAQ,CAAC;gBAC7D,UAAU,EAAE,KAAK,EACf,MAA2B,EAC3B,MAA4B,EAC5B,OAAe,EACgB,EAAE;oBACjC,MAAM,GAAG,GAAG,IAAA,4BAAuB,EAAC,MAAM,CAAC,CAAC;oBAE5C;;;;uBAIG;oBACH,MAAM,gBAAgB,GACpB,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU;wBAChC,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,iBAAiB,CAAC;oBAE1C;;;;uBAIG;oBACH,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAmB,EAAC;wBACzC,GAAG,EAAE,MAAM,CAAC,GAAG;wBACf,MAAM,EAAE,aAAa,CAAC,MAAM;wBAC5B,gBAAgB;wBAChB,GAAG,CAAC,MAAM,CAAC,0BAA0B,IAAI;4BACvC,cAAc,EAAE,CAAC,SAAc,EAAiB,EAAE,CAChD,IAAA,YAAO,EAAC,SAAS,EAAE,GAAG,CAAC;yBAC1B,CAAC;qBACH,CAAC,CAAC;oBAEH,IAAI,YAAqB,CAAC;oBAC1B,IAAI,UAAmC,CAAC;oBACxC,IAAI,eAAwC,CAAC;oBAE7C,IAAI,QAAQ,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;wBACrC,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC;wBAC/B,UAAU,GAAG;4BACX,IAAI,EAAE,QAAQ,CAAC,cAAc,CAAC,IAAI;4BAClC,IAAI,EAAE,QAAQ,CAAC,cAAc,CAAC,IAAI;4BAClC,GAAG,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;4BACzD,GAAG,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;4BACzD,GAAG,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;yBAC1D,CAAC;wBACF,eAAe,GAAG;4BAChB,sBAAsB,EAAE,QAAQ,CAAC,YAAY;yBAC9C,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,UAAU,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC;wBAC9C,eAAe,GAAG,EAAE,CAAC;oBACvB,CAAC;oBAED,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,EAAE,CAGtD,CAAC;oBAEF;;;;;uBAKG;oBACH,IAAI,cAAc,GAA4B,EAAE,CAAC;oBACjD,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;wBACtC,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;4BAC/B,cAAc,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;wBAC5C,CAAC;6BAAM,IAAI,gBAAgB,EAAE,CAAC;4BAC5B,cAAc,GAAG,EAAE,MAAM,EAAE,IAAA,mBAAc,GAAE,EAAE,CAAC;wBAChD,CAAC;oBACH,CAAC;oBAED,OAAO;wBACL,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;wBACvB,GAAG,UAAU;wBACb,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI;4BACnB,MAAM,EAAE,MAAM,CAAC,MAAM;yBACtB,CAAC;wBACF,MAAM;wBACN,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACjD,gBAAgB,EAAE,CAAC,IAAI,CAAC,QAAQ;wBAChC,UAAU,EAAE,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE;wBAC7C,aAAa,EAAE,MAAM,CAAC,iBAAiB;wBACvC,eAAe,EAAE,OAAO,GAAG,UAAU;wBACrC,KAAK,EAAE;4BACL,GAAG,EAAE,MAAM,CAAC,OAAO;4BACnB,GAAG,EAAE,MAAM,CAAC,OAAO;4BACnB,SAAS,EAAE,MAAM,CAAC,SAAS;4BAC3B,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;4BACnD,GAAG;4BACH,GAAG,eAAe;yBACnB;wBACD,UAAU;wBACV,mBAAmB,EAAE,oBAAoB;wBACzC,GAAI,YAAoB;wBACxB,GAAG,cAAc;qBAClB,CAAC;gBACJ,CAAC;gBACD,iBAAiB,EAAE,CAAC,OAA2B,EAAE,EAAE;oBACjD,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,MAAM,IAAI,oCAAuB,EAAE,CAAC;oBACtC,CAAC;oBACD,OAAO,wFAAwC,CAAC,MAAM,CACpD,OAAO,CACR,CAAC,UAAU,EAAE,CAAC;gBACjB,CAAC;aACF,CAAC;YACF,iDAAsB;
|
|
1
|
+
{"version":3,"file":"typeorm.plugin.js","sourceRoot":"","sources":["../src/typeorm.plugin.ts"],"names":[],"mappings":";;;;;;AAEA,6CAAgD;AAOhD,qCAAsC;AACtC,iCAKkB;AAClB,2CAA8C;AAC9C,0DAA6B;AAG7B,sDAAgE;AAChE,wDAAqD;AACrD,6DAAgE;AAChE,iFAA4E;AAC5E,6HAAqH;AACrH,2CAIqB;AACrB,6EAAuE;AAGvE,MAAa,aAAa;IAMK;IALrB,MAAM,CAAU,MAAM,GAAG,uBAAa,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;IAErE;;OAEG;IACH,YAA6B,OAA6B;QAA7B,YAAO,GAAP,OAAO,CAAsB;QACxD,yBAAW,CAAC,UAAU,EAAE,CAAC;IAC3B,CAAC;IAED,IAAI,QAAQ;QACV,OAAO,IAAI,EAAE,OAAO,EAAE,QAAQ,CAAC;IACjC,CAAC;IAED,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO;QACL,MAAM,UAAU,GAAG,IAAI,CAAC,mBAAmB,EAAE,CAAC;QAC9C,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACpD,CAAC;QAED,OAAO;YACL,uBAAa,CAAC,YAAY,CAAC;gBACzB,OAAO,EAAE;oBACP;wBACE,MAAM,EAAE,uBAAa;wBACrB,SAAS,EAAE,CAAC,kCAAsB,EAAE,gCAAoB,CAAC;wBACzD,OAAO,EAAE,CAAC,gCAAoB,CAAC;qBAChC;iBACF;gBACD,MAAM,EAAE,CAAC,+BAAmB,EAAE,gCAAoB,EAAE,eAAQ,CAAC;gBAC7D,UAAU,EAAE,KAAK,EACf,MAA2B,EAC3B,MAA4B,EAC5B,OAAe,EACgB,EAAE;oBACjC,MAAM,GAAG,GAAG,IAAA,4BAAuB,EAAC,MAAM,CAAC,CAAC;oBAE5C;;;;uBAIG;oBACH,MAAM,gBAAgB,GACpB,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU;wBAChC,IAAI,CAAC,OAAO,CAAC,IAAI,KAAK,iBAAiB,CAAC;oBAE1C;;;;uBAIG;oBACH,MAAM,QAAQ,GAAG,MAAM,IAAA,wBAAmB,EAAC;wBACzC,GAAG,EAAE,MAAM,CAAC,GAAG;wBACf,MAAM,EAAE,aAAa,CAAC,MAAM;wBAC5B,gBAAgB;wBAChB,GAAG,CAAC,MAAM,CAAC,0BAA0B,IAAI;4BACvC,cAAc,EAAE,CAAC,SAAc,EAAiB,EAAE,CAChD,IAAA,YAAO,EAAC,SAAS,EAAE,GAAG,CAAC;yBAC1B,CAAC;qBACH,CAAC,CAAC;oBAEH,IAAI,YAAqB,CAAC;oBAC1B,IAAI,UAAmC,CAAC;oBACxC,IAAI,eAAwC,CAAC;oBAE7C,IAAI,QAAQ,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;wBACrC,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC;wBAC/B,UAAU,GAAG;4BACX,IAAI,EAAE,QAAQ,CAAC,cAAc,CAAC,IAAI;4BAClC,IAAI,EAAE,QAAQ,CAAC,cAAc,CAAC,IAAI;4BAClC,GAAG,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;4BACzD,GAAG,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;4BACzD,GAAG,CAAC,QAAQ,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,QAAQ,EAAE,CAAC;yBAC1D,CAAC;wBACF,eAAe,GAAG;4BAChB,sBAAsB,EAAE,QAAQ,CAAC,YAAY;yBAC9C,CAAC;oBACJ,CAAC;yBAAM,CAAC;wBACN,UAAU,GAAG,EAAE,GAAG,EAAE,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,CAAC;wBAC9C,eAAe,GAAG,EAAE,CAAC;oBACvB,CAAC;oBAED,MAAM,YAAY,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,IAAI,EAAE,CAGtD,CAAC;oBAEF;;;;;uBAKG;oBACH,IAAI,cAAc,GAA4B,EAAE,CAAC;oBACjD,IAAI,YAAY,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;wBACtC,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;4BAC/B,cAAc,GAAG,EAAE,MAAM,EAAE,YAAY,EAAE,CAAC;wBAC5C,CAAC;6BAAM,IAAI,gBAAgB,EAAE,CAAC;4BAC5B,cAAc,GAAG,EAAE,MAAM,EAAE,IAAA,mBAAc,GAAE,EAAE,CAAC;wBAChD,CAAC;oBACH,CAAC;oBAED,OAAO;wBACL,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI;wBACvB,GAAG,UAAU;wBACb,GAAG,CAAC,MAAM,CAAC,MAAM,IAAI;4BACnB,MAAM,EAAE,MAAM,CAAC,MAAM;yBACtB,CAAC;wBACF,MAAM;wBACN,GAAG,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC;wBACjD,gBAAgB,EAAE,CAAC,IAAI,CAAC,QAAQ;wBAChC,UAAU,EAAE,MAAM,CAAC,iBAAiB,CAAC,MAAM,EAAE;wBAC7C,aAAa,EAAE,MAAM,CAAC,iBAAiB;wBACvC,eAAe,EAAE,OAAO,GAAG,UAAU;wBACrC,KAAK,EAAE;4BACL,GAAG,EAAE,MAAM,CAAC,OAAO;4BACnB,GAAG,EAAE,MAAM,CAAC,OAAO;4BACnB,SAAS,EAAE,MAAM,CAAC,SAAS;4BAC3B,qBAAqB,EAAE,MAAM,CAAC,qBAAqB;4BACnD,GAAG;4BACH,GAAG,eAAe;yBACnB;wBACD,UAAU;wBACV,mBAAmB,EAAE,oBAAoB;wBACzC,GAAI,YAAoB;wBACxB,GAAG,cAAc;qBAClB,CAAC;gBACJ,CAAC;gBACD,iBAAiB,EAAE,CAAC,OAA2B,EAAE,EAAE;oBACjD,IAAI,CAAC,OAAO,EAAE,CAAC;wBACb,MAAM,IAAI,oCAAuB,EAAE,CAAC;oBACtC,CAAC;oBACD,OAAO,wFAAwC,CAAC,MAAM,CACpD,OAAO,CACR,CAAC,UAAU,EAAE,CAAC;gBACjB,CAAC;aACF,CAAC;YACF,iDAAsB;YACtB,qCAAoB;SACrB,CAAC;IACJ,CAAC;IAED,iBAAiB;QACf,OAAO,CAAC,IAAI,oDAAuB,EAAE,CAAC,CAAC;IACzC,CAAC;IAEO,mBAAmB;QACzB,OAAO,CAAC,mBAAI,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,+BAA+B,CAAC,CAAC,CAAC;IACxE,CAAC;;AAxJH,sCAyJC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rsdk/db.typeorm",
|
|
3
|
-
"version": "5.15.0
|
|
3
|
+
"version": "5.15.0",
|
|
4
4
|
"description": "TypeOrm module for platform",
|
|
5
5
|
"license": "Apache License 2.0",
|
|
6
6
|
"publishConfig": {
|
|
@@ -28,5 +28,5 @@
|
|
|
28
28
|
"rxjs": "^7.1.0",
|
|
29
29
|
"typeorm": "^0.3.12"
|
|
30
30
|
},
|
|
31
|
-
"gitHead": "
|
|
31
|
+
"gitHead": "1b5584a7b75980e56ac9a2e0a92996aab80510fd"
|
|
32
32
|
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import type { EntityOperationsRecorder } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
2
|
+
import type {
|
|
3
|
+
InsertEvent,
|
|
4
|
+
LoadEvent,
|
|
5
|
+
RemoveEvent,
|
|
6
|
+
SoftRemoveEvent,
|
|
7
|
+
UpdateEvent,
|
|
8
|
+
} from 'typeorm';
|
|
9
|
+
|
|
10
|
+
import { EntityOperationsSubscriber } from './entity-operations.subscriber';
|
|
11
|
+
|
|
12
|
+
describe('EntityOperationsSubscriber', () => {
|
|
13
|
+
const record = jest.fn();
|
|
14
|
+
const subscriber = new EntityOperationsSubscriber({
|
|
15
|
+
record,
|
|
16
|
+
} as unknown as EntityOperationsRecorder);
|
|
17
|
+
const event = { metadata: { name: 'Cat' } };
|
|
18
|
+
|
|
19
|
+
beforeEach(() => record.mockClear());
|
|
20
|
+
|
|
21
|
+
it('maps TypeORM events to operations', () => {
|
|
22
|
+
subscriber.afterLoad({}, event as LoadEvent<object>);
|
|
23
|
+
subscriber.afterInsert(event as InsertEvent<object>);
|
|
24
|
+
subscriber.afterUpdate(event as UpdateEvent<object>);
|
|
25
|
+
subscriber.afterRemove(event as RemoveEvent<object>);
|
|
26
|
+
subscriber.afterSoftRemove(event as SoftRemoveEvent<object>);
|
|
27
|
+
|
|
28
|
+
expect(record.mock.calls).toEqual([
|
|
29
|
+
['Cat', 'load'],
|
|
30
|
+
['Cat', 'insert'],
|
|
31
|
+
['Cat', 'update'],
|
|
32
|
+
['Cat', 'delete'],
|
|
33
|
+
['Cat', 'delete'],
|
|
34
|
+
]);
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
it('takes the entity class name when there is no event', () => {
|
|
38
|
+
class Dog {}
|
|
39
|
+
|
|
40
|
+
subscriber.afterLoad(new Dog());
|
|
41
|
+
|
|
42
|
+
expect(record).toHaveBeenCalledWith('Dog', 'load');
|
|
43
|
+
});
|
|
44
|
+
});
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import type { EntityOperationsRecorder } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
2
|
+
import type {
|
|
3
|
+
EntitySubscriberInterface,
|
|
4
|
+
InsertEvent,
|
|
5
|
+
LoadEvent,
|
|
6
|
+
RemoveEvent,
|
|
7
|
+
SoftRemoveEvent,
|
|
8
|
+
UpdateEvent,
|
|
9
|
+
} from 'typeorm';
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Пишет `orm_entity_operations_total` по событиям, которые TypeORM
|
|
13
|
+
* рассылает subscriber-ам: от EntityManager, репозиториев и QueryBuilder,
|
|
14
|
+
* если у него не выключено `callListeners(false)`. Загрузки, insert, save
|
|
15
|
+
* и remove считаются по сущностям, update и delete по условию — один раз
|
|
16
|
+
* на запрос, сколько бы строк ни изменилось
|
|
17
|
+
*/
|
|
18
|
+
export class EntityOperationsSubscriber implements EntitySubscriberInterface {
|
|
19
|
+
constructor(private readonly recorder: EntityOperationsRecorder) {}
|
|
20
|
+
|
|
21
|
+
afterLoad(entity: object, event?: LoadEvent<object>): void {
|
|
22
|
+
this.recorder.record(
|
|
23
|
+
event?.metadata.name ?? entity.constructor.name,
|
|
24
|
+
'load',
|
|
25
|
+
);
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
afterInsert(event: InsertEvent<object>): void {
|
|
29
|
+
this.recorder.record(event.metadata.name, 'insert');
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
afterUpdate(event: UpdateEvent<object>): void {
|
|
33
|
+
this.recorder.record(event.metadata.name, 'update');
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
afterRemove(event: RemoveEvent<object>): void {
|
|
37
|
+
this.recorder.record(event.metadata.name, 'delete');
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
afterSoftRemove(event: SoftRemoveEvent<object>): void {
|
|
41
|
+
this.recorder.record(event.metadata.name, 'delete');
|
|
42
|
+
}
|
|
43
|
+
}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import type { DataSource } from 'typeorm';
|
|
2
|
+
|
|
3
|
+
import { findPgPools } from './pg-pools';
|
|
4
|
+
|
|
5
|
+
const dataSource = (driver: object, type = 'postgres'): DataSource =>
|
|
6
|
+
({ driver, options: { type } }) as unknown as DataSource;
|
|
7
|
+
|
|
8
|
+
describe('findPgPools', () => {
|
|
9
|
+
it('returns the master first and names the resource of each replica by its index', () => {
|
|
10
|
+
const master = {};
|
|
11
|
+
const slave = {};
|
|
12
|
+
|
|
13
|
+
expect(findPgPools(dataSource({ master, slaves: [slave] }))).toEqual([
|
|
14
|
+
{ resource: 'typeorm', pool: master },
|
|
15
|
+
{ resource: 'typeorm:slave0', pool: slave },
|
|
16
|
+
]);
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
it('finds the pool of the cockroachdb driver', () => {
|
|
20
|
+
const master = {};
|
|
21
|
+
|
|
22
|
+
expect(findPgPools(dataSource({ master }, 'cockroachdb'))).toEqual([
|
|
23
|
+
{ resource: 'typeorm', pool: master },
|
|
24
|
+
]);
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
it('returns the master entry even without a pool so that the check reports it', () => {
|
|
28
|
+
expect(findPgPools(dataSource({}))).toEqual([
|
|
29
|
+
{ resource: 'typeorm', pool: undefined },
|
|
30
|
+
]);
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
it.each([
|
|
34
|
+
['an object', {}],
|
|
35
|
+
['a string', 'x'],
|
|
36
|
+
['null', null],
|
|
37
|
+
])('returns only the master when slaves is %s', (_title, slaves) => {
|
|
38
|
+
const master = {};
|
|
39
|
+
const source = dataSource({ master, slaves });
|
|
40
|
+
|
|
41
|
+
expect(() => findPgPools(source)).not.toThrow();
|
|
42
|
+
expect(findPgPools(source)).toEqual([
|
|
43
|
+
{ resource: 'typeorm', pool: master },
|
|
44
|
+
]);
|
|
45
|
+
});
|
|
46
|
+
|
|
47
|
+
it.each(['mysql', 'sqlite', 'mssql'])(
|
|
48
|
+
'returns an empty list for the %s driver',
|
|
49
|
+
(type) => {
|
|
50
|
+
expect(findPgPools(dataSource({ master: {} }, type))).toEqual([]);
|
|
51
|
+
},
|
|
52
|
+
);
|
|
53
|
+
});
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import type { DataSource } from 'typeorm';
|
|
2
|
+
|
|
3
|
+
export interface PgPoolResource {
|
|
4
|
+
resource: string;
|
|
5
|
+
pool: unknown;
|
|
6
|
+
}
|
|
7
|
+
|
|
8
|
+
const RESOURCE = 'typeorm';
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Драйверы TypeORM, которые создают пул через `pg.Pool`
|
|
12
|
+
*/
|
|
13
|
+
const PG_DRIVERS: ReadonlySet<string> = new Set(['postgres', 'cockroachdb']);
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Пулы `pg` у драйверов postgres и cockroachdb: master первым, за ним
|
|
17
|
+
* реплики (если `driver.slaves` — массив). Для остальных драйверов список
|
|
18
|
+
* пуст.
|
|
19
|
+
*
|
|
20
|
+
* Здесь пулы только находятся: что это действительно пул `pg`, проверяет
|
|
21
|
+
* `DbClientMetrics.instrumentPool`.
|
|
22
|
+
*
|
|
23
|
+
* `resource` — вторая часть значения метки `pool`: `typeorm` у master,
|
|
24
|
+
* `typeorm:slave<index>` у реплик. Имя приложения из `APP_NAME` к нему
|
|
25
|
+
* добавляет `DbClientMetrics`
|
|
26
|
+
*/
|
|
27
|
+
export const findPgPools = (dataSource: DataSource): PgPoolResource[] => {
|
|
28
|
+
if (!PG_DRIVERS.has(dataSource.options.type)) {
|
|
29
|
+
return [];
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
// Поля драйвера внутренние, их форма не гарантирована: `master` проверяет
|
|
33
|
+
// `instrumentPool`, а если `slaves` не массив, реплик нет
|
|
34
|
+
const { master, slaves } = dataSource.driver as {
|
|
35
|
+
master?: unknown;
|
|
36
|
+
slaves?: unknown;
|
|
37
|
+
};
|
|
38
|
+
const replicas: unknown[] = Array.isArray(slaves) ? slaves : [];
|
|
39
|
+
|
|
40
|
+
return [
|
|
41
|
+
{ resource: RESOURCE, pool: master },
|
|
42
|
+
...replicas.map((pool, index) => ({
|
|
43
|
+
resource: `${RESOURCE}:slave${index}`,
|
|
44
|
+
pool,
|
|
45
|
+
})),
|
|
46
|
+
];
|
|
47
|
+
};
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import type { QueryResultCache } from 'typeorm/cache/QueryResultCache';
|
|
2
|
+
import type { QueryResultCacheOptions } from 'typeorm/cache/QueryResultCacheOptions';
|
|
3
|
+
|
|
4
|
+
import { QueryCacheInstrumentation } from './query-cache.instrumentation';
|
|
5
|
+
|
|
6
|
+
const entry = (expired: boolean): QueryResultCacheOptions => ({
|
|
7
|
+
identifier: expired ? 'expired' : 'fresh',
|
|
8
|
+
time: 0,
|
|
9
|
+
duration: 0,
|
|
10
|
+
result: '[]',
|
|
11
|
+
});
|
|
12
|
+
|
|
13
|
+
const createCache = (
|
|
14
|
+
saved?: QueryResultCacheOptions | null,
|
|
15
|
+
): QueryResultCache =>
|
|
16
|
+
({
|
|
17
|
+
getFromCache: async () => saved,
|
|
18
|
+
isExpired: (x: QueryResultCacheOptions) => x.identifier === 'expired',
|
|
19
|
+
}) as unknown as QueryResultCache;
|
|
20
|
+
|
|
21
|
+
describe('QueryCacheInstrumentation', () => {
|
|
22
|
+
const inc = jest.fn();
|
|
23
|
+
const instrumentation = new QueryCacheInstrumentation({ inc });
|
|
24
|
+
|
|
25
|
+
beforeEach(() => inc.mockClear());
|
|
26
|
+
|
|
27
|
+
it.each([
|
|
28
|
+
['fresh entry — hit', entry(false), 'hit'],
|
|
29
|
+
['expired entry — miss', entry(true), 'miss'],
|
|
30
|
+
['no entry — miss', undefined, 'miss'],
|
|
31
|
+
['no entry in redis (null) — miss', null, 'miss'],
|
|
32
|
+
])('%s', async (_, saved, result) => {
|
|
33
|
+
const cache = createCache(saved);
|
|
34
|
+
|
|
35
|
+
instrumentation.instrument(cache);
|
|
36
|
+
|
|
37
|
+
await expect(
|
|
38
|
+
cache.getFromCache({ query: 'SELECT 1', duration: 1000 }),
|
|
39
|
+
).resolves.toBe(saved);
|
|
40
|
+
expect(inc).toHaveBeenCalledWith({ result });
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
it('restores the original method on detach', async () => {
|
|
44
|
+
const cache = createCache();
|
|
45
|
+
const original = cache.getFromCache;
|
|
46
|
+
|
|
47
|
+
instrumentation.instrument(cache)();
|
|
48
|
+
|
|
49
|
+
expect(cache.getFromCache).toBe(original);
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
it('does not overwrite a later replacement on a second detach', () => {
|
|
53
|
+
const cache = createCache();
|
|
54
|
+
const later = createCache().getFromCache;
|
|
55
|
+
|
|
56
|
+
const detach = instrumentation.instrument(cache);
|
|
57
|
+
|
|
58
|
+
detach();
|
|
59
|
+
cache.getFromCache = later;
|
|
60
|
+
detach();
|
|
61
|
+
|
|
62
|
+
expect(cache.getFromCache).toBe(later);
|
|
63
|
+
});
|
|
64
|
+
});
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import type { CounterLike, Detach } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
2
|
+
import { replaceMethod } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
3
|
+
import type { QueryRunner } from 'typeorm';
|
|
4
|
+
import type { QueryResultCache } from 'typeorm/cache/QueryResultCache';
|
|
5
|
+
import type { QueryResultCacheOptions } from 'typeorm/cache/QueryResultCacheOptions';
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Считает попадания в кеш запросов. Повторяет проверку из
|
|
9
|
+
* `SelectQueryBuilder.loadRawResults`: попадание — это запись в кеше,
|
|
10
|
+
* которая ещё не устарела
|
|
11
|
+
*/
|
|
12
|
+
export class QueryCacheInstrumentation {
|
|
13
|
+
constructor(private readonly counter: CounterLike<'result'>) {}
|
|
14
|
+
|
|
15
|
+
instrument(cache: QueryResultCache): Detach {
|
|
16
|
+
const originalGetFromCache = cache.getFromCache;
|
|
17
|
+
const counter = this.counter;
|
|
18
|
+
|
|
19
|
+
return replaceMethod(
|
|
20
|
+
cache,
|
|
21
|
+
'getFromCache',
|
|
22
|
+
async function (
|
|
23
|
+
this: QueryResultCache,
|
|
24
|
+
options: QueryResultCacheOptions,
|
|
25
|
+
queryRunner?: QueryRunner,
|
|
26
|
+
): Promise<QueryResultCacheOptions | undefined> {
|
|
27
|
+
const saved = await originalGetFromCache.call(
|
|
28
|
+
this,
|
|
29
|
+
options,
|
|
30
|
+
queryRunner,
|
|
31
|
+
);
|
|
32
|
+
|
|
33
|
+
// HACK: Redis-кеш при промахе отдаёт `null`, хотя в типах только
|
|
34
|
+
// `undefined`, поэтому проверка на truthy, как в TypeORM
|
|
35
|
+
const hit = !!saved && !this.isExpired(saved);
|
|
36
|
+
|
|
37
|
+
counter.inc({ result: hit ? 'hit' : 'miss' });
|
|
38
|
+
|
|
39
|
+
return saved;
|
|
40
|
+
},
|
|
41
|
+
);
|
|
42
|
+
}
|
|
43
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import type { DataSource, EntitySubscriberInterface } from 'typeorm';
|
|
2
|
+
|
|
3
|
+
import { addSubscriber } from './subscribers';
|
|
4
|
+
|
|
5
|
+
const dataSource = (): DataSource & {
|
|
6
|
+
subscribers: EntitySubscriberInterface[];
|
|
7
|
+
} =>
|
|
8
|
+
({ subscribers: [] }) as unknown as DataSource & {
|
|
9
|
+
subscribers: EntitySubscriberInterface[];
|
|
10
|
+
};
|
|
11
|
+
|
|
12
|
+
describe('addSubscriber', () => {
|
|
13
|
+
it('adds the subscriber and removes it on detach', () => {
|
|
14
|
+
const source = dataSource();
|
|
15
|
+
const subscriber: EntitySubscriberInterface = {};
|
|
16
|
+
|
|
17
|
+
const detach = addSubscriber(source, subscriber);
|
|
18
|
+
|
|
19
|
+
expect(source.subscribers).toEqual([subscriber]);
|
|
20
|
+
|
|
21
|
+
detach();
|
|
22
|
+
|
|
23
|
+
expect(source.subscribers).toEqual([]);
|
|
24
|
+
});
|
|
25
|
+
|
|
26
|
+
it('does nothing on a second detach even if the same subscriber was added again', () => {
|
|
27
|
+
const source = dataSource();
|
|
28
|
+
const subscriber: EntitySubscriberInterface = {};
|
|
29
|
+
|
|
30
|
+
const detach = addSubscriber(source, subscriber);
|
|
31
|
+
|
|
32
|
+
detach();
|
|
33
|
+
source.subscribers.push(subscriber);
|
|
34
|
+
detach();
|
|
35
|
+
|
|
36
|
+
expect(source.subscribers).toEqual([subscriber]);
|
|
37
|
+
});
|
|
38
|
+
});
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { Detach } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
2
|
+
import { once } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
3
|
+
import type { DataSource, EntitySubscriberInterface } from 'typeorm';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Добавляет subscriber в уже инициализированный DataSource. Detach убирает
|
|
7
|
+
* его из `dataSource.subscribers`; повторный вызов ничего не делает
|
|
8
|
+
*/
|
|
9
|
+
export const addSubscriber = (
|
|
10
|
+
dataSource: DataSource,
|
|
11
|
+
subscriber: EntitySubscriberInterface,
|
|
12
|
+
): Detach => {
|
|
13
|
+
const subscribers = dataSource.subscribers as EntitySubscriberInterface[];
|
|
14
|
+
|
|
15
|
+
subscribers.push(subscriber);
|
|
16
|
+
|
|
17
|
+
return once(() => {
|
|
18
|
+
const index = subscribers.indexOf(subscriber);
|
|
19
|
+
if (index !== -1) {
|
|
20
|
+
subscribers.splice(index, 1);
|
|
21
|
+
}
|
|
22
|
+
});
|
|
23
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import { Counter } from '@rsdk/core';
|
|
2
|
+
import { DbMetric } from '@rsdk/db/dist/metrics/plugin-kit';
|
|
3
|
+
|
|
4
|
+
@DbMetric('counter', {
|
|
5
|
+
name: 'typeorm_query_cache_total',
|
|
6
|
+
help: 'Number of TypeORM query cache lookups',
|
|
7
|
+
description: 'Обращения к кешу запросов, result — hit или miss',
|
|
8
|
+
labelNames: ['result'],
|
|
9
|
+
})
|
|
10
|
+
export class TypeOrmQueryCache extends Counter<'result'> {}
|
|
@@ -0,0 +1,267 @@
|
|
|
1
|
+
import type { DbMetricsConfig } from '@rsdk/db';
|
|
2
|
+
import type {
|
|
3
|
+
DbClientMetrics,
|
|
4
|
+
DbMetricProvider,
|
|
5
|
+
EntityOperationsRecorder,
|
|
6
|
+
} from '@rsdk/db/dist/metrics/plugin-kit';
|
|
7
|
+
import {
|
|
8
|
+
DB_CLIENT_METRICS_TOKEN,
|
|
9
|
+
dbMetricsModuleProviders,
|
|
10
|
+
} from '@rsdk/db/dist/metrics/plugin-kit';
|
|
11
|
+
import type { ILogger } from '@rsdk/logging';
|
|
12
|
+
import type { DataSource } from 'typeorm';
|
|
13
|
+
|
|
14
|
+
import type { TypeOrmQueryCache } from '../metrics/typeorm.metrics';
|
|
15
|
+
|
|
16
|
+
import { TypeOrmMetricsModule } from './metrics.module';
|
|
17
|
+
|
|
18
|
+
const noop = (): void => {};
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Все члены, которые проверяет и использует инструментирование pg-pool
|
|
22
|
+
*/
|
|
23
|
+
const pgPool = (): { on: jest.Mock } & Record<string, unknown> => ({
|
|
24
|
+
totalCount: 0,
|
|
25
|
+
idleCount: 0,
|
|
26
|
+
waitingCount: 0,
|
|
27
|
+
options: { max: 10 },
|
|
28
|
+
connect: noop,
|
|
29
|
+
end: noop,
|
|
30
|
+
on: jest.fn(),
|
|
31
|
+
removeListener: noop,
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
/**
|
|
35
|
+
* Как пул mysql2: события есть, счётчиков нет
|
|
36
|
+
*/
|
|
37
|
+
const mysql2Pool = (): object => ({
|
|
38
|
+
getConnection: noop,
|
|
39
|
+
query: noop,
|
|
40
|
+
on: noop,
|
|
41
|
+
removeListener: noop,
|
|
42
|
+
config: { connectionLimit: 10 },
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Пул с частью полей pg-pool
|
|
47
|
+
*/
|
|
48
|
+
const partialPool = (): object => ({ totalCount: 0, connect: noop });
|
|
49
|
+
|
|
50
|
+
const config = {
|
|
51
|
+
isEnabled: true,
|
|
52
|
+
slowQueryThreshold: { millis: () => 500 },
|
|
53
|
+
ormEntityOperationsTotalEnabled: false,
|
|
54
|
+
} as unknown as DbMetricsConfig;
|
|
55
|
+
|
|
56
|
+
/**
|
|
57
|
+
* `DbClientMetrics` из провайдера по токену, так же как его получает Nest:
|
|
58
|
+
* фабрика провайдера с включённым конфигом и `APP_NAME`
|
|
59
|
+
*/
|
|
60
|
+
const clientMetrics = (appName: string): DbClientMetrics => {
|
|
61
|
+
const provider = dbMetricsModuleProviders().find(
|
|
62
|
+
(
|
|
63
|
+
candidate,
|
|
64
|
+
): candidate is Extract<
|
|
65
|
+
DbMetricProvider,
|
|
66
|
+
{ provide: typeof DB_CLIENT_METRICS_TOKEN }
|
|
67
|
+
> => candidate.provide === DB_CLIENT_METRICS_TOKEN,
|
|
68
|
+
);
|
|
69
|
+
const client = provider?.useFactory(config, appName);
|
|
70
|
+
|
|
71
|
+
if (!client) {
|
|
72
|
+
throw new Error('The DbClientMetrics provider gave no client');
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
return client;
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
const dataSource = (driver: object, type = 'postgres'): DataSource =>
|
|
79
|
+
({ driver, options: { type } }) as unknown as DataSource;
|
|
80
|
+
|
|
81
|
+
describe('TypeOrmMetricsModule pool instrumentation', () => {
|
|
82
|
+
const logger = { warn: jest.fn(), info: jest.fn() };
|
|
83
|
+
let module: TypeOrmMetricsModule | undefined;
|
|
84
|
+
|
|
85
|
+
const init = (
|
|
86
|
+
source: DataSource,
|
|
87
|
+
client: DbClientMetrics | null = clientMetrics('app'),
|
|
88
|
+
): void => {
|
|
89
|
+
module = new TypeOrmMetricsModule(
|
|
90
|
+
source,
|
|
91
|
+
client,
|
|
92
|
+
null,
|
|
93
|
+
null,
|
|
94
|
+
logger as unknown as ILogger,
|
|
95
|
+
);
|
|
96
|
+
module.onModuleInit();
|
|
97
|
+
};
|
|
98
|
+
|
|
99
|
+
afterEach(() => {
|
|
100
|
+
module?.onApplicationShutdown();
|
|
101
|
+
module = undefined;
|
|
102
|
+
logger.warn.mockReset();
|
|
103
|
+
logger.info.mockReset();
|
|
104
|
+
});
|
|
105
|
+
|
|
106
|
+
it('instruments the master and replicas', () => {
|
|
107
|
+
const master = pgPool();
|
|
108
|
+
const slave = pgPool();
|
|
109
|
+
|
|
110
|
+
init(dataSource({ master, slaves: [slave] }));
|
|
111
|
+
|
|
112
|
+
expect(master.on).toHaveBeenCalled();
|
|
113
|
+
expect(slave.on).toHaveBeenCalled();
|
|
114
|
+
expect(logger.warn).not.toHaveBeenCalled();
|
|
115
|
+
expect(logger.info).not.toHaveBeenCalled();
|
|
116
|
+
});
|
|
117
|
+
|
|
118
|
+
it.each([
|
|
119
|
+
['a mysql2-like pool', mysql2Pool()],
|
|
120
|
+
['a partial pool', partialPool()],
|
|
121
|
+
['no pool', undefined],
|
|
122
|
+
])(
|
|
123
|
+
'warns once and skips replicas when the postgres master is %s',
|
|
124
|
+
(_title, master) => {
|
|
125
|
+
const slave = pgPool();
|
|
126
|
+
|
|
127
|
+
expect(() => init(dataSource({ master, slaves: [slave] }))).not.toThrow();
|
|
128
|
+
expect(slave.on).not.toHaveBeenCalled();
|
|
129
|
+
expect(logger.warn).toHaveBeenCalledTimes(1);
|
|
130
|
+
expect(logger.warn).toHaveBeenCalledWith(
|
|
131
|
+
expect.stringContaining('app__typeorm: expected a pg pool'),
|
|
132
|
+
);
|
|
133
|
+
expect(logger.info).not.toHaveBeenCalled();
|
|
134
|
+
},
|
|
135
|
+
);
|
|
136
|
+
|
|
137
|
+
it('skips a partial replica with a warning and keeps the master', () => {
|
|
138
|
+
const master = pgPool();
|
|
139
|
+
const slave = pgPool();
|
|
140
|
+
|
|
141
|
+
init(dataSource({ master, slaves: [partialPool(), slave] }));
|
|
142
|
+
|
|
143
|
+
expect(master.on).toHaveBeenCalled();
|
|
144
|
+
expect(slave.on).toHaveBeenCalled();
|
|
145
|
+
expect(logger.warn).toHaveBeenCalledTimes(1);
|
|
146
|
+
expect(logger.warn).toHaveBeenCalledWith(
|
|
147
|
+
expect.stringContaining('app__typeorm:slave0: expected a pg pool'),
|
|
148
|
+
);
|
|
149
|
+
});
|
|
150
|
+
|
|
151
|
+
// Имя приложения модуль не передаёт: его знает `DbClientMetrics`,
|
|
152
|
+
// которому провайдер внедряет `APP_NAME`
|
|
153
|
+
it('labels pools with the application name of the injected client', () => {
|
|
154
|
+
init(dataSource({ master: partialPool() }), clientMetrics('other'));
|
|
155
|
+
|
|
156
|
+
expect(logger.warn).toHaveBeenCalledWith(
|
|
157
|
+
expect.stringContaining('other__typeorm: expected a pg pool'),
|
|
158
|
+
);
|
|
159
|
+
});
|
|
160
|
+
|
|
161
|
+
it('passes only the resource and asks to instrument queries for the master and replicas', () => {
|
|
162
|
+
const client = clientMetrics('app');
|
|
163
|
+
const instrumentPool = jest.spyOn(client, 'instrumentPool');
|
|
164
|
+
const master = pgPool();
|
|
165
|
+
const slave = pgPool();
|
|
166
|
+
|
|
167
|
+
init(dataSource({ master, slaves: [slave] }), client);
|
|
168
|
+
|
|
169
|
+
expect(instrumentPool.mock.calls).toEqual([
|
|
170
|
+
['pg', master, 'typeorm', logger, { instrumentQueries: true }],
|
|
171
|
+
['pg', slave, 'typeorm:slave0', logger, { instrumentQueries: true }],
|
|
172
|
+
]);
|
|
173
|
+
});
|
|
174
|
+
|
|
175
|
+
it('instruments nothing without an injected client', () => {
|
|
176
|
+
const master = pgPool();
|
|
177
|
+
|
|
178
|
+
init(dataSource({ master }), null);
|
|
179
|
+
|
|
180
|
+
expect(master.on).not.toHaveBeenCalled();
|
|
181
|
+
expect(logger.warn).not.toHaveBeenCalled();
|
|
182
|
+
expect(logger.info).not.toHaveBeenCalled();
|
|
183
|
+
});
|
|
184
|
+
|
|
185
|
+
it('logs info without a warning for a driver without pg pools', () => {
|
|
186
|
+
const master = pgPool();
|
|
187
|
+
|
|
188
|
+
init(dataSource({ master }, 'mysql'));
|
|
189
|
+
|
|
190
|
+
expect(master.on).not.toHaveBeenCalled();
|
|
191
|
+
expect(logger.warn).not.toHaveBeenCalled();
|
|
192
|
+
expect(logger.info).toHaveBeenCalledWith(
|
|
193
|
+
'Pool and query metrics are not supported for mysql',
|
|
194
|
+
);
|
|
195
|
+
});
|
|
196
|
+
});
|
|
197
|
+
|
|
198
|
+
/**
|
|
199
|
+
* DataSource без пулов `pg`, но с query cache и списком subscriber-ов
|
|
200
|
+
*/
|
|
201
|
+
const source = (): DataSource & { subscribers: unknown[] } =>
|
|
202
|
+
({
|
|
203
|
+
driver: {},
|
|
204
|
+
options: { type: 'mysql' },
|
|
205
|
+
subscribers: [],
|
|
206
|
+
queryResultCache: {
|
|
207
|
+
getFromCache: () => Promise.resolve(),
|
|
208
|
+
isExpired: () => false,
|
|
209
|
+
},
|
|
210
|
+
}) as unknown as DataSource & { subscribers: unknown[] };
|
|
211
|
+
|
|
212
|
+
describe('TypeOrmMetricsModule injected metrics', () => {
|
|
213
|
+
const logger = { warn: jest.fn(), info: jest.fn() };
|
|
214
|
+
const inc = jest.fn();
|
|
215
|
+
const record = jest.fn();
|
|
216
|
+
|
|
217
|
+
const create = (
|
|
218
|
+
dataSourceMock: DataSource,
|
|
219
|
+
client: DbClientMetrics | null,
|
|
220
|
+
): TypeOrmMetricsModule =>
|
|
221
|
+
new TypeOrmMetricsModule(
|
|
222
|
+
dataSourceMock,
|
|
223
|
+
client,
|
|
224
|
+
{ record } as unknown as EntityOperationsRecorder,
|
|
225
|
+
{ inc } as unknown as TypeOrmQueryCache,
|
|
226
|
+
logger as unknown as ILogger,
|
|
227
|
+
);
|
|
228
|
+
|
|
229
|
+
beforeEach(() => {
|
|
230
|
+
inc.mockClear();
|
|
231
|
+
record.mockClear();
|
|
232
|
+
});
|
|
233
|
+
|
|
234
|
+
it('counts query cache lookups with the injected counter and adds the entity operations subscriber', async () => {
|
|
235
|
+
const dataSourceMock = source();
|
|
236
|
+
const module = create(dataSourceMock, clientMetrics('app'));
|
|
237
|
+
|
|
238
|
+
module.onModuleInit();
|
|
239
|
+
await dataSourceMock.queryResultCache?.getFromCache({
|
|
240
|
+
query: 'SELECT 1',
|
|
241
|
+
duration: 1000,
|
|
242
|
+
});
|
|
243
|
+
|
|
244
|
+
expect(inc).toHaveBeenCalledWith({ result: 'miss' });
|
|
245
|
+
expect(dataSourceMock.subscribers).toHaveLength(1);
|
|
246
|
+
|
|
247
|
+
module.onApplicationShutdown();
|
|
248
|
+
|
|
249
|
+
expect(dataSourceMock.subscribers).toHaveLength(0);
|
|
250
|
+
});
|
|
251
|
+
|
|
252
|
+
it('uses no injected metric without an injected client', async () => {
|
|
253
|
+
const dataSourceMock = source();
|
|
254
|
+
const module = create(dataSourceMock, null);
|
|
255
|
+
|
|
256
|
+
module.onModuleInit();
|
|
257
|
+
await dataSourceMock.queryResultCache?.getFromCache({
|
|
258
|
+
query: 'SELECT 1',
|
|
259
|
+
duration: 1000,
|
|
260
|
+
});
|
|
261
|
+
|
|
262
|
+
expect(inc).not.toHaveBeenCalled();
|
|
263
|
+
expect(dataSourceMock.subscribers).toHaveLength(0);
|
|
264
|
+
|
|
265
|
+
module.onApplicationShutdown();
|
|
266
|
+
});
|
|
267
|
+
});
|
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
import type { OnApplicationShutdown, OnModuleInit } from '@nestjs/common';
|
|
2
|
+
import { Inject, Module } from '@nestjs/common';
|
|
3
|
+
import { InjectLogger } from '@rsdk/core';
|
|
4
|
+
import type {
|
|
5
|
+
DbClientMetrics,
|
|
6
|
+
Detach,
|
|
7
|
+
EntityOperationsRecorder,
|
|
8
|
+
} from '@rsdk/db/dist/metrics/plugin-kit';
|
|
9
|
+
import {
|
|
10
|
+
DB_CLIENT_METRICS_TOKEN,
|
|
11
|
+
DbMetricsModuleBase,
|
|
12
|
+
dbMetricsModuleProviders,
|
|
13
|
+
ENTITY_OPERATIONS_RECORDER_TOKEN,
|
|
14
|
+
} from '@rsdk/db/dist/metrics/plugin-kit';
|
|
15
|
+
import { ILogger } from '@rsdk/logging';
|
|
16
|
+
import { DataSource } from 'typeorm';
|
|
17
|
+
|
|
18
|
+
import { EntityOperationsSubscriber } from '../metrics/entity-operations.subscriber';
|
|
19
|
+
import { findPgPools } from '../metrics/pg-pools';
|
|
20
|
+
import { QueryCacheInstrumentation } from '../metrics/query-cache.instrumentation';
|
|
21
|
+
import { addSubscriber } from '../metrics/subscribers';
|
|
22
|
+
import { TypeOrmQueryCache } from '../metrics/typeorm.metrics';
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Подключает метрики БД к DataSource TypeORM: пулы `pg`, query cache и
|
|
26
|
+
* операции над сущностями. Выключатель `DB_METRICS_ENABLED`, внедрение
|
|
27
|
+
* метрик через DI (`DbClientMetrics` и `EntityOperationsRecorder` — по
|
|
28
|
+
* токенам из `plugin-kit`) и итог при остановке приложения описаны в
|
|
29
|
+
* {@link DbMetricsModuleBase}. Значение метки `pool` собирает ядро из
|
|
30
|
+
* `APP_NAME` и ресурса из {@link findPgPools}
|
|
31
|
+
*/
|
|
32
|
+
@Module({
|
|
33
|
+
providers: dbMetricsModuleProviders([TypeOrmQueryCache]),
|
|
34
|
+
})
|
|
35
|
+
export class TypeOrmMetricsModule
|
|
36
|
+
extends DbMetricsModuleBase
|
|
37
|
+
implements OnModuleInit, OnApplicationShutdown
|
|
38
|
+
{
|
|
39
|
+
/**
|
|
40
|
+
* @param queryCache `null`, только когда метрики выключены, а тогда
|
|
41
|
+
* `attach` не вызывается
|
|
42
|
+
*/
|
|
43
|
+
constructor(
|
|
44
|
+
private readonly dataSource: DataSource,
|
|
45
|
+
@Inject(DB_CLIENT_METRICS_TOKEN) client: DbClientMetrics | null,
|
|
46
|
+
@Inject(ENTITY_OPERATIONS_RECORDER_TOKEN)
|
|
47
|
+
entityOperations: EntityOperationsRecorder | null,
|
|
48
|
+
@Inject(TypeOrmQueryCache)
|
|
49
|
+
private readonly queryCache: TypeOrmQueryCache | null,
|
|
50
|
+
@InjectLogger(TypeOrmMetricsModule) private readonly logger: ILogger,
|
|
51
|
+
) {
|
|
52
|
+
super(client, entityOperations);
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
protected attach(
|
|
56
|
+
add: (detach?: Detach) => void,
|
|
57
|
+
client: DbClientMetrics,
|
|
58
|
+
): void {
|
|
59
|
+
this.instrumentPools(add, client);
|
|
60
|
+
this.instrumentQueryCache(add);
|
|
61
|
+
|
|
62
|
+
if (this.entityOperations) {
|
|
63
|
+
add(
|
|
64
|
+
addSubscriber(
|
|
65
|
+
this.dataSource,
|
|
66
|
+
new EntityOperationsSubscriber(this.entityOperations),
|
|
67
|
+
),
|
|
68
|
+
);
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/**
|
|
73
|
+
* Master инструментируется первым. Если он не прошёл проверку (warning
|
|
74
|
+
* пишет `instrumentPool`), реплики не инструментируются: запись идёт
|
|
75
|
+
* через master, и без него метрики запросов и транзакций показывали бы
|
|
76
|
+
* только чтения с реплик.
|
|
77
|
+
*
|
|
78
|
+
* `instrumentQueries: true` у всех пулов: {@link findPgPools} отдаёт пулы
|
|
79
|
+
* только у postgres и cockroachdb, а их соединения — клиенты `pg`
|
|
80
|
+
*/
|
|
81
|
+
private instrumentPools(
|
|
82
|
+
add: (detach?: Detach) => void,
|
|
83
|
+
client: DbClientMetrics,
|
|
84
|
+
): void {
|
|
85
|
+
const [master, ...replicas] = findPgPools(this.dataSource);
|
|
86
|
+
if (!master) {
|
|
87
|
+
this.logger.info(
|
|
88
|
+
`Pool and query metrics are not supported for ${this.dataSource.options.type}`,
|
|
89
|
+
);
|
|
90
|
+
return;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
const detachMaster = client.instrumentPool(
|
|
94
|
+
'pg',
|
|
95
|
+
master.pool,
|
|
96
|
+
master.resource,
|
|
97
|
+
this.logger,
|
|
98
|
+
{ instrumentQueries: true },
|
|
99
|
+
);
|
|
100
|
+
if (!detachMaster) {
|
|
101
|
+
return;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
add(detachMaster);
|
|
105
|
+
for (const { resource, pool } of replicas) {
|
|
106
|
+
add(
|
|
107
|
+
client.instrumentPool('pg', pool, resource, this.logger, {
|
|
108
|
+
instrumentQueries: true,
|
|
109
|
+
}),
|
|
110
|
+
);
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
|
|
114
|
+
private instrumentQueryCache(add: (detach?: Detach) => void): void {
|
|
115
|
+
const cache = this.dataSource.queryResultCache;
|
|
116
|
+
if (!cache || !this.queryCache) {
|
|
117
|
+
return;
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
add(new QueryCacheInstrumentation(this.queryCache).instrument(cache));
|
|
121
|
+
}
|
|
122
|
+
}
|
package/src/typeorm.plugin.ts
CHANGED
|
@@ -20,6 +20,7 @@ import type { DataSourceOptions } from 'typeorm';
|
|
|
20
20
|
|
|
21
21
|
import { DatasourceOptionsNotSet } from './internal/exceptions';
|
|
22
22
|
import { Initializer } from './internal/initializer';
|
|
23
|
+
import { TypeOrmMetricsModule } from './modules/metrics.module';
|
|
23
24
|
import { MigrationCheckerModule } from './modules/migration-checker.module';
|
|
24
25
|
import { TypeOrmOverrideEntitiesDataSourceFactory } from './providers/typeorm-override-entities.data-source-factory';
|
|
25
26
|
import {
|
|
@@ -172,6 +173,7 @@ export class TypeOrmPlugin implements PlatformAppPlugin {
|
|
|
172
173
|
},
|
|
173
174
|
}),
|
|
174
175
|
MigrationCheckerModule,
|
|
176
|
+
TypeOrmMetricsModule,
|
|
175
177
|
];
|
|
176
178
|
}
|
|
177
179
|
|