@rsdk/db 5.15.0-next.9 → 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/index.d.ts +1 -0
- package/dist/index.js +15 -0
- package/dist/index.js.map +1 -1
- package/dist/metrics/call-then.d.ts +30 -0
- package/dist/metrics/call-then.js +91 -0
- package/dist/metrics/call-then.js.map +1 -0
- package/dist/metrics/clock.d.ts +2 -0
- package/dist/metrics/clock.js +9 -0
- package/dist/metrics/clock.js.map +1 -0
- package/dist/metrics/db-client-metrics.d.ts +85 -0
- package/dist/metrics/db-client-metrics.js +164 -0
- package/dist/metrics/db-client-metrics.js.map +1 -0
- package/dist/metrics/db-metric.d.ts +41 -0
- package/dist/metrics/db-metric.js +99 -0
- package/dist/metrics/db-metric.js.map +1 -0
- package/dist/metrics/db-metrics.config.d.ts +7 -0
- package/dist/metrics/db-metrics.config.js +60 -0
- package/dist/metrics/db-metrics.config.js.map +1 -0
- package/dist/metrics/db-metrics.module-base.d.ts +61 -0
- package/dist/metrics/db-metrics.module-base.js +61 -0
- package/dist/metrics/db-metrics.module-base.js.map +1 -0
- package/dist/metrics/db-metrics.providers.d.ts +66 -0
- package/dist/metrics/db-metrics.providers.js +83 -0
- package/dist/metrics/db-metrics.providers.js.map +1 -0
- package/dist/metrics/detach-group.d.ts +19 -0
- package/dist/metrics/detach-group.js +31 -0
- package/dist/metrics/detach-group.js.map +1 -0
- package/dist/metrics/detach.d.ts +24 -0
- package/dist/metrics/detach.js +45 -0
- package/dist/metrics/detach.js.map +1 -0
- package/dist/metrics/entity-operations.recorder.d.ts +17 -0
- package/dist/metrics/entity-operations.recorder.js +28 -0
- package/dist/metrics/entity-operations.recorder.js.map +1 -0
- package/dist/metrics/events.d.ts +11 -0
- package/dist/metrics/events.js +20 -0
- package/dist/metrics/events.js.map +1 -0
- package/dist/metrics/guards.d.ts +12 -0
- package/dist/metrics/guards.js +19 -0
- package/dist/metrics/guards.js.map +1 -0
- package/dist/metrics/index.d.ts +1 -0
- package/dist/metrics/index.js +11 -0
- package/dist/metrics/index.js.map +1 -0
- package/dist/metrics/instrumentation/pg-pool.instrumentation.d.ts +48 -0
- package/dist/metrics/instrumentation/pg-pool.instrumentation.js +117 -0
- package/dist/metrics/instrumentation/pg-pool.instrumentation.js.map +1 -0
- package/dist/metrics/instrumentation/pool-adapters.d.ts +22 -0
- package/dist/metrics/instrumentation/pool-adapters.js +16 -0
- package/dist/metrics/instrumentation/pool-adapters.js.map +1 -0
- package/dist/metrics/instrumentation/pool-close.d.ts +10 -0
- package/dist/metrics/instrumentation/pool-close.js +43 -0
- package/dist/metrics/instrumentation/pool-close.js.map +1 -0
- package/dist/metrics/instrumentation/pool-scope.d.ts +13 -0
- package/dist/metrics/instrumentation/pool-scope.js +3 -0
- package/dist/metrics/instrumentation/pool-scope.js.map +1 -0
- package/dist/metrics/instrumentation/pool.adapter.d.ts +50 -0
- package/dist/metrics/instrumentation/pool.adapter.js +3 -0
- package/dist/metrics/instrumentation/pool.adapter.js.map +1 -0
- package/dist/metrics/instrumentation/pool.recorder.d.ts +74 -0
- package/dist/metrics/instrumentation/pool.recorder.js +125 -0
- package/dist/metrics/instrumentation/pool.recorder.js.map +1 -0
- package/dist/metrics/instrumentation/query-completion.d.ts +12 -0
- package/dist/metrics/instrumentation/query-completion.js +76 -0
- package/dist/metrics/instrumentation/query-completion.js.map +1 -0
- package/dist/metrics/instrumentation/query.instrumentation.d.ts +35 -0
- package/dist/metrics/instrumentation/query.instrumentation.js +85 -0
- package/dist/metrics/instrumentation/query.instrumentation.js.map +1 -0
- package/dist/metrics/instrumentation/tarn-pool.instrumentation.d.ts +44 -0
- package/dist/metrics/instrumentation/tarn-pool.instrumentation.js +95 -0
- package/dist/metrics/instrumentation/tarn-pool.instrumentation.js.map +1 -0
- package/dist/metrics/instrumentation/transaction-tracker.d.ts +32 -0
- package/dist/metrics/instrumentation/transaction-tracker.js +64 -0
- package/dist/metrics/instrumentation/transaction-tracker.js.map +1 -0
- package/dist/metrics/metric-types.d.ts +17 -0
- package/dist/metrics/metric-types.js +3 -0
- package/dist/metrics/metric-types.js.map +1 -0
- package/dist/metrics/metrics.d.ts +82 -0
- package/dist/metrics/metrics.js +269 -0
- package/dist/metrics/metrics.js.map +1 -0
- package/dist/metrics/plugin-kit.d.ts +12 -0
- package/dist/metrics/plugin-kit.js +42 -0
- package/dist/metrics/plugin-kit.js.map +1 -0
- package/dist/metrics/pool-names.d.ts +47 -0
- package/dist/metrics/pool-names.js +44 -0
- package/dist/metrics/pool-names.js.map +1 -0
- package/dist/metrics/pool-stats.registry.d.ts +25 -0
- package/dist/metrics/pool-stats.registry.js +32 -0
- package/dist/metrics/pool-stats.registry.js.map +1 -0
- package/dist/metrics/scrape-source.registry.d.ts +29 -0
- package/dist/metrics/scrape-source.registry.js +55 -0
- package/dist/metrics/scrape-source.registry.js.map +1 -0
- package/dist/metrics/sql.d.ts +34 -0
- package/dist/metrics/sql.js +132 -0
- package/dist/metrics/sql.js.map +1 -0
- package/package.json +2 -2
- package/src/index.ts +1 -0
- package/src/metrics/call-then.ts +134 -0
- package/src/metrics/clock.ts +5 -0
- package/src/metrics/db-client-metrics.spec.ts +1894 -0
- package/src/metrics/db-client-metrics.ts +206 -0
- package/src/metrics/db-metric.spec.ts +185 -0
- package/src/metrics/db-metric.ts +186 -0
- package/src/metrics/db-metrics.config.ts +46 -0
- package/src/metrics/db-metrics.module-base.spec.ts +91 -0
- package/src/metrics/db-metrics.module-base.ts +77 -0
- package/src/metrics/db-metrics.providers.spec.ts +182 -0
- package/src/metrics/db-metrics.providers.ts +134 -0
- package/src/metrics/detach-group.spec.ts +41 -0
- package/src/metrics/detach-group.ts +30 -0
- package/src/metrics/detach.spec.ts +61 -0
- package/src/metrics/detach.ts +57 -0
- package/src/metrics/entity-operations.recorder.ts +26 -0
- package/src/metrics/events.spec.ts +19 -0
- package/src/metrics/events.ts +28 -0
- package/src/metrics/guards.spec.ts +20 -0
- package/src/metrics/guards.ts +19 -0
- package/src/metrics/index.ts +6 -0
- package/src/metrics/instrumentation/pg-pool.instrumentation.ts +177 -0
- package/src/metrics/instrumentation/pool-adapters.ts +35 -0
- package/src/metrics/instrumentation/pool-close.ts +59 -0
- package/src/metrics/instrumentation/pool-guards.spec.ts +318 -0
- package/src/metrics/instrumentation/pool-scope.ts +14 -0
- package/src/metrics/instrumentation/pool.adapter.ts +67 -0
- package/src/metrics/instrumentation/pool.recorder.ts +167 -0
- package/src/metrics/instrumentation/query-completion.spec.ts +209 -0
- package/src/metrics/instrumentation/query-completion.ts +107 -0
- package/src/metrics/instrumentation/query.instrumentation.ts +136 -0
- package/src/metrics/instrumentation/tarn-pool.instrumentation.ts +138 -0
- package/src/metrics/instrumentation/transaction-tracker.ts +103 -0
- package/src/metrics/metric-types.ts +36 -0
- package/src/metrics/metrics.ts +233 -0
- package/src/metrics/plugin-kit.ts +39 -0
- package/src/metrics/pool-names.spec.ts +79 -0
- package/src/metrics/pool-names.ts +77 -0
- package/src/metrics/pool-stats.registry.spec.ts +81 -0
- package/src/metrics/pool-stats.registry.ts +54 -0
- package/src/metrics/public-api.spec.ts +104 -0
- package/src/metrics/scrape-source.registry.spec.ts +59 -0
- package/src/metrics/scrape-source.registry.ts +55 -0
- package/src/metrics/sql.spec.ts +110 -0
- package/src/metrics/sql.ts +172 -0
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
import { spawnSync } from 'node:child_process';
|
|
2
|
+
|
|
3
|
+
import { callWithCompletion } from './query-completion';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Сценарии для отдельного процесса node. В jest `process` — копия для
|
|
7
|
+
* песочницы, настоящий `unhandledRejection` до неё не доходит, поэтому
|
|
8
|
+
* необработанный reject проверяем в отдельном процессе: там всё как
|
|
9
|
+
* в приложении.
|
|
10
|
+
*
|
|
11
|
+
* Каждый сценарий делает promise-запрос без инструментирования (`plain`)
|
|
12
|
+
* или через `callWithCompletion` (`instrumented`), а вызывающий результат
|
|
13
|
+
* не обрабатывает (`ignore`), ждёт через `await` (`await`) или вешает
|
|
14
|
+
* `catch` (`catch`). Процесс печатает JSON: какие ошибки пришли
|
|
15
|
+
* в `unhandledRejection` и с чем вызван `complete`
|
|
16
|
+
*/
|
|
17
|
+
const CHILD_SCRIPT = `
|
|
18
|
+
const { callWithCompletion } = require(${JSON.stringify(require.resolve('./query-completion'))});
|
|
19
|
+
const settle = () => new Promise((resolve) => setTimeout(resolve, 20));
|
|
20
|
+
const results = {};
|
|
21
|
+
let current;
|
|
22
|
+
|
|
23
|
+
process.on('unhandledRejection', (reason) => {
|
|
24
|
+
results[current].unhandled.push(reason.message);
|
|
25
|
+
});
|
|
26
|
+
|
|
27
|
+
(async () => {
|
|
28
|
+
for (const variant of ['plain', 'instrumented']) {
|
|
29
|
+
for (const handling of ['ignore', 'await', 'catch']) {
|
|
30
|
+
current = variant + ':' + handling;
|
|
31
|
+
const entry = (results[current] = { unhandled: [], caught: [], completed: [] });
|
|
32
|
+
const error = new Error(current);
|
|
33
|
+
const query = () => Promise.reject(error);
|
|
34
|
+
const complete = (e) => entry.completed.push(e === error ? 'same error' : String(e));
|
|
35
|
+
const result =
|
|
36
|
+
variant === 'plain'
|
|
37
|
+
? query('SELECT 1')
|
|
38
|
+
: callWithCompletion(query, undefined, ['SELECT 1'], complete);
|
|
39
|
+
|
|
40
|
+
if (handling === 'await') {
|
|
41
|
+
try {
|
|
42
|
+
await result;
|
|
43
|
+
} catch (e) {
|
|
44
|
+
entry.caught.push(e === error ? 'same error' : String(e));
|
|
45
|
+
}
|
|
46
|
+
} else if (handling === 'catch') {
|
|
47
|
+
result.catch((e) => entry.caught.push(e === error ? 'same error' : String(e)));
|
|
48
|
+
}
|
|
49
|
+
|
|
50
|
+
await settle();
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
process.stdout.write(JSON.stringify(results));
|
|
55
|
+
})();
|
|
56
|
+
`;
|
|
57
|
+
|
|
58
|
+
interface ScenarioResult {
|
|
59
|
+
unhandled: string[];
|
|
60
|
+
caught: string[];
|
|
61
|
+
completed: string[];
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
const runScenarios = (): Record<string, ScenarioResult> => {
|
|
65
|
+
const child = spawnSync(
|
|
66
|
+
process.execPath,
|
|
67
|
+
['-r', 'ts-node/register/transpile-only', '-e', CHILD_SCRIPT],
|
|
68
|
+
{ cwd: __dirname, encoding: 'utf8', timeout: 30_000 },
|
|
69
|
+
);
|
|
70
|
+
|
|
71
|
+
if (child.status !== 0) {
|
|
72
|
+
throw new Error(`Процесс со сценариями упал: ${child.stderr}`);
|
|
73
|
+
}
|
|
74
|
+
|
|
75
|
+
return JSON.parse(child.stdout) as Record<string, ScenarioResult>;
|
|
76
|
+
};
|
|
77
|
+
|
|
78
|
+
describe('callWithCompletion: promise query', () => {
|
|
79
|
+
describe('rejection: the process sees the same with and without instrumentation', () => {
|
|
80
|
+
let results: Record<string, ScenarioResult>;
|
|
81
|
+
|
|
82
|
+
beforeAll(() => {
|
|
83
|
+
results = runScenarios();
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it('caller without a handler — unhandledRejection with the same error', () => {
|
|
87
|
+
expect(results['plain:ignore']).toEqual({
|
|
88
|
+
unhandled: ['plain:ignore'],
|
|
89
|
+
caught: [],
|
|
90
|
+
completed: [],
|
|
91
|
+
});
|
|
92
|
+
expect(results['instrumented:ignore']).toEqual({
|
|
93
|
+
unhandled: ['instrumented:ignore'],
|
|
94
|
+
caught: [],
|
|
95
|
+
completed: ['same error'],
|
|
96
|
+
});
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
it.each(['await', 'catch'])(
|
|
100
|
+
'caller handles the rejection via %s — same error, no unhandledRejection',
|
|
101
|
+
(handling) => {
|
|
102
|
+
expect(results[`plain:${handling}`]).toEqual({
|
|
103
|
+
unhandled: [],
|
|
104
|
+
caught: ['same error'],
|
|
105
|
+
completed: [],
|
|
106
|
+
});
|
|
107
|
+
expect(results[`instrumented:${handling}`]).toEqual({
|
|
108
|
+
unhandled: [],
|
|
109
|
+
caught: ['same error'],
|
|
110
|
+
completed: ['same error'],
|
|
111
|
+
});
|
|
112
|
+
},
|
|
113
|
+
);
|
|
114
|
+
});
|
|
115
|
+
|
|
116
|
+
it('successful query — same value, complete gets the response', async () => {
|
|
117
|
+
const response = { rows: [{ x: 1 }], rowCount: 1 };
|
|
118
|
+
const complete = jest.fn();
|
|
119
|
+
|
|
120
|
+
await expect(
|
|
121
|
+
callWithCompletion(
|
|
122
|
+
(): Promise<unknown> => Promise.resolve(response),
|
|
123
|
+
undefined,
|
|
124
|
+
['SELECT 1'],
|
|
125
|
+
complete,
|
|
126
|
+
),
|
|
127
|
+
).resolves.toBe(response);
|
|
128
|
+
|
|
129
|
+
expect(complete).toHaveBeenCalledTimes(1);
|
|
130
|
+
expect(complete).toHaveBeenCalledWith(undefined, response);
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
it('rejection — same error, complete gets it once', async () => {
|
|
134
|
+
const error = new Error('relation does not exist');
|
|
135
|
+
const complete = jest.fn();
|
|
136
|
+
|
|
137
|
+
await expect(
|
|
138
|
+
callWithCompletion(
|
|
139
|
+
(): Promise<unknown> => Promise.reject(error),
|
|
140
|
+
undefined,
|
|
141
|
+
['SELECT 1'],
|
|
142
|
+
complete,
|
|
143
|
+
),
|
|
144
|
+
).rejects.toBe(error);
|
|
145
|
+
|
|
146
|
+
expect(complete).toHaveBeenCalledTimes(1);
|
|
147
|
+
expect(complete).toHaveBeenCalledWith(error);
|
|
148
|
+
});
|
|
149
|
+
|
|
150
|
+
it('wraps a thenable without catch in a Promise with the same value', async () => {
|
|
151
|
+
interface Bare {
|
|
152
|
+
then(onFulfilled?: (value: unknown) => unknown): Bare;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
// `then` возвращает голый thenable без `catch` и `finally`
|
|
156
|
+
const bare = (value: unknown): Bare => ({
|
|
157
|
+
// eslint-disable-next-line unicorn/no-thenable -- тест как раз про thenable, который не Promise
|
|
158
|
+
then: (onFulfilled) => bare(onFulfilled ? onFulfilled(value) : value),
|
|
159
|
+
});
|
|
160
|
+
const response = { rows: [] };
|
|
161
|
+
const complete = jest.fn();
|
|
162
|
+
|
|
163
|
+
const result = callWithCompletion(
|
|
164
|
+
(): Bare => bare(response),
|
|
165
|
+
undefined,
|
|
166
|
+
['SELECT 1'],
|
|
167
|
+
complete,
|
|
168
|
+
) as Promise<unknown>;
|
|
169
|
+
|
|
170
|
+
expect(typeof result.catch).toBe('function');
|
|
171
|
+
expect(typeof result.finally).toBe('function');
|
|
172
|
+
await expect(result).resolves.toBe(response);
|
|
173
|
+
expect(complete).toHaveBeenCalledWith(undefined, response);
|
|
174
|
+
});
|
|
175
|
+
});
|
|
176
|
+
|
|
177
|
+
const failingComplete = (): never => {
|
|
178
|
+
throw new Error('metrics failed');
|
|
179
|
+
};
|
|
180
|
+
|
|
181
|
+
describe('callWithCompletion: metrics failure', () => {
|
|
182
|
+
it('promise query gets the driver outcome, not the metrics error', async () => {
|
|
183
|
+
const response = { rows: [] };
|
|
184
|
+
|
|
185
|
+
await expect(
|
|
186
|
+
callWithCompletion(
|
|
187
|
+
async () => response,
|
|
188
|
+
undefined,
|
|
189
|
+
['SELECT 1'],
|
|
190
|
+
failingComplete,
|
|
191
|
+
),
|
|
192
|
+
).resolves.toBe(response);
|
|
193
|
+
});
|
|
194
|
+
|
|
195
|
+
it("calls the caller's callback", () => {
|
|
196
|
+
const callback = jest.fn();
|
|
197
|
+
const response = { rows: [] };
|
|
198
|
+
|
|
199
|
+
callWithCompletion(
|
|
200
|
+
(_sql: string, cb: (error: unknown, result: unknown) => void) =>
|
|
201
|
+
cb(undefined, response),
|
|
202
|
+
undefined,
|
|
203
|
+
['SELECT 1', callback],
|
|
204
|
+
failingComplete,
|
|
205
|
+
);
|
|
206
|
+
|
|
207
|
+
expect(callback).toHaveBeenCalledWith(undefined, response);
|
|
208
|
+
});
|
|
209
|
+
});
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { errorMonitor } from 'node:events';
|
|
2
|
+
|
|
3
|
+
import type { CallDone } from '../call-then';
|
|
4
|
+
import { callThen } from '../call-then';
|
|
5
|
+
import { noop, replaceMethod } from '../detach';
|
|
6
|
+
import type { EventSource, Listener } from '../events';
|
|
7
|
+
import { isEventSource, isObject } from '../guards';
|
|
8
|
+
|
|
9
|
+
export type QueryCompletion = CallDone;
|
|
10
|
+
|
|
11
|
+
/**
|
|
12
|
+
* Поток закрыл тот, кто его читал (`break` из `for await`, `destroy()`
|
|
13
|
+
* через AbortSignal). Запрос при этом не падал
|
|
14
|
+
*/
|
|
15
|
+
const isAbort = (error: unknown): boolean =>
|
|
16
|
+
isObject(error) &&
|
|
17
|
+
(error.code === 'ABORT_ERR' || error.name === 'AbortError');
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Submittable-объект `pg` (QueryStream, Cursor): `pg` сообщает ему об ошибке
|
|
21
|
+
* запроса через `handleError`, а сам объект сообщает потребителю событиями
|
|
22
|
+
*/
|
|
23
|
+
interface Submittable extends EventSource {
|
|
24
|
+
handleError?: Listener;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/**
|
|
28
|
+
* Ждёт завершения submittable-запроса, не меняя его поведение.
|
|
29
|
+
*
|
|
30
|
+
* Обычный обработчик `error` здесь не годится: при любом обработчике
|
|
31
|
+
* `emit('error')` перестаёт бросать исключение, и ошибка потока без
|
|
32
|
+
* обработчика у потребителя молча пропадает. А Cursor эмитит `error`, только
|
|
33
|
+
* если на него кто-то подписан. Поэтому ошибки потока слушаются через
|
|
34
|
+
* `errorMonitor` — он не считается обработчиком, — а ошибки запроса
|
|
35
|
+
* перехватываются в `handleError`: Cursor без подписчиков не сообщает о них
|
|
36
|
+
* ни `error`, ни `end`.
|
|
37
|
+
*
|
|
38
|
+
* `close` без `end` и без ошибки — поток закрыли через `destroy()`.
|
|
39
|
+
*
|
|
40
|
+
* Подмену `handleError` снимает {@link replaceMethod} при завершении
|
|
41
|
+
* запроса
|
|
42
|
+
*/
|
|
43
|
+
const watchSubmittable = (
|
|
44
|
+
query: Submittable,
|
|
45
|
+
complete: QueryCompletion,
|
|
46
|
+
): void => {
|
|
47
|
+
const originalHandleError = query.handleError;
|
|
48
|
+
let restoreHandleError = noop;
|
|
49
|
+
let finished = false;
|
|
50
|
+
|
|
51
|
+
const finish = (error?: unknown): void => {
|
|
52
|
+
if (finished) {
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
finished = true;
|
|
57
|
+
query.removeListener('end', onEnd);
|
|
58
|
+
query.removeListener('close', onEnd);
|
|
59
|
+
query.removeListener(errorMonitor, finish);
|
|
60
|
+
restoreHandleError();
|
|
61
|
+
|
|
62
|
+
complete(isAbort(error) ? undefined : error);
|
|
63
|
+
};
|
|
64
|
+
const onEnd = (): void => finish();
|
|
65
|
+
|
|
66
|
+
query.on('end', onEnd);
|
|
67
|
+
query.on('close', onEnd);
|
|
68
|
+
query.on(errorMonitor, finish);
|
|
69
|
+
|
|
70
|
+
if (typeof originalHandleError === 'function') {
|
|
71
|
+
restoreHandleError = replaceMethod(
|
|
72
|
+
query,
|
|
73
|
+
'handleError',
|
|
74
|
+
function (this: unknown, ...args: unknown[]): unknown {
|
|
75
|
+
finish(args[0]);
|
|
76
|
+
return originalHandleError.apply(this, args);
|
|
77
|
+
},
|
|
78
|
+
);
|
|
79
|
+
}
|
|
80
|
+
};
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* Вызывает `query` драйвера и сообщает о завершении запроса, не меняя
|
|
84
|
+
* поведение вызова. Драйверы `pg` завершают запрос тремя способами:
|
|
85
|
+
* callback последним аргументом, promise или submittable-объект
|
|
86
|
+
* (QueryStream, Cursor), который живёт, пока читают поток.
|
|
87
|
+
*
|
|
88
|
+
* Callback и promise обрабатывает {@link callThen}, здесь добавлено только
|
|
89
|
+
* ожидание submittable: см. {@link watchSubmittable}
|
|
90
|
+
*/
|
|
91
|
+
export const callWithCompletion = (
|
|
92
|
+
query: (...args: any[]) => any,
|
|
93
|
+
thisArg: unknown,
|
|
94
|
+
args: unknown[],
|
|
95
|
+
complete: QueryCompletion,
|
|
96
|
+
): unknown =>
|
|
97
|
+
callThen(query, thisArg, args, complete, {
|
|
98
|
+
callbackAt: 'last',
|
|
99
|
+
watchResult: (result, done) => {
|
|
100
|
+
if (result !== args[0] || !isEventSource(result)) {
|
|
101
|
+
return false;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
watchSubmittable(result, done);
|
|
105
|
+
return true;
|
|
106
|
+
},
|
|
107
|
+
});
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import { now, secondsSince } from '../clock';
|
|
2
|
+
import type {
|
|
3
|
+
ActiveGaugeLike,
|
|
4
|
+
CounterLike,
|
|
5
|
+
HistogramLike,
|
|
6
|
+
} from '../metric-types';
|
|
7
|
+
import { classifyQuery, extractSqlState, extractSqlText } from '../sql';
|
|
8
|
+
|
|
9
|
+
import type { PoolScope } from './pool-scope';
|
|
10
|
+
import type { QueryCompletion } from './query-completion';
|
|
11
|
+
import { callWithCompletion } from './query-completion';
|
|
12
|
+
import type { TransactionTracker } from './transaction-tracker';
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Клиент `pg` или `pg-native`: всё, что нужно — метод `query`
|
|
16
|
+
*/
|
|
17
|
+
export interface QueryableClient {
|
|
18
|
+
query(...args: any[]): any;
|
|
19
|
+
}
|
|
20
|
+
|
|
21
|
+
export interface QueryMetrics {
|
|
22
|
+
duration: HistogramLike<'operation' | 'status'>;
|
|
23
|
+
active: ActiveGaugeLike<'pool'>;
|
|
24
|
+
slow: CounterLike<'operation'>;
|
|
25
|
+
errors: CounterLike<'code'>;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
const isQueryableClient = (value: unknown): value is QueryableClient =>
|
|
29
|
+
typeof (value as QueryableClient | null | undefined)?.query === 'function';
|
|
30
|
+
|
|
31
|
+
/**
|
|
32
|
+
* Пул, к которому сейчас относятся запросы обёрнутого клиента. Хранится
|
|
33
|
+
* здесь, а не на самом клиенте: так посторонний код не может прочитать или
|
|
34
|
+
* подменить привязку. Таблица одна на весь модуль, поэтому второй экземпляр
|
|
35
|
+
* {@link QueryInstrumentation} (второе приложение в процессе) тоже видит,
|
|
36
|
+
* что клиент уже обёрнут
|
|
37
|
+
*/
|
|
38
|
+
const scopes = new WeakMap<object, PoolScope>();
|
|
39
|
+
|
|
40
|
+
/**
|
|
41
|
+
* Оборачивает `client.query`: длительность, выполняющиеся запросы, медленные
|
|
42
|
+
* запросы, ошибки по SQLSTATE. Границы транзакций передаёт в {@link TransactionTracker}.
|
|
43
|
+
*
|
|
44
|
+
* После итога по пулу его ряд в `db_client_queries_active` удалён: запросы
|
|
45
|
+
* этого пула его больше не трогают, остальные метрики пишутся
|
|
46
|
+
*/
|
|
47
|
+
export class QueryInstrumentation {
|
|
48
|
+
constructor(
|
|
49
|
+
private readonly metrics: QueryMetrics,
|
|
50
|
+
private readonly transactions: TransactionTracker,
|
|
51
|
+
private readonly slowQueryThresholdMs: number,
|
|
52
|
+
) {}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Соединение без метода `query` пропускается. Повторный вызов не
|
|
56
|
+
* оборачивает клиент ещё раз, а только меняет пул, к которому относятся
|
|
57
|
+
* его запросы
|
|
58
|
+
*/
|
|
59
|
+
instrument(client: object, scope: PoolScope): void {
|
|
60
|
+
if (!isQueryableClient(client)) {
|
|
61
|
+
return;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
const wrapped = scopes.has(client);
|
|
65
|
+
|
|
66
|
+
scopes.set(client, scope);
|
|
67
|
+
if (wrapped) {
|
|
68
|
+
return;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
const originalQuery = client.query;
|
|
72
|
+
// eslint-disable-next-line @typescript-eslint/no-this-alias
|
|
73
|
+
const instrumentation = this;
|
|
74
|
+
|
|
75
|
+
client.query = function (this: unknown, ...args: any[]): any {
|
|
76
|
+
const complete = instrumentation.start(
|
|
77
|
+
client,
|
|
78
|
+
scopes.get(client) ?? scope,
|
|
79
|
+
extractSqlText(args[0]),
|
|
80
|
+
);
|
|
81
|
+
|
|
82
|
+
return callWithCompletion(originalQuery, this, args, complete);
|
|
83
|
+
};
|
|
84
|
+
}
|
|
85
|
+
|
|
86
|
+
private start(
|
|
87
|
+
client: object,
|
|
88
|
+
scope: PoolScope,
|
|
89
|
+
sql: string | undefined,
|
|
90
|
+
): QueryCompletion {
|
|
91
|
+
const { operation, boundary } = classifyQuery(sql);
|
|
92
|
+
const startedAt = now();
|
|
93
|
+
const countedActive = scope.attached;
|
|
94
|
+
let completed = false;
|
|
95
|
+
|
|
96
|
+
if (countedActive) {
|
|
97
|
+
this.metrics.active.inc({ pool: scope.pool });
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
return (error, response) => {
|
|
101
|
+
if (completed) {
|
|
102
|
+
return;
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
completed = true;
|
|
106
|
+
|
|
107
|
+
const seconds = secondsSince(startedAt);
|
|
108
|
+
|
|
109
|
+
if (countedActive && scope.attached) {
|
|
110
|
+
this.metrics.active.dec({ pool: scope.pool });
|
|
111
|
+
}
|
|
112
|
+
this.metrics.duration.observe(
|
|
113
|
+
{ operation, status: error ? 'error' : 'ok' },
|
|
114
|
+
seconds,
|
|
115
|
+
);
|
|
116
|
+
if (seconds * 1000 >= this.slowQueryThresholdMs) {
|
|
117
|
+
this.metrics.slow.inc({ operation });
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
if (error) {
|
|
121
|
+
this.metrics.errors.inc({ code: extractSqlState(error) });
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
if (boundary) {
|
|
125
|
+
this.transactions.onBoundary(
|
|
126
|
+
client,
|
|
127
|
+
scope,
|
|
128
|
+
boundary,
|
|
129
|
+
startedAt,
|
|
130
|
+
error,
|
|
131
|
+
response,
|
|
132
|
+
);
|
|
133
|
+
}
|
|
134
|
+
};
|
|
135
|
+
}
|
|
136
|
+
}
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import { now } from '../clock';
|
|
2
|
+
import type { EventSource } from '../events';
|
|
3
|
+
import { listen } from '../events';
|
|
4
|
+
import { isEventSource, isObject } from '../guards';
|
|
5
|
+
|
|
6
|
+
import type { PoolAdapter } from './pool.adapter';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Пул из `tarn`, который использует knex: публичные члены, которые читает
|
|
10
|
+
* инструментирование
|
|
11
|
+
*/
|
|
12
|
+
export interface TarnPoolLike extends EventSource {
|
|
13
|
+
readonly max: number;
|
|
14
|
+
numUsed(): number;
|
|
15
|
+
numFree(): number;
|
|
16
|
+
numPendingAcquires(): number;
|
|
17
|
+
destroy?(...args: any[]): any;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
/**
|
|
21
|
+
* Пул tarn вместе с внутренними `free` и `used`: по ним инструментирование
|
|
22
|
+
* находит соединения, открытые до подключения метрик. Элементы не
|
|
23
|
+
* проверены, их разбирает {@link openResources}
|
|
24
|
+
*/
|
|
25
|
+
export type TarnPoolInternals = TarnPoolLike & {
|
|
26
|
+
readonly free?: readonly unknown[];
|
|
27
|
+
readonly used?: readonly unknown[];
|
|
28
|
+
};
|
|
29
|
+
|
|
30
|
+
/**
|
|
31
|
+
* Проверяет каждый член пула, который использует
|
|
32
|
+
* {@link tarnPoolAdapter}, в том числе необязательные: `destroy`,
|
|
33
|
+
* если есть, — функция, `free` и `used`, если есть, — массивы. Пул другого
|
|
34
|
+
* драйвера (pg, mysql2) или объект с частью полей не проходит
|
|
35
|
+
*/
|
|
36
|
+
export const isTarnPoolLike = (value: unknown): value is TarnPoolInternals => {
|
|
37
|
+
if (!isEventSource(value)) {
|
|
38
|
+
return false;
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
const pool = value as EventSource & Partial<Record<string, unknown>>;
|
|
42
|
+
|
|
43
|
+
return (
|
|
44
|
+
typeof pool.max === 'number' &&
|
|
45
|
+
typeof pool.numUsed === 'function' &&
|
|
46
|
+
typeof pool.numFree === 'function' &&
|
|
47
|
+
typeof pool.numPendingAcquires === 'function' &&
|
|
48
|
+
(pool.destroy === undefined || typeof pool.destroy === 'function') &&
|
|
49
|
+
(pool.free === undefined || Array.isArray(pool.free)) &&
|
|
50
|
+
(pool.used === undefined || Array.isArray(pool.used))
|
|
51
|
+
);
|
|
52
|
+
};
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Соединения, которые пул уже открыл: `resource` из элементов `free` и
|
|
56
|
+
* `used`. Элементы и соединения, которые не объекты, пропускаются
|
|
57
|
+
*/
|
|
58
|
+
export const openResources = (pool: TarnPoolInternals): object[] =>
|
|
59
|
+
[...(pool.free ?? []), ...(pool.used ?? [])]
|
|
60
|
+
.map((item) =>
|
|
61
|
+
isObject(item) && 'resource' in item ? item.resource : undefined,
|
|
62
|
+
)
|
|
63
|
+
.filter(isObject);
|
|
64
|
+
|
|
65
|
+
/**
|
|
66
|
+
* Таймаут получения соединения. В tarn это `class TimeoutError extends Error {}`
|
|
67
|
+
* без своего `name`, поэтому у экземпляра `name === 'Error'`, и узнать его
|
|
68
|
+
* можно только по имени класса. Импортировать класс нельзя: у `@rsdk/db`
|
|
69
|
+
* нет зависимости от tarn
|
|
70
|
+
*/
|
|
71
|
+
const isAcquireTimeout = (error: unknown): boolean =>
|
|
72
|
+
(error as Error | undefined)?.constructor?.name === 'TimeoutError' ||
|
|
73
|
+
(error as Error | undefined)?.name === 'TimeoutError';
|
|
74
|
+
|
|
75
|
+
/**
|
|
76
|
+
* Пул tarn (knex, MikroORM). Соединения, открытые до вызова, берутся из
|
|
77
|
+
* `free` и `used`; создающиеся соединения там ещё не лежат, их учтёт событие
|
|
78
|
+
* `createSuccess`. Соединения в tarn бывают от любого драйвера knex,
|
|
79
|
+
* поэтому оборачивать ли их `query`, решает плагин (`instrumentQueries`
|
|
80
|
+
* у `DbClientMetrics.instrumentPool`).
|
|
81
|
+
*
|
|
82
|
+
* Ошибки соединений считает `PoolRecorder` по самим соединениям
|
|
83
|
+
*/
|
|
84
|
+
export const tarnPoolAdapter: PoolAdapter<TarnPoolInternals> = {
|
|
85
|
+
isPool: isTarnPoolLike,
|
|
86
|
+
|
|
87
|
+
// Итог — когда закончился первый вызов `destroy`: tarn ждёт, пока вернут
|
|
88
|
+
// выданные соединения, закрывает все и о каждом сообщает событием
|
|
89
|
+
// `destroySuccess` или `destroyFail`
|
|
90
|
+
closeMethod: 'destroy',
|
|
91
|
+
|
|
92
|
+
openConnections: openResources,
|
|
93
|
+
|
|
94
|
+
stats: (pool) => {
|
|
95
|
+
const idle = pool.numFree();
|
|
96
|
+
const active = pool.numUsed();
|
|
97
|
+
|
|
98
|
+
return {
|
|
99
|
+
total: idle + active,
|
|
100
|
+
idle,
|
|
101
|
+
active,
|
|
102
|
+
waiting: pool.numPendingAcquires(),
|
|
103
|
+
max: pool.max,
|
|
104
|
+
};
|
|
105
|
+
},
|
|
106
|
+
|
|
107
|
+
attach: (pool, events, onConnectionCreated) => {
|
|
108
|
+
// Начало ожидания по id запроса соединения: tarn сообщает id в
|
|
109
|
+
// `acquireRequest` и в его исходе
|
|
110
|
+
const acquireStartedAt = new Map<number, number>();
|
|
111
|
+
|
|
112
|
+
const finishAcquire = (eventId: number, timedOut: boolean): void => {
|
|
113
|
+
const startedAt = acquireStartedAt.get(eventId);
|
|
114
|
+
|
|
115
|
+
acquireStartedAt.delete(eventId);
|
|
116
|
+
if (startedAt !== undefined) {
|
|
117
|
+
events.acquireFinished(startedAt, timedOut);
|
|
118
|
+
}
|
|
119
|
+
};
|
|
120
|
+
|
|
121
|
+
return listen(pool, {
|
|
122
|
+
acquireRequest: (eventId: number) => acquireStartedAt.set(eventId, now()),
|
|
123
|
+
acquireSuccess: (eventId: number, resource: object) => {
|
|
124
|
+
finishAcquire(eventId, false);
|
|
125
|
+
events.connectionAcquired(resource);
|
|
126
|
+
},
|
|
127
|
+
acquireFail: (eventId: number, error: unknown) =>
|
|
128
|
+
finishAcquire(eventId, isAcquireTimeout(error)),
|
|
129
|
+
release: (resource: object) => events.connectionReleased(resource),
|
|
130
|
+
createSuccess: (_eventId: number, resource: object) =>
|
|
131
|
+
onConnectionCreated(resource),
|
|
132
|
+
destroySuccess: (_eventId: number, resource: object) =>
|
|
133
|
+
events.connectionClosed(resource),
|
|
134
|
+
destroyFail: (_eventId: number, resource: object) =>
|
|
135
|
+
events.connectionClosed(resource),
|
|
136
|
+
});
|
|
137
|
+
},
|
|
138
|
+
};
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import { secondsSince } from '../clock';
|
|
2
|
+
import type {
|
|
3
|
+
ActiveGaugeLike,
|
|
4
|
+
CounterLike,
|
|
5
|
+
HistogramLike,
|
|
6
|
+
} from '../metric-types';
|
|
7
|
+
import type { TransactionBoundary } from '../sql';
|
|
8
|
+
|
|
9
|
+
import type { PoolScope } from './pool-scope';
|
|
10
|
+
|
|
11
|
+
export interface TransactionMetrics {
|
|
12
|
+
total: CounterLike<'result'>;
|
|
13
|
+
duration: HistogramLike<'result'>;
|
|
14
|
+
active: ActiveGaugeLike<'pool'>;
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
type TransactionResult = 'commit' | 'rollback';
|
|
18
|
+
|
|
19
|
+
interface OpenTransaction {
|
|
20
|
+
scope: PoolScope;
|
|
21
|
+
startedAt: number;
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Отслеживает открытые транзакции по соединениям: в Postgres у соединения
|
|
26
|
+
* не больше одной транзакции верхнего уровня.
|
|
27
|
+
*
|
|
28
|
+
* После итога по пулу его ряд в `db_transactions_active` удалён: транзакции
|
|
29
|
+
* этого пула его больше не трогают, но счётчик и длительность пишутся
|
|
30
|
+
*/
|
|
31
|
+
export class TransactionTracker {
|
|
32
|
+
private readonly open = new WeakMap<object, OpenTransaction>();
|
|
33
|
+
|
|
34
|
+
constructor(private readonly metrics: TransactionMetrics) {}
|
|
35
|
+
|
|
36
|
+
/**
|
|
37
|
+
* Учитывает завершившийся запрос, который открывает или закрывает транзакцию
|
|
38
|
+
*
|
|
39
|
+
* @param startedAt начало запроса: для BEGIN это начало транзакции
|
|
40
|
+
*/
|
|
41
|
+
onBoundary(
|
|
42
|
+
connection: object,
|
|
43
|
+
scope: PoolScope,
|
|
44
|
+
boundary: TransactionBoundary,
|
|
45
|
+
startedAt: number,
|
|
46
|
+
error: unknown,
|
|
47
|
+
response: unknown,
|
|
48
|
+
): void {
|
|
49
|
+
if (boundary === 'begin') {
|
|
50
|
+
this.begin(connection, scope, startedAt, error);
|
|
51
|
+
return;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
/**
|
|
55
|
+
* Postgres отвечает на COMMIT прерванной транзакции тегом ROLLBACK без ошибки,
|
|
56
|
+
* а упавший COMMIT (serialization failure, deferred constraint) тоже откатывает её
|
|
57
|
+
*/
|
|
58
|
+
const committed =
|
|
59
|
+
boundary === 'commit' &&
|
|
60
|
+
!error &&
|
|
61
|
+
(response as { command?: string } | undefined)?.command !== 'ROLLBACK';
|
|
62
|
+
|
|
63
|
+
this.close(connection, committed ? 'commit' : 'rollback');
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Соединение закрыто с открытой транзакцией: БД её откатит
|
|
68
|
+
*/
|
|
69
|
+
onConnectionClosed(connection: object): void {
|
|
70
|
+
this.close(connection, 'rollback');
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
private begin(
|
|
74
|
+
connection: object,
|
|
75
|
+
scope: PoolScope,
|
|
76
|
+
startedAt: number,
|
|
77
|
+
error: unknown,
|
|
78
|
+
): void {
|
|
79
|
+
if (error || !scope.attached || this.open.has(connection)) {
|
|
80
|
+
return;
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
this.open.set(connection, { scope, startedAt });
|
|
84
|
+
this.metrics.active.inc({ pool: scope.pool });
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
private close(connection: object, result: TransactionResult): void {
|
|
88
|
+
const transaction = this.open.get(connection);
|
|
89
|
+
if (!transaction) {
|
|
90
|
+
return;
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
this.open.delete(connection);
|
|
94
|
+
if (transaction.scope.attached) {
|
|
95
|
+
this.metrics.active.dec({ pool: transaction.scope.pool });
|
|
96
|
+
}
|
|
97
|
+
this.metrics.total.inc({ result });
|
|
98
|
+
this.metrics.duration.observe(
|
|
99
|
+
{ result },
|
|
100
|
+
secondsSince(transaction.startedAt),
|
|
101
|
+
);
|
|
102
|
+
}
|
|
103
|
+
}
|