@rsdk/db 5.15.0-next.1 → 5.15.0-next.10

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.
Files changed (140) hide show
  1. package/dist/index.d.ts +1 -0
  2. package/dist/index.js +15 -0
  3. package/dist/index.js.map +1 -1
  4. package/dist/metrics/call-then.d.ts +30 -0
  5. package/dist/metrics/call-then.js +91 -0
  6. package/dist/metrics/call-then.js.map +1 -0
  7. package/dist/metrics/clock.d.ts +2 -0
  8. package/dist/metrics/clock.js +9 -0
  9. package/dist/metrics/clock.js.map +1 -0
  10. package/dist/metrics/db-client-metrics.d.ts +85 -0
  11. package/dist/metrics/db-client-metrics.js +164 -0
  12. package/dist/metrics/db-client-metrics.js.map +1 -0
  13. package/dist/metrics/db-metric.d.ts +41 -0
  14. package/dist/metrics/db-metric.js +99 -0
  15. package/dist/metrics/db-metric.js.map +1 -0
  16. package/dist/metrics/db-metrics.config.d.ts +7 -0
  17. package/dist/metrics/db-metrics.config.js +60 -0
  18. package/dist/metrics/db-metrics.config.js.map +1 -0
  19. package/dist/metrics/db-metrics.module-base.d.ts +61 -0
  20. package/dist/metrics/db-metrics.module-base.js +61 -0
  21. package/dist/metrics/db-metrics.module-base.js.map +1 -0
  22. package/dist/metrics/db-metrics.providers.d.ts +66 -0
  23. package/dist/metrics/db-metrics.providers.js +83 -0
  24. package/dist/metrics/db-metrics.providers.js.map +1 -0
  25. package/dist/metrics/detach-group.d.ts +19 -0
  26. package/dist/metrics/detach-group.js +31 -0
  27. package/dist/metrics/detach-group.js.map +1 -0
  28. package/dist/metrics/detach.d.ts +24 -0
  29. package/dist/metrics/detach.js +45 -0
  30. package/dist/metrics/detach.js.map +1 -0
  31. package/dist/metrics/entity-operations.recorder.d.ts +17 -0
  32. package/dist/metrics/entity-operations.recorder.js +28 -0
  33. package/dist/metrics/entity-operations.recorder.js.map +1 -0
  34. package/dist/metrics/events.d.ts +11 -0
  35. package/dist/metrics/events.js +20 -0
  36. package/dist/metrics/events.js.map +1 -0
  37. package/dist/metrics/guards.d.ts +12 -0
  38. package/dist/metrics/guards.js +19 -0
  39. package/dist/metrics/guards.js.map +1 -0
  40. package/dist/metrics/index.d.ts +1 -0
  41. package/dist/metrics/index.js +11 -0
  42. package/dist/metrics/index.js.map +1 -0
  43. package/dist/metrics/instrumentation/pg-pool.instrumentation.d.ts +48 -0
  44. package/dist/metrics/instrumentation/pg-pool.instrumentation.js +117 -0
  45. package/dist/metrics/instrumentation/pg-pool.instrumentation.js.map +1 -0
  46. package/dist/metrics/instrumentation/pool-adapters.d.ts +22 -0
  47. package/dist/metrics/instrumentation/pool-adapters.js +16 -0
  48. package/dist/metrics/instrumentation/pool-adapters.js.map +1 -0
  49. package/dist/metrics/instrumentation/pool-close.d.ts +10 -0
  50. package/dist/metrics/instrumentation/pool-close.js +43 -0
  51. package/dist/metrics/instrumentation/pool-close.js.map +1 -0
  52. package/dist/metrics/instrumentation/pool-scope.d.ts +13 -0
  53. package/dist/metrics/instrumentation/pool-scope.js +3 -0
  54. package/dist/metrics/instrumentation/pool-scope.js.map +1 -0
  55. package/dist/metrics/instrumentation/pool.adapter.d.ts +50 -0
  56. package/dist/metrics/instrumentation/pool.adapter.js +3 -0
  57. package/dist/metrics/instrumentation/pool.adapter.js.map +1 -0
  58. package/dist/metrics/instrumentation/pool.recorder.d.ts +74 -0
  59. package/dist/metrics/instrumentation/pool.recorder.js +125 -0
  60. package/dist/metrics/instrumentation/pool.recorder.js.map +1 -0
  61. package/dist/metrics/instrumentation/query-completion.d.ts +12 -0
  62. package/dist/metrics/instrumentation/query-completion.js +76 -0
  63. package/dist/metrics/instrumentation/query-completion.js.map +1 -0
  64. package/dist/metrics/instrumentation/query.instrumentation.d.ts +35 -0
  65. package/dist/metrics/instrumentation/query.instrumentation.js +85 -0
  66. package/dist/metrics/instrumentation/query.instrumentation.js.map +1 -0
  67. package/dist/metrics/instrumentation/tarn-pool.instrumentation.d.ts +44 -0
  68. package/dist/metrics/instrumentation/tarn-pool.instrumentation.js +95 -0
  69. package/dist/metrics/instrumentation/tarn-pool.instrumentation.js.map +1 -0
  70. package/dist/metrics/instrumentation/transaction-tracker.d.ts +32 -0
  71. package/dist/metrics/instrumentation/transaction-tracker.js +64 -0
  72. package/dist/metrics/instrumentation/transaction-tracker.js.map +1 -0
  73. package/dist/metrics/metric-types.d.ts +17 -0
  74. package/dist/metrics/metric-types.js +3 -0
  75. package/dist/metrics/metric-types.js.map +1 -0
  76. package/dist/metrics/metrics.d.ts +82 -0
  77. package/dist/metrics/metrics.js +269 -0
  78. package/dist/metrics/metrics.js.map +1 -0
  79. package/dist/metrics/plugin-kit.d.ts +12 -0
  80. package/dist/metrics/plugin-kit.js +42 -0
  81. package/dist/metrics/plugin-kit.js.map +1 -0
  82. package/dist/metrics/pool-names.d.ts +47 -0
  83. package/dist/metrics/pool-names.js +44 -0
  84. package/dist/metrics/pool-names.js.map +1 -0
  85. package/dist/metrics/pool-stats.registry.d.ts +25 -0
  86. package/dist/metrics/pool-stats.registry.js +32 -0
  87. package/dist/metrics/pool-stats.registry.js.map +1 -0
  88. package/dist/metrics/scrape-source.registry.d.ts +29 -0
  89. package/dist/metrics/scrape-source.registry.js +55 -0
  90. package/dist/metrics/scrape-source.registry.js.map +1 -0
  91. package/dist/metrics/sql.d.ts +34 -0
  92. package/dist/metrics/sql.js +132 -0
  93. package/dist/metrics/sql.js.map +1 -0
  94. package/package.json +2 -2
  95. package/src/index.ts +1 -0
  96. package/src/metrics/call-then.ts +134 -0
  97. package/src/metrics/clock.ts +5 -0
  98. package/src/metrics/db-client-metrics.spec.ts +1894 -0
  99. package/src/metrics/db-client-metrics.ts +206 -0
  100. package/src/metrics/db-metric.spec.ts +185 -0
  101. package/src/metrics/db-metric.ts +186 -0
  102. package/src/metrics/db-metrics.config.ts +46 -0
  103. package/src/metrics/db-metrics.module-base.spec.ts +91 -0
  104. package/src/metrics/db-metrics.module-base.ts +77 -0
  105. package/src/metrics/db-metrics.providers.spec.ts +182 -0
  106. package/src/metrics/db-metrics.providers.ts +134 -0
  107. package/src/metrics/detach-group.spec.ts +41 -0
  108. package/src/metrics/detach-group.ts +30 -0
  109. package/src/metrics/detach.spec.ts +61 -0
  110. package/src/metrics/detach.ts +57 -0
  111. package/src/metrics/entity-operations.recorder.ts +26 -0
  112. package/src/metrics/events.spec.ts +19 -0
  113. package/src/metrics/events.ts +28 -0
  114. package/src/metrics/guards.spec.ts +20 -0
  115. package/src/metrics/guards.ts +19 -0
  116. package/src/metrics/index.ts +6 -0
  117. package/src/metrics/instrumentation/pg-pool.instrumentation.ts +177 -0
  118. package/src/metrics/instrumentation/pool-adapters.ts +35 -0
  119. package/src/metrics/instrumentation/pool-close.ts +59 -0
  120. package/src/metrics/instrumentation/pool-guards.spec.ts +318 -0
  121. package/src/metrics/instrumentation/pool-scope.ts +14 -0
  122. package/src/metrics/instrumentation/pool.adapter.ts +67 -0
  123. package/src/metrics/instrumentation/pool.recorder.ts +167 -0
  124. package/src/metrics/instrumentation/query-completion.spec.ts +209 -0
  125. package/src/metrics/instrumentation/query-completion.ts +107 -0
  126. package/src/metrics/instrumentation/query.instrumentation.ts +136 -0
  127. package/src/metrics/instrumentation/tarn-pool.instrumentation.ts +138 -0
  128. package/src/metrics/instrumentation/transaction-tracker.ts +103 -0
  129. package/src/metrics/metric-types.ts +36 -0
  130. package/src/metrics/metrics.ts +233 -0
  131. package/src/metrics/plugin-kit.ts +39 -0
  132. package/src/metrics/pool-names.spec.ts +79 -0
  133. package/src/metrics/pool-names.ts +77 -0
  134. package/src/metrics/pool-stats.registry.spec.ts +81 -0
  135. package/src/metrics/pool-stats.registry.ts +54 -0
  136. package/src/metrics/public-api.spec.ts +104 -0
  137. package/src/metrics/scrape-source.registry.spec.ts +59 -0
  138. package/src/metrics/scrape-source.registry.ts +55 -0
  139. package/src/metrics/sql.spec.ts +110 -0
  140. package/src/metrics/sql.ts +172 -0
package/dist/index.d.ts CHANGED
@@ -9,3 +9,4 @@ export { getSecureContextOptions } from './tls';
9
9
  export { SslModeEnum } from './ssl-mode.enum';
10
10
  export { MultiHostUrl, MultiHostUrlParser, MultiHostResolver, InvalidMultiHostUrl, InvalidMultiHostProtocol, MultiHostNativeRequired, pgProbe, loadPgJsDriver, withoutPgNative, resolveDbConnection, } from './multi-host-url';
11
11
  export type { MultiHostEntry, MultiHostUrlInit, MultiHostProbe, PgModule, PgNativeModule, ResolveDbConnectionOptions, ResolvedDbConnection, } from './multi-host-url';
12
+ export * from './metrics';
package/dist/index.js CHANGED
@@ -1,4 +1,18 @@
1
1
  "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
2
16
  Object.defineProperty(exports, "__esModule", { value: true });
3
17
  exports.resolveDbConnection = exports.withoutPgNative = exports.loadPgJsDriver = exports.pgProbe = exports.MultiHostNativeRequired = exports.InvalidMultiHostProtocol = exports.InvalidMultiHostUrl = exports.MultiHostResolver = exports.MultiHostUrlParser = exports.MultiHostUrl = exports.SslModeEnum = exports.getSecureContextOptions = exports.HEALTH_CHECK_QUERY = exports.Propagation = exports.TransactionRunner = exports.IncompatibleIsolationLevels = exports.CallOutOfContextWithMandatory = exports.NeverRunningInTransaction = exports.BaseContext = exports.ContextStorage = void 0;
4
18
  var context_storage_1 = require("./context.storage");
@@ -30,4 +44,5 @@ Object.defineProperty(exports, "pgProbe", { enumerable: true, get: function () {
30
44
  Object.defineProperty(exports, "loadPgJsDriver", { enumerable: true, get: function () { return multi_host_url_1.loadPgJsDriver; } });
31
45
  Object.defineProperty(exports, "withoutPgNative", { enumerable: true, get: function () { return multi_host_url_1.withoutPgNative; } });
32
46
  Object.defineProperty(exports, "resolveDbConnection", { enumerable: true, get: function () { return multi_host_url_1.resolveDbConnection; } });
47
+ __exportStar(require("./metrics"), exports);
33
48
  //# sourceMappingURL=index.js.map
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qDAAmD;AAA1C,iHAAA,cAAc,OAAA;AACvB,+CAA6C;AAApC,2GAAA,WAAW,OAAA;AAEpB,2CAIsB;AAHpB,uHAAA,yBAAyB,OAAA;AACzB,2HAAA,6BAA6B,OAAA;AAC7B,yHAAA,2BAA2B,OAAA;AAE7B,+DAA2D;AAAlD,yHAAA,iBAAiB,OAAA;AAC1B,uDAAiD;AAAxC,+GAAA,WAAW,OAAA;AACpB,yCAAiD;AAAxC,+GAAA,kBAAkB,OAAA;AAC3B,6BAAgD;AAAvC,8GAAA,uBAAuB,OAAA;AAChC,iDAA8C;AAArC,4GAAA,WAAW,OAAA;AACpB,mDAW0B;AAVxB,8GAAA,YAAY,OAAA;AACZ,oHAAA,kBAAkB,OAAA;AAClB,mHAAA,iBAAiB,OAAA;AACjB,qHAAA,mBAAmB,OAAA;AACnB,0HAAA,wBAAwB,OAAA;AACxB,yHAAA,uBAAuB,OAAA;AACvB,yGAAA,OAAO,OAAA;AACP,gHAAA,cAAc,OAAA;AACd,iHAAA,eAAe,OAAA;AACf,qHAAA,mBAAmB,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,qDAAmD;AAA1C,iHAAA,cAAc,OAAA;AACvB,+CAA6C;AAApC,2GAAA,WAAW,OAAA;AAEpB,2CAIsB;AAHpB,uHAAA,yBAAyB,OAAA;AACzB,2HAAA,6BAA6B,OAAA;AAC7B,yHAAA,2BAA2B,OAAA;AAE7B,+DAA2D;AAAlD,yHAAA,iBAAiB,OAAA;AAC1B,uDAAiD;AAAxC,+GAAA,WAAW,OAAA;AACpB,yCAAiD;AAAxC,+GAAA,kBAAkB,OAAA;AAC3B,6BAAgD;AAAvC,8GAAA,uBAAuB,OAAA;AAChC,iDAA8C;AAArC,4GAAA,WAAW,OAAA;AACpB,mDAW0B;AAVxB,8GAAA,YAAY,OAAA;AACZ,oHAAA,kBAAkB,OAAA;AAClB,mHAAA,iBAAiB,OAAA;AACjB,qHAAA,mBAAmB,OAAA;AACnB,0HAAA,wBAAwB,OAAA;AACxB,yHAAA,uBAAuB,OAAA;AACvB,yGAAA,OAAO,OAAA;AACP,gHAAA,cAAc,OAAA;AACd,iHAAA,eAAe,OAAA;AACf,qHAAA,mBAAmB,OAAA;AAWrB,4CAA0B"}
@@ -0,0 +1,30 @@
1
+ /**
2
+ * Сообщает, что вызов закончился: с ошибкой или с результатом
3
+ */
4
+ export type CallDone = (error?: unknown, result?: unknown) => void;
5
+ export interface CallThenOptions {
6
+ /**
7
+ * Где метод ждёт callback: первым аргументом (`pool.connect(cb)`) или
8
+ * последней функцией среди аргументов (`client.query(sql, values, cb)`)
9
+ */
10
+ callbackAt: 'first' | 'last';
11
+ /**
12
+ * Результат пришёл без callback и это не promise. Если вызов на самом
13
+ * деле ещё идёт (например, поток), `watchResult` сам вызовет `done`,
14
+ * когда он закончится, и вернёт `true`. Без него или при `false` вызов
15
+ * считается законченным сразу
16
+ */
17
+ watchResult?: (result: unknown, done: CallDone) => boolean;
18
+ }
19
+ /**
20
+ * Вызывает метод, который сообщает о завершении callback-ом, promise или
21
+ * (через `watchResult`) чем-то ещё, и вызывает `done`, когда вызов
22
+ * закончился, — при ошибке тоже. `done` вызывается один раз.
23
+ *
24
+ * Исход вызова не меняется: callback получает те же аргументы, вызывающий —
25
+ * тот же результат, promise с тем же значением или той же ошибкой (см.
26
+ * {@link thenWithDone}), синхронное исключение бросается дальше. Исключение
27
+ * из самого `done` проглатывается: сбой учёта не должен менять исход вызова
28
+ * и мешать вызвать callback
29
+ */
30
+ export declare const callThen: (method: (...args: any[]) => any, thisArg: unknown, args: readonly unknown[], done: CallDone, { callbackAt, watchResult }: CallThenOptions) => unknown;
@@ -0,0 +1,91 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.callThen = void 0;
4
+ const guards_1 = require("./guards");
5
+ const callbackIndexOf = (args, callbackAt) => {
6
+ if (callbackAt === 'first') {
7
+ return typeof args[0] === 'function' ? 0 : -1;
8
+ }
9
+ return args.findLastIndex((arg) => typeof arg === 'function');
10
+ };
11
+ /**
12
+ * Promise-результат: вызывающему отдаётся производный promise с тем же
13
+ * значением или той же ошибкой, а исходный больше никому не достаётся.
14
+ *
15
+ * Обработчик, повешенный прямо на исходный promise, считался бы обработкой
16
+ * отказа: ошибка, которую вызывающий не обработал, молча пропала бы вместо
17
+ * `unhandledRejection`. Производный promise отклоняется той же ошибкой,
18
+ * поэтому без обработчика у вызывающего процесс видит `unhandledRejection`,
19
+ * как и без метрик.
20
+ *
21
+ * `then` у thenable не обязан вернуть promise с `catch`/`finally` — тогда
22
+ * результат оборачивается в `Promise.resolve`
23
+ */
24
+ const thenWithDone = (result, done) => {
25
+ const derived = result.then((value) => {
26
+ done(undefined, value);
27
+ return value;
28
+ }, (error) => {
29
+ done(error);
30
+ throw error;
31
+ });
32
+ return typeof derived?.catch ===
33
+ 'function'
34
+ ? derived
35
+ : Promise.resolve(derived);
36
+ };
37
+ /**
38
+ * Вызывает метод, который сообщает о завершении callback-ом, promise или
39
+ * (через `watchResult`) чем-то ещё, и вызывает `done`, когда вызов
40
+ * закончился, — при ошибке тоже. `done` вызывается один раз.
41
+ *
42
+ * Исход вызова не меняется: callback получает те же аргументы, вызывающий —
43
+ * тот же результат, promise с тем же значением или той же ошибкой (см.
44
+ * {@link thenWithDone}), синхронное исключение бросается дальше. Исключение
45
+ * из самого `done` проглатывается: сбой учёта не должен менять исход вызова
46
+ * и мешать вызвать callback
47
+ */
48
+ const callThen = (method, thisArg, args, done, { callbackAt, watchResult }) => {
49
+ let finished = false;
50
+ const finish = (...outcome) => {
51
+ if (finished) {
52
+ return;
53
+ }
54
+ finished = true;
55
+ try {
56
+ done(...outcome);
57
+ }
58
+ catch {
59
+ // Метрика не записалась: вызов и вызывающий код важнее
60
+ }
61
+ };
62
+ const callbackIndex = callbackIndexOf(args, callbackAt);
63
+ const callArgs = [...args];
64
+ if (callbackIndex !== -1) {
65
+ const callback = args[callbackIndex];
66
+ callArgs[callbackIndex] = (...outcome) => {
67
+ finish(outcome[0], outcome[1]);
68
+ callback(...outcome);
69
+ };
70
+ }
71
+ let result;
72
+ try {
73
+ result = method.apply(thisArg, callArgs);
74
+ }
75
+ catch (error) {
76
+ finish(error);
77
+ throw error;
78
+ }
79
+ if (callbackIndex !== -1) {
80
+ return result;
81
+ }
82
+ if ((0, guards_1.isThenable)(result)) {
83
+ return thenWithDone(result, finish);
84
+ }
85
+ if (!watchResult?.(result, finish)) {
86
+ finish();
87
+ }
88
+ return result;
89
+ };
90
+ exports.callThen = callThen;
91
+ //# sourceMappingURL=call-then.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"call-then.js","sourceRoot":"","sources":["../../src/metrics/call-then.ts"],"names":[],"mappings":";;;AAAA,qCAAsC;AAuBtC,MAAM,eAAe,GAAG,CACtB,IAAwB,EACxB,UAAyC,EACjC,EAAE;IACV,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;QAC3B,OAAO,OAAO,IAAI,CAAC,CAAC,CAAC,KAAK,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IAChD,CAAC;IAED,OAAO,IAAI,CAAC,aAAa,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,UAAU,CAAC,CAAC;AAChE,CAAC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,MAAM,YAAY,GAAG,CACnB,MAA4B,EAC5B,IAAc,EACQ,EAAE;IACxB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,CAAC,KAAK,EAAE,EAAE;QACR,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;QACvB,OAAO,KAAK,CAAC;IACf,CAAC,EACD,CAAC,KAAc,EAAE,EAAE;QACjB,IAAI,CAAC,KAAK,CAAC,CAAC;QACZ,MAAM,KAAK,CAAC;IACd,CAAC,CACF,CAAC;IAEF,OAAO,OAAQ,OAAiD,EAAE,KAAK;QACrE,UAAU;QACV,CAAC,CAAC,OAAO;QACT,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC,CAAC;AAEF;;;;;;;;;;GAUG;AACI,MAAM,QAAQ,GAAG,CACtB,MAA+B,EAC/B,OAAgB,EAChB,IAAwB,EACxB,IAAc,EACd,EAAE,UAAU,EAAE,WAAW,EAAmB,EACnC,EAAE;IACX,IAAI,QAAQ,GAAG,KAAK,CAAC;IACrB,MAAM,MAAM,GAAa,CAAC,GAAG,OAAO,EAAE,EAAE;QACtC,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QAED,QAAQ,GAAG,IAAI,CAAC;QAChB,IAAI,CAAC;YACH,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC;QACnB,CAAC;QAAC,MAAM,CAAC;YACP,uDAAuD;QACzD,CAAC;IACH,CAAC,CAAC;IACF,MAAM,aAAa,GAAG,eAAe,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IACxD,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAE3B,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE,CAAC;QACzB,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAoC,CAAC;QAExE,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,OAAkB,EAAQ,EAAE;YACxD,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YAC/B,QAAQ,CAAC,GAAG,OAAO,CAAC,CAAC;QACvB,CAAC,CAAC;IACJ,CAAC;IAED,IAAI,MAAe,CAAC;IAEpB,IAAI,CAAC;QACH,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC3C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,CAAC;QACd,MAAM,KAAK,CAAC;IACd,CAAC;IAED,IAAI,aAAa,KAAK,CAAC,CAAC,EAAE,CAAC;QACzB,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,IAAA,mBAAU,EAAC,MAAM,CAAC,EAAE,CAAC;QACvB,OAAO,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,IAAI,CAAC,WAAW,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QACnC,MAAM,EAAE,CAAC;IACX,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAtDW,QAAA,QAAQ,YAsDnB"}
@@ -0,0 +1,2 @@
1
+ export declare const now: () => number;
2
+ export declare const secondsSince: (start: number) => number;
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.secondsSince = exports.now = void 0;
4
+ const node_perf_hooks_1 = require("node:perf_hooks");
5
+ const now = () => node_perf_hooks_1.performance.now();
6
+ exports.now = now;
7
+ const secondsSince = (start) => ((0, exports.now)() - start) / 1000;
8
+ exports.secondsSince = secondsSince;
9
+ //# sourceMappingURL=clock.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"clock.js","sourceRoot":"","sources":["../../src/metrics/clock.ts"],"names":[],"mappings":";;;AAAA,qDAA8C;AAEvC,MAAM,GAAG,GAAG,GAAW,EAAE,CAAC,6BAAW,CAAC,GAAG,EAAE,CAAC;AAAtC,QAAA,GAAG,OAAmC;AAE5C,MAAM,YAAY,GAAG,CAAC,KAAa,EAAU,EAAE,CAAC,CAAC,IAAA,WAAG,GAAE,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC;AAAjE,QAAA,YAAY,gBAAqD"}
@@ -0,0 +1,85 @@
1
+ import type { ILogger } from '@rsdk/logging';
2
+ import type { DbPoolKind } from './instrumentation/pool-adapters';
3
+ import type { DbMetricsConfig } from './db-metrics.config';
4
+ import type { Detach } from './detach';
5
+ export type { DbPoolKind } from './instrumentation/pool-adapters';
6
+ /**
7
+ * Метрики пула, запросов и транзакций на уровне драйвера.
8
+ *
9
+ * Запросы и транзакции считаются по SQL, который уходит в клиент `pg`:
10
+ * так одинаково работают TypeORM и MikroORM (через knex), а длительность
11
+ * запроса не включает ожидание соединения из пула.
12
+ *
13
+ * Пул подключается через {@link DbClientMetrics.instrumentPool}: вид пула
14
+ * выбирает адаптер, адаптер отдаёт то, что зависит от библиотеки пула
15
+ * (проверку, события, состояние, метод закрытия). Имя пула, источник gauge
16
+ * и итог при закрытии этот класс ставит одинаково для любого пула, так что
17
+ * новый драйвер — это только новый адаптер.
18
+ *
19
+ * Значение метки `pool` — `<APP_NAME>__<ресурс>`: имя приложения
20
+ * экземпляр получает в {@link DbClientMetrics.create}, ресурс передаёт
21
+ * плагин. Значение уникально в процессе: если имя уже занято подключённым пулом, пул
22
+ * получает имя с суффиксом `#2`, `#3`, …
23
+ */
24
+ export declare class DbClientMetrics {
25
+ private readonly appName;
26
+ private readonly createRecorder;
27
+ private readonly queries;
28
+ private constructor();
29
+ /**
30
+ * Собирает инструментирование на метриках prom-client. Порог медленного
31
+ * запроса берётся из `DB_METRICS_SLOW_QUERY_THRESHOLD`.
32
+ *
33
+ * Модуль метрик ORM сам его не вызывает: экземпляр (или `null`, если
34
+ * метрики выключены) приходит через DI из провайдера
35
+ * `dbMetricsModuleProviders`, который передаёт и `APP_NAME` приложения
36
+ *
37
+ * @param appName `APP_NAME` приложения: с него начинается значение метки
38
+ * `pool` у всех пулов этого экземпляра
39
+ */
40
+ static create(config: DbMetricsConfig, appName: string): DbClientMetrics;
41
+ /**
42
+ * Подключает пул к метрикам. Пул, который не прошёл проверку адаптера
43
+ * (другой драйвер или не хватает членов), не инструментируется: в лог
44
+ * пишется warning, имя не занимается, результат `undefined`. Процесс
45
+ * при этом не падает.
46
+ *
47
+ * Итог по пулу подводится один раз, в тот момент, который наступит
48
+ * первым: пул закрылся (закончился первый вызов его `end`/`destroy`) или
49
+ * вызван возвращённый detach. Итог: соединения, которые инструментирование
50
+ * видело открытыми, учитываются закрытыми (их открытые транзакции —
51
+ * откатом), ряды пула в `db_client_queries_active` и
52
+ * `db_transactions_active` удаляются, пул пропадает из
53
+ * `db_pool_connections*`. После итога сняты подписки на события пула и
54
+ * обёртки его методов (`connect`, `end`/`destroy`), а имя пула снова
55
+ * свободно.
56
+ *
57
+ * Обёртки `query` на соединениях остаются: запрос, который завершится
58
+ * позже, пишет длительность, медленные запросы, ошибки и итог транзакции,
59
+ * но не трогает удалённые ряды пула.
60
+ *
61
+ * Пул, который потерял соединения, но не закрыт, итога не получает: его
62
+ * ряды остаются и показывают это состояние.
63
+ *
64
+ * Если подключение бросило исключение, уже поставленное снимается, имя
65
+ * освобождается, а исключение уходит вызывающему.
66
+ *
67
+ * @param kind вид пула: `pg` — `pg-pool`, `tarn` — пул knex
68
+ * @param pool объект пула из драйвера ORM, как есть
69
+ * @param resource ресурс пула внутри приложения: `typeorm`,
70
+ * `typeorm:slave0`, `mikro-orm`. Значение label `pool` —
71
+ * `<APP_NAME>__<resource>`; если оно занято другим подключённым пулом,
72
+ * к нему добавляется суффикс `#N`
73
+ * @param logger куда писать warning о пуле, который не прошёл проверку
74
+ * @param options `instrumentQueries` — оборачивать ли `query` у
75
+ * соединений пула, одинаково для любого вида пула. `true` передавать
76
+ * только для соединений драйвера `pg` (PostgreSQL): у остальных драйверов
77
+ * другой формат ошибок и ответов
78
+ * @returns detach, который подводит итог по пулу, если тот ещё не
79
+ * закрылся, или `undefined`
80
+ */
81
+ instrumentPool(kind: DbPoolKind, pool: unknown, resource: string, logger: Pick<ILogger, 'warn'>, options: {
82
+ instrumentQueries: boolean;
83
+ }): Detach | undefined;
84
+ private instrumentWith;
85
+ }
@@ -0,0 +1,164 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.DbClientMetrics = void 0;
4
+ const pool_recorder_1 = require("./instrumentation/pool.recorder");
5
+ const pool_adapters_1 = require("./instrumentation/pool-adapters");
6
+ const pool_close_1 = require("./instrumentation/pool-close");
7
+ const query_instrumentation_1 = require("./instrumentation/query.instrumentation");
8
+ const transaction_tracker_1 = require("./instrumentation/transaction-tracker");
9
+ const metrics_1 = require("./metrics");
10
+ const pool_names_1 = require("./pool-names");
11
+ const pool_stats_registry_1 = require("./pool-stats.registry");
12
+ /**
13
+ * Метрики пула, запросов и транзакций на уровне драйвера.
14
+ *
15
+ * Запросы и транзакции считаются по SQL, который уходит в клиент `pg`:
16
+ * так одинаково работают TypeORM и MikroORM (через knex), а длительность
17
+ * запроса не включает ожидание соединения из пула.
18
+ *
19
+ * Пул подключается через {@link DbClientMetrics.instrumentPool}: вид пула
20
+ * выбирает адаптер, адаптер отдаёт то, что зависит от библиотеки пула
21
+ * (проверку, события, состояние, метод закрытия). Имя пула, источник gauge
22
+ * и итог при закрытии этот класс ставит одинаково для любого пула, так что
23
+ * новый драйвер — это только новый адаптер.
24
+ *
25
+ * Значение метки `pool` — `<APP_NAME>__<ресурс>`: имя приложения
26
+ * экземпляр получает в {@link DbClientMetrics.create}, ресурс передаёт
27
+ * плагин. Значение уникально в процессе: если имя уже занято подключённым пулом, пул
28
+ * получает имя с суффиксом `#2`, `#3`, …
29
+ */
30
+ class DbClientMetrics {
31
+ appName;
32
+ createRecorder;
33
+ queries;
34
+ constructor(appName, createRecorder, queries) {
35
+ this.appName = appName;
36
+ this.createRecorder = createRecorder;
37
+ this.queries = queries;
38
+ }
39
+ /**
40
+ * Собирает инструментирование на метриках prom-client. Порог медленного
41
+ * запроса берётся из `DB_METRICS_SLOW_QUERY_THRESHOLD`.
42
+ *
43
+ * Модуль метрик ORM сам его не вызывает: экземпляр (или `null`, если
44
+ * метрики выключены) приходит через DI из провайдера
45
+ * `dbMetricsModuleProviders`, который передаёт и `APP_NAME` приложения
46
+ *
47
+ * @param appName `APP_NAME` приложения: с него начинается значение метки
48
+ * `pool` у всех пулов этого экземпляра
49
+ */
50
+ static create(config, appName) {
51
+ // Все метрики клиента регистрируются здесь. Значения db_pool_connections
52
+ // и db_pool_connections_max считываются при scrape из PoolStatsRegistry,
53
+ // поэтому ниже эти две метрики не используются
54
+ const metrics = (0, metrics_1.resolveClientMetrics)();
55
+ const transactions = new transaction_tracker_1.TransactionTracker({
56
+ total: metrics.transactions,
57
+ duration: metrics.transactionDuration,
58
+ active: metrics.transactionsActive,
59
+ });
60
+ const queries = new query_instrumentation_1.QueryInstrumentation({
61
+ duration: metrics.duration,
62
+ active: metrics.queriesActive,
63
+ slow: metrics.slow,
64
+ errors: metrics.errors,
65
+ }, transactions, config.slowQueryThreshold.millis());
66
+ const poolMetrics = {
67
+ created: metrics.created,
68
+ closed: metrics.closed,
69
+ acquireDuration: metrics.acquireDuration,
70
+ acquireTimeouts: metrics.acquireTimeouts,
71
+ usage: metrics.usage,
72
+ errors: metrics.poolErrors,
73
+ poolGauges: [metrics.queriesActive, metrics.transactionsActive],
74
+ };
75
+ const createRecorder = (pool) => new pool_recorder_1.PoolRecorder(pool, poolMetrics, transactions);
76
+ return new DbClientMetrics(appName, createRecorder, queries);
77
+ }
78
+ /**
79
+ * Подключает пул к метрикам. Пул, который не прошёл проверку адаптера
80
+ * (другой драйвер или не хватает членов), не инструментируется: в лог
81
+ * пишется warning, имя не занимается, результат `undefined`. Процесс
82
+ * при этом не падает.
83
+ *
84
+ * Итог по пулу подводится один раз, в тот момент, который наступит
85
+ * первым: пул закрылся (закончился первый вызов его `end`/`destroy`) или
86
+ * вызван возвращённый detach. Итог: соединения, которые инструментирование
87
+ * видело открытыми, учитываются закрытыми (их открытые транзакции —
88
+ * откатом), ряды пула в `db_client_queries_active` и
89
+ * `db_transactions_active` удаляются, пул пропадает из
90
+ * `db_pool_connections*`. После итога сняты подписки на события пула и
91
+ * обёртки его методов (`connect`, `end`/`destroy`), а имя пула снова
92
+ * свободно.
93
+ *
94
+ * Обёртки `query` на соединениях остаются: запрос, который завершится
95
+ * позже, пишет длительность, медленные запросы, ошибки и итог транзакции,
96
+ * но не трогает удалённые ряды пула.
97
+ *
98
+ * Пул, который потерял соединения, но не закрыт, итога не получает: его
99
+ * ряды остаются и показывают это состояние.
100
+ *
101
+ * Если подключение бросило исключение, уже поставленное снимается, имя
102
+ * освобождается, а исключение уходит вызывающему.
103
+ *
104
+ * @param kind вид пула: `pg` — `pg-pool`, `tarn` — пул knex
105
+ * @param pool объект пула из драйвера ORM, как есть
106
+ * @param resource ресурс пула внутри приложения: `typeorm`,
107
+ * `typeorm:slave0`, `mikro-orm`. Значение label `pool` —
108
+ * `<APP_NAME>__<resource>`; если оно занято другим подключённым пулом,
109
+ * к нему добавляется суффикс `#N`
110
+ * @param logger куда писать warning о пуле, который не прошёл проверку
111
+ * @param options `instrumentQueries` — оборачивать ли `query` у
112
+ * соединений пула, одинаково для любого вида пула. `true` передавать
113
+ * только для соединений драйвера `pg` (PostgreSQL): у остальных драйверов
114
+ * другой формат ошибок и ответов
115
+ * @returns detach, который подводит итог по пулу, если тот ещё не
116
+ * закрылся, или `undefined`
117
+ */
118
+ instrumentPool(kind, pool, resource, logger, options) {
119
+ return this.instrumentWith((0, pool_adapters_1.poolAdapter)(kind), kind, pool, { appName: this.appName, resource }, logger, options.instrumentQueries);
120
+ }
121
+ instrumentWith(adapter, kind, pool, label, logger, withQueries) {
122
+ if (!adapter.isPool(pool)) {
123
+ logger.warn(`Pool metrics are disabled for pool ${(0, pool_names_1.poolLabelValue)(label)}: expected a ${kind} pool`);
124
+ return undefined;
125
+ }
126
+ const claimed = pool_names_1.PoolNames.claim(label);
127
+ // Что уже поставлено, в порядке снятия при итоге. Если подключение
128
+ // бросит исключение, снимается то, что успели поставить
129
+ const steps = [];
130
+ try {
131
+ const recorder = this.createRecorder(claimed.name);
132
+ steps.push(() => recorder.detach());
133
+ const onConnectionCreated = (connection) => {
134
+ recorder.connectionCreated(connection);
135
+ if (withQueries) {
136
+ this.queries.instrument(connection, recorder);
137
+ }
138
+ };
139
+ // Сначала подписки, потом уже открытые соединения: если о соединении
140
+ // сообщат и событие, и обход, recorder учтёт его один раз
141
+ steps.push(adapter.attach(pool, recorder, onConnectionCreated));
142
+ for (const connection of adapter.openConnections(pool)) {
143
+ onConnectionCreated(connection);
144
+ }
145
+ steps.push(pool_stats_registry_1.PoolStatsRegistry.add({
146
+ pool: claimed.name,
147
+ stats: () => adapter.stats(pool),
148
+ }));
149
+ return (0, pool_close_1.finishOnClose)(pool, adapter.closeMethod, [
150
+ ...steps,
151
+ claimed.release,
152
+ ]);
153
+ }
154
+ catch (error) {
155
+ for (const step of steps) {
156
+ step();
157
+ }
158
+ claimed.release();
159
+ throw error;
160
+ }
161
+ }
162
+ }
163
+ exports.DbClientMetrics = DbClientMetrics;
164
+ //# sourceMappingURL=db-client-metrics.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"db-client-metrics.js","sourceRoot":"","sources":["../../src/metrics/db-client-metrics.ts"],"names":[],"mappings":";;;AAGA,mEAA+D;AAE/D,mEAA8D;AAC9D,6DAA6D;AAC7D,mFAA+E;AAC/E,+EAA2E;AAG3E,uCAAiD;AAEjD,6CAAyD;AACzD,+DAA0D;AAI1D;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,eAAe;IAEP;IACA;IACA;IAHnB,YACmB,OAAe,EACf,cAA8C,EAC9C,OAA6B;QAF7B,YAAO,GAAP,OAAO,CAAQ;QACf,mBAAc,GAAd,cAAc,CAAgC;QAC9C,YAAO,GAAP,OAAO,CAAsB;IAC7C,CAAC;IAEJ;;;;;;;;;;OAUG;IACH,MAAM,CAAC,MAAM,CAAC,MAAuB,EAAE,OAAe;QACpD,yEAAyE;QACzE,yEAAyE;QACzE,+CAA+C;QAC/C,MAAM,OAAO,GAAG,IAAA,8BAAoB,GAAE,CAAC;QACvC,MAAM,YAAY,GAAG,IAAI,wCAAkB,CAAC;YAC1C,KAAK,EAAE,OAAO,CAAC,YAAY;YAC3B,QAAQ,EAAE,OAAO,CAAC,mBAAmB;YACrC,MAAM,EAAE,OAAO,CAAC,kBAAkB;SACnC,CAAC,CAAC;QACH,MAAM,OAAO,GAAG,IAAI,4CAAoB,CACtC;YACE,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,MAAM,EAAE,OAAO,CAAC,aAAa;YAC7B,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,MAAM,EAAE,OAAO,CAAC,MAAM;SACvB,EACD,YAAY,EACZ,MAAM,CAAC,kBAAkB,CAAC,MAAM,EAAE,CACnC,CAAC;QACF,MAAM,WAAW,GAAG;YAClB,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,eAAe,EAAE,OAAO,CAAC,eAAe;YACxC,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,MAAM,EAAE,OAAO,CAAC,UAAU;YAC1B,UAAU,EAAE,CAAC,OAAO,CAAC,aAAa,EAAE,OAAO,CAAC,kBAAkB,CAAC;SAChE,CAAC;QACF,MAAM,cAAc,GAAG,CAAC,IAAY,EAAgB,EAAE,CACpD,IAAI,4BAAY,CAAC,IAAI,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;QAEpD,OAAO,IAAI,eAAe,CAAC,OAAO,EAAE,cAAc,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAuCG;IACH,cAAc,CACZ,IAAgB,EAChB,IAAa,EACb,QAAgB,EAChB,MAA6B,EAC7B,OAAuC;QAEvC,OAAO,IAAI,CAAC,cAAc,CACxB,IAAA,2BAAW,EAAC,IAAI,CAAC,EACjB,IAAI,EACJ,IAAI,EACJ,EAAE,OAAO,EAAE,IAAI,CAAC,OAAO,EAAE,QAAQ,EAAE,EACnC,MAAM,EACN,OAAO,CAAC,iBAAiB,CAC1B,CAAC;IACJ,CAAC;IAEO,cAAc,CACpB,OAA2B,EAC3B,IAAgB,EAChB,IAAa,EACb,KAAgB,EAChB,MAA6B,EAC7B,WAAoB;QAEpB,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;YAC1B,MAAM,CAAC,IAAI,CACT,sCAAsC,IAAA,2BAAc,EAAC,KAAK,CAAC,gBAAgB,IAAI,OAAO,CACvF,CAAC;YACF,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,MAAM,OAAO,GAAG,sBAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAEvC,mEAAmE;QACnE,wDAAwD;QACxD,MAAM,KAAK,GAAa,EAAE,CAAC;QAE3B,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAEnD,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC;YAEpC,MAAM,mBAAmB,GAAG,CAAC,UAAkB,EAAQ,EAAE;gBACvD,QAAQ,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC;gBACvC,IAAI,WAAW,EAAE,CAAC;oBAChB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;gBAChD,CAAC;YACH,CAAC,CAAC;YAEF,qEAAqE;YACrE,0DAA0D;YAC1D,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,QAAQ,EAAE,mBAAmB,CAAC,CAAC,CAAC;YAChE,KAAK,MAAM,UAAU,IAAI,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;gBACvD,mBAAmB,CAAC,UAAU,CAAC,CAAC;YAClC,CAAC;YAED,KAAK,CAAC,IAAI,CACR,uCAAiB,CAAC,GAAG,CAAC;gBACpB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,KAAK,EAAE,GAAG,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;aACjC,CAAC,CACH,CAAC;YAEF,OAAO,IAAA,0BAAa,EAAC,IAAI,EAAE,OAAO,CAAC,WAAW,EAAE;gBAC9C,GAAG,KAAK;gBACR,OAAO,CAAC,OAAO;aAChB,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;gBACzB,IAAI,EAAE,CAAC;YACT,CAAC;YACD,OAAO,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,KAAK,CAAC;QACd,CAAC;IACH,CAAC;CACF;AAzKD,0CAyKC"}
@@ -0,0 +1,41 @@
1
+ import type { Constructor } from '@rsdk/common';
2
+ import type { AnyMetric } from '@rsdk/core';
3
+ import { Counter, Gauge, Histogram } from '@rsdk/core';
4
+ /**
5
+ * Обёртка над `@Metric`, которая дополнительно запоминает тип и конфигурацию
6
+ * метрики. Она нужна, чтобы создавать метрики без `MetricsModule.forFeature`
7
+ * (см. {@link resolveDbMetric}).
8
+ *
9
+ * Границы bucket'ов гистограммы принимаются как `readonly number[]`, чтобы
10
+ * общие константы границ можно было объявить неизменяемыми. prom-client
11
+ * получает их копию (см. {@link resolveDbMetric}).
12
+ *
13
+ * Типы конфигурации записаны в перегрузках целиком, а не через внутренние
14
+ * псевдонимы: сигнатура входит в `plugin-kit` и не должна ссылаться на
15
+ * неэкспортированные типы
16
+ */
17
+ export declare function DbMetric(type: 'counter', config: ConstructorParameters<typeof Counter<string>>[0] & {
18
+ description?: string;
19
+ }): ClassDecorator;
20
+ export declare function DbMetric(type: 'gauge', config: ConstructorParameters<typeof Gauge<string>>[0] & {
21
+ description?: string;
22
+ }): ClassDecorator;
23
+ export declare function DbMetric(type: 'histogram', config: Omit<ConstructorParameters<typeof Histogram<string>>[0], 'buckets'> & {
24
+ buckets?: readonly number[];
25
+ description?: string;
26
+ }): ClassDecorator;
27
+ /**
28
+ * Метрика на весь процесс. `MetricsModule.forFeature` создаёт метрику заново
29
+ * для каждого экземпляра приложения, и prom-client падает на повторной
30
+ * регистрации имени. Для метрик, которые плагин подключает сам, это недопустимо:
31
+ * тесты сервисов поднимают приложение много раз в одном процессе.
32
+ *
33
+ * Новая метрика получает свою копию границ bucket'ов.
34
+ *
35
+ * Если метрика с этим именем уже есть в общем реестре, берётся она, но только
36
+ * когда совпадают тип и набор `labelNames`. Иначе бросается ошибка с именем
37
+ * метрики: чужая метрика другого типа сломалась бы позже и непонятно где.
38
+ * Если у существующей гистограммы другие границы bucket'ов, ошибки нет:
39
+ * остаются её границы, а в лог пишется warning с именем метрики
40
+ */
41
+ export declare const resolveDbMetric: <T extends AnyMetric>(ctor: Constructor<T>) => T;
@@ -0,0 +1,99 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.resolveDbMetric = void 0;
4
+ exports.DbMetric = DbMetric;
5
+ const core_1 = require("@rsdk/core");
6
+ const logging_1 = require("@rsdk/logging");
7
+ const BASE_CLASSES = {
8
+ counter: core_1.Counter,
9
+ gauge: core_1.Gauge,
10
+ histogram: core_1.Histogram,
11
+ };
12
+ const definitions = new Map();
13
+ function DbMetric(type, config) {
14
+ return (target) => {
15
+ definitions.set(target, { type, config });
16
+ (0, core_1.Metric)(type, config)(target);
17
+ };
18
+ }
19
+ /**
20
+ * Конфиг для конструктора метрики prom-client. prom-client не копирует
21
+ * `buckets` и хранит переданный массив как `upperBounds`: без копии две
22
+ * гистограммы с одной константой границ делили бы один массив между собой
23
+ * и с константой
24
+ */
25
+ const metricConfig = (config) => {
26
+ const { buckets } = config;
27
+ return buckets ? { ...config, buckets: [...buckets] } : config;
28
+ };
29
+ const typeOf = (metric) => {
30
+ if (metric instanceof core_1.Counter)
31
+ return 'counter';
32
+ if (metric instanceof core_1.Gauge)
33
+ return 'gauge';
34
+ if (metric instanceof core_1.Histogram)
35
+ return 'histogram';
36
+ if (metric instanceof core_1.Summary)
37
+ return 'summary';
38
+ return metric.constructor.name;
39
+ };
40
+ const sortedLabels = (labels) => [...(labels ?? [])].sort();
41
+ const sameItems = (a, b) => a.length === b.length && a.every((item, i) => item === b[i]);
42
+ /**
43
+ * Предупреждает, если у уже зарегистрированной гистограммы другие границы
44
+ * bucket'ов. Границы задаёт тот, кто зарегистрировал метрику первым,
45
+ * поменять их при общем реестре нельзя
46
+ */
47
+ const warnOnForeignBuckets = (existing, config) => {
48
+ const expected = config.buckets;
49
+ const actual = existing.upperBounds;
50
+ if (!expected || !actual) {
51
+ return;
52
+ }
53
+ if (sameItems(actual, expected)) {
54
+ return;
55
+ }
56
+ logging_1.LoggerFactory.create('DbMetrics').warn(`Metric "${config.name}" is already registered with buckets ` +
57
+ `[${actual.join(', ')}], expected [${expected.join(', ')}]; ` +
58
+ `the registered buckets are used`);
59
+ };
60
+ /**
61
+ * Метрика на весь процесс. `MetricsModule.forFeature` создаёт метрику заново
62
+ * для каждого экземпляра приложения, и prom-client падает на повторной
63
+ * регистрации имени. Для метрик, которые плагин подключает сам, это недопустимо:
64
+ * тесты сервисов поднимают приложение много раз в одном процессе.
65
+ *
66
+ * Новая метрика получает свою копию границ bucket'ов.
67
+ *
68
+ * Если метрика с этим именем уже есть в общем реестре, берётся она, но только
69
+ * когда совпадают тип и набор `labelNames`. Иначе бросается ошибка с именем
70
+ * метрики: чужая метрика другого типа сломалась бы позже и непонятно где.
71
+ * Если у существующей гистограммы другие границы bucket'ов, ошибки нет:
72
+ * остаются её границы, а в лог пишется warning с именем метрики
73
+ */
74
+ const resolveDbMetric = (ctor) => {
75
+ const definition = definitions.get(ctor);
76
+ if (!definition) {
77
+ throw new Error(`${ctor.name} is not a database metric`);
78
+ }
79
+ const { type, config } = definition;
80
+ const existing = core_1.register.getSingleMetric(config.name);
81
+ if (!existing) {
82
+ return new ctor(metricConfig(config));
83
+ }
84
+ const expectedLabels = sortedLabels(config.labelNames);
85
+ const existingLabels = sortedLabels(existing.labelNames);
86
+ if (!(existing instanceof BASE_CLASSES[type]) ||
87
+ !sameItems(existingLabels, expectedLabels)) {
88
+ throw new Error(`Metric "${config.name}" is already registered as ${typeOf(existing)} ` +
89
+ `with labels [${existingLabels.join(', ')}], ` +
90
+ `expected ${type} with labels [${expectedLabels.join(', ')}]`);
91
+ }
92
+ if (type === 'histogram') {
93
+ warnOnForeignBuckets(existing, config);
94
+ }
95
+ // Тип и метки проверены выше: это метрика того же вида, что создал бы ctor
96
+ return existing;
97
+ };
98
+ exports.resolveDbMetric = resolveDbMetric;
99
+ //# sourceMappingURL=db-metric.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"db-metric.js","sourceRoot":"","sources":["../../src/metrics/db-metric.ts"],"names":[],"mappings":";;;AAyEA,4BAKC;AA5ED,qCAOoB;AACpB,2CAA8C;AAoB9C,MAAM,YAAY,GAAmC;IACnD,OAAO,EAAE,cAAO;IAChB,KAAK,EAAE,YAAK;IACZ,SAAS,EAAE,gBAAS;CACrB,CAAC;AAEF,MAAM,WAAW,GAAG,IAAI,GAAG,EAAgC,CAAC;AAqC5D,SAAgB,QAAQ,CAAC,IAAS,EAAE,MAAW;IAC7C,OAAO,CAAC,MAAM,EAAE,EAAE;QAChB,WAAW,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC;QAC1C,IAAA,aAAM,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,YAAY,GAAG,CACnB,MAAoC,EACN,EAAE;IAChC,MAAM,EAAE,OAAO,EAAE,GAAG,MAAyB,CAAC;IAE9C,OAAO,OAAO,CAAC,CAAC,CAAC,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC;AACjE,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,MAAiB,EAAU,EAAE;IAC3C,IAAI,MAAM,YAAY,cAAO;QAAE,OAAO,SAAS,CAAC;IAChD,IAAI,MAAM,YAAY,YAAK;QAAE,OAAO,OAAO,CAAC;IAC5C,IAAI,MAAM,YAAY,gBAAS;QAAE,OAAO,WAAW,CAAC;IACpD,IAAI,MAAM,YAAY,cAAO;QAAE,OAAO,SAAS,CAAC;IAEhD,OAAQ,MAAiB,CAAC,WAAW,CAAC,IAAI,CAAC;AAC7C,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAC,MAAqC,EAAY,EAAE,CACvE,CAAC,GAAG,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;AAE7B,MAAM,SAAS,GAAG,CAAI,CAAe,EAAE,CAAe,EAAW,EAAE,CACjE,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAE/D;;;;GAIG;AACH,MAAM,oBAAoB,GAAG,CAC3B,QAAmB,EACnB,MAAoC,EAC9B,EAAE;IACR,MAAM,QAAQ,GAAI,MAA0B,CAAC,OAAO,CAAC;IACrD,MAAM,MAAM,GAAI,QAAgD,CAAC,WAAW,CAAC;IAC7E,IAAI,CAAC,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IAED,IAAI,SAAS,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC;QAChC,OAAO;IACT,CAAC;IAED,uBAAa,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,IAAI,CACpC,WAAW,MAAM,CAAC,IAAI,uCAAuC;QAC3D,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK;QAC7D,iCAAiC,CACpC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACI,MAAM,eAAe,GAAG,CAC7B,IAAoB,EACjB,EAAE;IACL,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IACzC,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,IAAI,2BAA2B,CAAC,CAAC;IAC3D,CAAC;IAED,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC;IACpC,MAAM,QAAQ,GAAG,eAAQ,CAAC,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACvD,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC;IACxC,CAAC;IAED,MAAM,cAAc,GAAG,YAAY,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;IACvD,MAAM,cAAc,GAAG,YAAY,CAChC,QAA+C,CAAC,UAAU,CAC5D,CAAC;IAEF,IACE,CAAC,CAAC,QAAQ,YAAY,YAAY,CAAC,IAAI,CAAC,CAAC;QACzC,CAAC,SAAS,CAAC,cAAc,EAAE,cAAc,CAAC,EAC1C,CAAC;QACD,MAAM,IAAI,KAAK,CACb,WAAW,MAAM,CAAC,IAAI,8BAA8B,MAAM,CAAC,QAAQ,CAAC,GAAG;YACrE,gBAAgB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK;YAC9C,YAAY,IAAI,iBAAiB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAChE,CAAC;IACJ,CAAC;IAED,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;QACzB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,2EAA2E;IAC3E,OAAO,QAAa,CAAC;AACvB,CAAC,CAAC;AApCW,QAAA,eAAe,mBAoC1B"}
@@ -0,0 +1,7 @@
1
+ import { Timespan } from '@rsdk/common';
2
+ import { Config } from '@rsdk/core';
3
+ export declare class DbMetricsConfig extends Config {
4
+ isEnabled: boolean;
5
+ slowQueryThreshold: Timespan;
6
+ ormEntityOperationsTotalEnabled: boolean;
7
+ }