@omnitron-dev/titan-health 0.3.5 → 0.4.8
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/README.md +19 -13
- package/dist/health.indicator.d.ts +1 -1
- package/dist/health.indicator.d.ts.map +1 -1
- package/dist/health.indicator.js +3 -2
- package/dist/health.indicator.js.map +1 -1
- package/dist/health.types.d.ts +7 -6
- package/dist/health.types.d.ts.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js.map +1 -1
- package/dist/indicators/index.d.ts +1 -1
- package/dist/indicators/index.d.ts.map +1 -1
- package/dist/indicators/index.js.map +1 -1
- package/dist/indicators/redis.indicator.d.ts +2 -17
- package/dist/indicators/redis.indicator.d.ts.map +1 -1
- package/dist/indicators/redis.indicator.js +40 -43
- package/dist/indicators/redis.indicator.js.map +1 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -1,29 +1,35 @@
|
|
|
1
1
|
# @omnitron-dev/titan-health
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Compose health indicators and expose application liveness, readiness and operational reports.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Capabilities
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
- Custom indicators for databases, Redis and external dependencies.
|
|
8
|
+
- Aggregated health status and configurable check timeouts.
|
|
9
|
+
- Optional Netron RPC with separate access to detailed reports.
|
|
8
10
|
|
|
9
|
-
|
|
11
|
+
## Quick start
|
|
12
|
+
|
|
13
|
+
```sh
|
|
10
14
|
pnpm add @omnitron-dev/titan-health
|
|
11
15
|
```
|
|
12
16
|
|
|
13
|
-
|
|
17
|
+
```ts
|
|
18
|
+
import { TitanHealthModule } from '@omnitron-dev/titan-health';
|
|
19
|
+
|
|
20
|
+
export const health = TitanHealthModule.forRoot({ detailRpcRoles: ['operator'] });
|
|
21
|
+
```
|
|
14
22
|
|
|
15
|
-
|
|
23
|
+
Add this dynamic module to the `imports` of an existing Titan application.
|
|
16
24
|
|
|
17
|
-
|
|
25
|
+
On `Health@1.0.0`, `live()` and `ready()` allow anonymous probes and return status and timestamp. With `detailRpcRoles`, detailed reports require an admitted matching role. Omitting that option leaves health RPCs public; set `enableRpcService: false` to disable RPC exposure.
|
|
18
26
|
|
|
19
|
-
|
|
27
|
+
The Redis indicator accepts a raw client such as `RedisManager.getClient()`. It requires the exact `PONG` reply. Reported latency covers the application’s round trip, including local scheduling. Optional memory diagnostics use the remaining check timeout.
|
|
20
28
|
|
|
21
|
-
|
|
22
|
-
TitanHealthModule.forRoot({ detailRpcRoles: ['operator', 'observer'] })
|
|
23
|
-
```
|
|
29
|
+
## Documentation
|
|
24
30
|
|
|
25
|
-
|
|
31
|
+
[Public API](src/index.ts) · [Package exports](package.json) · [Omni](../../README.md)
|
|
26
32
|
|
|
27
33
|
## License
|
|
28
34
|
|
|
29
|
-
MIT
|
|
35
|
+
[MIT](../../LICENSE).
|
|
@@ -11,7 +11,7 @@ export declare abstract class HealthIndicator implements IHealthIndicator {
|
|
|
11
11
|
result: T;
|
|
12
12
|
latency: number;
|
|
13
13
|
}>;
|
|
14
|
-
protected withTimeout<T>(operation: () => Promise<T>, timeoutMs: number, timeoutMessage?: string): Promise<T>;
|
|
14
|
+
protected withTimeout<T>(operation: () => Promise<T>, timeoutMs: number, timeoutMessage?: string | Error): Promise<T>;
|
|
15
15
|
isHealthy(result?: HealthIndicatorResult): boolean;
|
|
16
16
|
isDegraded(result?: HealthIndicatorResult): boolean;
|
|
17
17
|
isUnhealthy(result?: HealthIndicatorResult): boolean;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"health.indicator.d.ts","sourceRoot":"","sources":["../src/health.indicator.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AA0B/F,8BAAsB,eAAgB,YAAW,gBAAgB;IAK/D,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAM/B,QAAQ,CAAC,KAAK,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAKjD,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,qBAAqB,CAE5F;IAKD,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,qBAAqB,CAE7F;IAKD,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,qBAAqB,CAU7G;IAKD,SAAS,CAAC,yBAAyB,CACjC,SAAS,EAAE,OAAO,EAClB,cAAc,CAAC,EAAE,MAAM,EACvB,gBAAgB,CAAC,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,qBAAqB,CAEvB;IAKD,SAAS,CAAC,YAAY,CACpB,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,qBAAqB,CAOvB;IAKD,UAAgB,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,CAAC,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAKnG;IAKD,UAAgB,WAAW,CAAC,CAAC,EAC3B,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAC3B,SAAS,EAAE,MAAM,EACjB,cAAc,
|
|
1
|
+
{"version":3,"file":"health.indicator.d.ts","sourceRoot":"","sources":["../src/health.indicator.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAE,YAAY,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AA0B/F,8BAAsB,eAAgB,YAAW,gBAAgB;IAK/D,QAAQ,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAM/B,QAAQ,CAAC,KAAK,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAKjD,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,qBAAqB,CAE5F;IAKD,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,qBAAqB,CAE7F;IAKD,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,CAAC,EAAE,KAAK,GAAG,qBAAqB,CAU7G;IAKD,SAAS,CAAC,yBAAyB,CACjC,SAAS,EAAE,OAAO,EAClB,cAAc,CAAC,EAAE,MAAM,EACvB,gBAAgB,CAAC,EAAE,MAAM,EACzB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,qBAAqB,CAEvB;IAKD,SAAS,CAAC,YAAY,CACpB,MAAM,EAAE,YAAY,EACpB,OAAO,CAAC,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAChC,qBAAqB,CAOvB;IAKD,UAAgB,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC;QAAE,MAAM,EAAE,CAAC,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC,CAKnG;IAKD,UAAgB,WAAW,CAAC,CAAC,EAC3B,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,EAC3B,SAAS,EAAE,MAAM,EACjB,cAAc,GAAE,MAAM,GAAG,KAAgC,GACxD,OAAO,CAAC,CAAC,CAAC,CAiBZ;IAKD,SAAS,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAEjD;IAKD,UAAU,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAElD;IAKD,WAAW,CAAC,MAAM,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAEnD;IAKD,SAAS,CAAC,iBAAiB,CAAC,MAAM,EAAE,YAAY,GAAG,MAAM,CAWxD;IAKD,SAAS,CAAC,cAAc,CAAC,QAAQ,EAAE,YAAY,EAAE,GAAG,YAAY,CAO/D;CACF;AAcD,qBAAa,wBAAyB,SAAQ,eAAe;IAC3D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,UAAU,CAAqB;IAEvC,YAAY,IAAI,EAAE,MAAM,EAAE,UAAU,GAAE,gBAAgB,EAAO,EAI5D;IAKD,YAAY,CAAC,SAAS,EAAE,gBAAgB,GAAG,IAAI,CAG9C;IAKD,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAOrC;IAKK,KAAK,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAwC5C;CACF"}
|
package/dist/health.indicator.js
CHANGED
|
@@ -36,9 +36,10 @@ export class HealthIndicator {
|
|
|
36
36
|
async withTimeout(operation, timeoutMs, timeoutMessage = 'Health check timed out') {
|
|
37
37
|
return new Promise((resolve, reject) => {
|
|
38
38
|
const timer = setTimeout(() => {
|
|
39
|
-
reject(new Error(timeoutMessage));
|
|
39
|
+
reject(typeof timeoutMessage === 'string' ? new Error(timeoutMessage) : timeoutMessage);
|
|
40
40
|
}, timeoutMs);
|
|
41
|
-
|
|
41
|
+
Promise.resolve()
|
|
42
|
+
.then(operation)
|
|
42
43
|
.then((result) => {
|
|
43
44
|
clearTimeout(timer);
|
|
44
45
|
resolve(result);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"health.indicator.js","sourceRoot":"","sources":["../src/health.indicator.ts"],"names":[],"mappings":"AAmCA,MAAM,OAAgB,eAAe;IAgBzB,OAAO,CAAC,OAAgB,EAAE,OAAiC;QACnE,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAKS,QAAQ,CAAC,OAAgB,EAAE,OAAiC;QACpE,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAKS,SAAS,CAAC,OAAgB,EAAE,OAAiC,EAAE,KAAa;QACpF,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAChE,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,CAAC,KAAK,GAAG;gBACb,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,IAAI,EAAG,KAAa,CAAC,IAAI;gBACzB,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;aAC1E,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAKS,yBAAyB,CACjC,SAAkB,EAClB,cAAuB,EACvB,gBAAyB,EACzB,OAAiC;QAEjC,OAAO,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAKS,YAAY,CACpB,MAAoB,EACpB,OAAgB,EAChB,OAAiC;QAEjC,OAAO;YACL,MAAM;YACN,OAAO;YACP,OAAO;YACP,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC;IACJ,CAAC;IAKS,KAAK,CAAC,WAAW,CAAI,SAA2B;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QACnC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAC7B,CAAC;IAKS,KAAK,CAAC,WAAW,CACzB,SAA2B,EAC3B,SAAiB,EACjB,cAAc,
|
|
1
|
+
{"version":3,"file":"health.indicator.js","sourceRoot":"","sources":["../src/health.indicator.ts"],"names":[],"mappings":"AAmCA,MAAM,OAAgB,eAAe;IAgBzB,OAAO,CAAC,OAAgB,EAAE,OAAiC;QACnE,OAAO,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACxD,CAAC;IAKS,QAAQ,CAAC,OAAgB,EAAE,OAAiC;QACpE,OAAO,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAKS,SAAS,CAAC,OAAgB,EAAE,OAAiC,EAAE,KAAa;QACpF,MAAM,MAAM,GAAG,IAAI,CAAC,YAAY,CAAC,WAAW,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;QAChE,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,CAAC,KAAK,GAAG;gBACb,OAAO,EAAE,KAAK,CAAC,OAAO;gBACtB,IAAI,EAAG,KAAa,CAAC,IAAI;gBACzB,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,KAAK,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;aAC1E,CAAC;QACJ,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAKS,yBAAyB,CACjC,SAAkB,EAClB,cAAuB,EACvB,gBAAyB,EACzB,OAAiC;QAEjC,OAAO,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAKS,YAAY,CACpB,MAAoB,EACpB,OAAgB,EAChB,OAAiC;QAEjC,OAAO;YACL,MAAM;YACN,OAAO;YACP,OAAO;YACP,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC;IACJ,CAAC;IAKS,KAAK,CAAC,WAAW,CAAI,SAA2B;QACxD,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAC;QACjC,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QACnC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;IAC7B,CAAC;IAKS,KAAK,CAAC,WAAW,CACzB,SAA2B,EAC3B,SAAiB,EACjB,cAAc,GAAmB,wBAAwB;QAEzD,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,MAAM,KAAK,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,MAAM,CAAC,OAAO,cAAc,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC,CAAC;YAC1F,CAAC,EAAE,SAAS,CAAC,CAAC;YAEd,OAAO,CAAC,OAAO,EAAE;iBACd,IAAI,CAAC,SAAS,CAAC;iBACf,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;gBACf,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpB,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,YAAY,CAAC,KAAK,CAAC,CAAC;gBACpB,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;IAKD,SAAS,CAAC,MAA8B;QACtC,OAAO,MAAM,EAAE,MAAM,KAAK,SAAS,CAAC;IACtC,CAAC;IAKD,UAAU,CAAC,MAA8B;QACvC,OAAO,MAAM,EAAE,MAAM,KAAK,UAAU,CAAC;IACvC,CAAC;IAKD,WAAW,CAAC,MAA8B;QACxC,OAAO,MAAM,EAAE,MAAM,KAAK,WAAW,CAAC;IACxC,CAAC;IAKS,iBAAiB,CAAC,MAAoB;QAC9C,QAAQ,MAAM,EAAE,CAAC;YACf,KAAK,SAAS;gBACZ,OAAO,CAAC,CAAC;YACX,KAAK,UAAU;gBACb,OAAO,CAAC,CAAC;YACX,KAAK,WAAW;gBACd,OAAO,CAAC,CAAC;YACX;gBACE,OAAO,CAAC,CAAC;QACb,CAAC;IACH,CAAC;IAKS,cAAc,CAAC,QAAwB;QAC/C,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,SAAS,CAAC;QAE5C,OAAO,QAAQ,CAAC,MAAM,CACpB,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,EACvG,SAAyB,CAC1B,CAAC;IACJ,CAAC;CACF;AAcD,MAAM,OAAO,wBAAyB,SAAQ,eAAe;IAI3D,YAAY,IAAY,EAAE,UAAU,GAAuB,EAAE;QAC3D,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;IAKD,YAAY,CAAC,SAA2B;QACtC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAChC,OAAO,IAAI,CAAC;IACd,CAAC;IAKD,eAAe,CAAC,IAAY;QAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,IAAI,CAAC,CAAC;QAChE,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;YACf,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;YACjC,OAAO,IAAI,CAAC;QACd,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAKD,KAAK,CAAC,KAAK;QACT,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACzB,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QAEhF,MAAM,gBAAgB,GAA0C,EAAE,CAAC;QACnE,MAAM,QAAQ,GAAmB,EAAE,CAAC;QAEpC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YAChC,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;YACzC,IAAI,CAAC,SAAS;gBAAE,OAAO;YAEvB,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;gBAClC,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,KAAK,CAAC;gBAChD,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;YACrC,CAAC;iBAAM,CAAC;gBACN,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG;oBACjC,MAAM,EAAE,WAAW;oBACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,IAAI,qBAAqB;oBACxD,KAAK,EAAE;wBACL,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,IAAI,eAAe;qBACnD;oBACD,SAAS,EAAE,IAAI,IAAI,EAAE;iBACtB,CAAC;gBACF,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QACpD,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;QAEnC,OAAO;YACL,MAAM,EAAE,aAAa;YACrB,OAAO,EAAE,qBAAqB,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,aAAa;YACvE,OAAO,EAAE;gBACP,UAAU,EAAE,gBAAgB;gBAC5B,cAAc,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM;aACvC;YACD,OAAO;YACP,SAAS,EAAE,IAAI,IAAI,EAAE;SACtB,CAAC;IACJ,CAAC;CACF"}
|
package/dist/health.types.d.ts
CHANGED
|
@@ -25,6 +25,12 @@ export interface DatabaseIndicatorOptions {
|
|
|
25
25
|
healthQuery?: string;
|
|
26
26
|
timeout?: number;
|
|
27
27
|
}
|
|
28
|
+
export interface IRedisClient {
|
|
29
|
+
ping(): Promise<string>;
|
|
30
|
+
info?(section?: string): Promise<string>;
|
|
31
|
+
status?: string;
|
|
32
|
+
isReady?: boolean;
|
|
33
|
+
}
|
|
28
34
|
export interface RedisIndicatorOptions {
|
|
29
35
|
latencyDegradedThreshold?: number;
|
|
30
36
|
latencyUnhealthyThreshold?: number;
|
|
@@ -46,12 +52,7 @@ export interface HealthModuleOptions {
|
|
|
46
52
|
query?(query: string): Promise<unknown>;
|
|
47
53
|
};
|
|
48
54
|
enableRedisIndicator?: boolean;
|
|
49
|
-
redisClient?:
|
|
50
|
-
ping(): Promise<string>;
|
|
51
|
-
info?(section?: string): Promise<string>;
|
|
52
|
-
status?: string;
|
|
53
|
-
isReady?: boolean;
|
|
54
|
-
};
|
|
55
|
+
redisClient?: IRedisClient;
|
|
55
56
|
timeout?: number;
|
|
56
57
|
enableCaching?: boolean;
|
|
57
58
|
cacheTtl?: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"health.types.d.ts","sourceRoot":"","sources":["../src/health.types.ts"],"names":[],"mappings":"AAWA,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,CAAC;AAKhE,MAAM,WAAW,qBAAqB;IAIpC,MAAM,EAAE,YAAY,CAAC;IAKrB,OAAO,CAAC,EAAE,MAAM,CAAC;IAKjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAKlC,OAAO,CAAC,EAAE,MAAM,CAAC;IAKjB,SAAS,CAAC,EAAE,IAAI,CAAC;IAKjB,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAKD,MAAM,WAAW,iBAAiB;IAIhC,MAAM,EAAE,YAAY,CAAC;IAKrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAKlD,SAAS,EAAE,IAAI,CAAC;IAKhB,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAKjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAKD,MAAM,WAAW,wBAAwB;IAKvC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAMlC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAMnC,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAKD,MAAM,WAAW,qBAAqB;IAKpC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAMlC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAMnC,OAAO,CAAC,EAAE,MAAM,CAAC;IAMjB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAM5B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAMjC,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAKD,MAAM,WAAW,mBAAmB;IAKlC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAMhC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAMnC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAO9B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAMlC,kBAAkB,CAAC,EAAE;QACnB,OAAO,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1C,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG;YAAE,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;SAAE,CAAC;QACrD,KAAK,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;KACzC,CAAC;IAOF,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAM/B,WAAW,CAAC,EAAE
|
|
1
|
+
{"version":3,"file":"health.types.d.ts","sourceRoot":"","sources":["../src/health.types.ts"],"names":[],"mappings":"AAWA,MAAM,MAAM,YAAY,GAAG,SAAS,GAAG,UAAU,GAAG,WAAW,CAAC;AAKhE,MAAM,WAAW,qBAAqB;IAIpC,MAAM,EAAE,YAAY,CAAC;IAKrB,OAAO,CAAC,EAAE,MAAM,CAAC;IAKjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAKlC,OAAO,CAAC,EAAE,MAAM,CAAC;IAKjB,SAAS,CAAC,EAAE,IAAI,CAAC;IAKjB,KAAK,CAAC,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAKD,MAAM,WAAW,iBAAiB;IAIhC,MAAM,EAAE,YAAY,CAAC;IAKrB,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IAKlD,SAAS,EAAE,IAAI,CAAC;IAKhB,YAAY,CAAC,EAAE,MAAM,CAAC;IAKtB,OAAO,CAAC,EAAE,MAAM,CAAC;IAKjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAKD,MAAM,WAAW,wBAAwB;IAKvC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAMlC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAMnC,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD,MAAM,WAAW,YAAY;IAC3B,IAAI,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IACxB,IAAI,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IACzC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAKD,MAAM,WAAW,qBAAqB;IAKpC,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAMlC,yBAAyB,CAAC,EAAE,MAAM,CAAC;IAMnC,OAAO,CAAC,EAAE,MAAM,CAAC;IAMjB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAM5B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAMjC,wBAAwB,CAAC,EAAE,MAAM,CAAC;CACnC;AAKD,MAAM,WAAW,mBAAmB;IAKlC,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAMhC,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAMnC,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAO9B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAMlC,kBAAkB,CAAC,EAAE;QACnB,OAAO,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QAC1C,GAAG,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG;YAAE,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAA;SAAE,CAAC;QACrD,KAAK,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;KACzC,CAAC;IAOF,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAM/B,WAAW,CAAC,EAAE,YAAY,CAAC;IAM3B,OAAO,CAAC,EAAE,MAAM,CAAC;IAMjB,aAAa,CAAC,EAAE,OAAO,CAAC;IAMxB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAUlB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAG3B,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAKnC,OAAO,CAAC,EAAE,MAAM,CAAC;IAMjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAKnB,UAAU,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,gBAAgB,CAAC,CAAC;IAK7D,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAKpC,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAK1C,cAAc,CAAC,EAAE,cAAc,CAAC;IAKhC,eAAe,CAAC,EAAE,wBAAwB,CAAC;IAK3C,YAAY,CAAC,EAAE,qBAAqB,CAAC;CACtC;AAKD,MAAM,WAAW,wBAAwB;IAIvC,UAAU,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,OAAO,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAAC;IAKpF,MAAM,CAAC,EAAE,GAAG,EAAE,CAAC;IAKf,OAAO,CAAC,EAAE,GAAG,EAAE,CAAC;IAKhB,QAAQ,CAAC,EAAE,OAAO,CAAC;IAcnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAKD,MAAM,WAAW,gBAAgB;IAO/B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAM/B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAKhC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAKlB,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAKD,MAAM,WAAW,mBAAmB;IAKlC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAM9B,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAS/B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAKD,MAAM,WAAW,cAAc;IAK7B,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAMhC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IAMjC,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAKD,MAAM,WAAW,gBAAgB;IAI/B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAKtB,KAAK,IAAI,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACzC;AAKD,MAAM,WAAW,cAAc;IAI7B,iBAAiB,CAAC,SAAS,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAKrD,mBAAmB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAK3C,KAAK,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAKpC,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAKvD,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAK9B,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAK5B,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAK5B,aAAa,IAAI,MAAM,EAAE,CAAC;CAC3B"}
|
package/dist/index.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ export { TitanHealthModule as HealthModule } from './health.module.js';
|
|
|
3
3
|
export { HealthService } from './health.service.js';
|
|
4
4
|
export { HealthRpcService, type LivenessResponse, type ReadinessResponse, type HealthResponse, type IndicatorResponse, type UptimeResponse, } from './health.rpc-service.js';
|
|
5
5
|
export { HealthIndicator, CompositeHealthIndicator } from './health.indicator.js';
|
|
6
|
-
export { MemoryHealthIndicator, EventLoopHealthIndicator, DiskHealthIndicator, DatabaseHealthIndicator, RedisHealthIndicator, type DatabaseHealthOptions, type IDatabaseConnection,
|
|
6
|
+
export { MemoryHealthIndicator, EventLoopHealthIndicator, DiskHealthIndicator, DatabaseHealthIndicator, RedisHealthIndicator, type DatabaseHealthOptions, type IDatabaseConnection, } from './indicators/index.js';
|
|
7
7
|
export { HEALTH_SERVICE_TOKEN, HEALTH_MODULE_OPTIONS_TOKEN, HEALTH_RPC_SERVICE_TOKEN, MEMORY_HEALTH_INDICATOR_TOKEN, EVENT_LOOP_HEALTH_INDICATOR_TOKEN, DISK_HEALTH_INDICATOR_TOKEN, DATABASE_HEALTH_INDICATOR_TOKEN, REDIS_HEALTH_INDICATOR_TOKEN, } from './health.tokens.js';
|
|
8
|
-
export type { HealthStatus, HealthIndicatorResult, HealthCheckResult, HealthModuleOptions, HealthModuleAsyncOptions, DatabaseIndicatorOptions, RedisIndicatorOptions, MemoryThresholds, EventLoopThresholds, DiskThresholds, IHealthIndicator, IHealthService, } from './health.types.js';
|
|
8
|
+
export type { HealthStatus, HealthIndicatorResult, HealthCheckResult, HealthModuleOptions, HealthModuleAsyncOptions, DatabaseIndicatorOptions, RedisIndicatorOptions, IRedisClient, MemoryThresholds, EventLoopThresholds, DiskThresholds, IHealthIndicator, IHealthService, } from './health.types.js';
|
|
9
9
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAMvD,OAAO,EAAE,iBAAiB,IAAI,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAMvE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAMpD,OAAO,EACL,gBAAgB,EAChB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB,MAAM,yBAAyB,CAAC;AAMjC,OAAO,EAAE,eAAe,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAMlF,OAAO,EAEL,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EAEnB,uBAAuB,EACvB,oBAAoB,EAEpB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAMvD,OAAO,EAAE,iBAAiB,IAAI,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAMvE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAMpD,OAAO,EACL,gBAAgB,EAChB,KAAK,gBAAgB,EACrB,KAAK,iBAAiB,EACtB,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,KAAK,cAAc,GACpB,MAAM,yBAAyB,CAAC;AAMjC,OAAO,EAAE,eAAe,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAMlF,OAAO,EAEL,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EAEnB,uBAAuB,EACvB,oBAAoB,EAEpB,KAAK,qBAAqB,EAC1B,KAAK,mBAAmB,GACzB,MAAM,uBAAuB,CAAC;AAM/B,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,wBAAwB,EAIxB,6BAA6B,EAC7B,iCAAiC,EACjC,2BAA2B,EAC3B,+BAA+B,EAC/B,4BAA4B,GAC7B,MAAM,oBAAoB,CAAC;AAM5B,YAAY,EAEV,YAAY,EAGZ,qBAAqB,EACrB,iBAAiB,EAGjB,mBAAmB,EACnB,wBAAwB,EACxB,wBAAwB,EACxB,qBAAqB,EACrB,YAAY,EAGZ,gBAAgB,EAChB,mBAAmB,EACnB,cAAc,EAGd,gBAAgB,EAChB,cAAc,GACf,MAAM,mBAAmB,CAAC"}
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAMvD,OAAO,EAAE,iBAAiB,IAAI,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAMvE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAMpD,OAAO,EACL,gBAAgB,GAMjB,MAAM,yBAAyB,CAAC;AAMjC,OAAO,EAAE,eAAe,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAMlF,OAAO,EAEL,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EAEnB,uBAAuB,EACvB,oBAAoB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAgEA,OAAO,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAMvD,OAAO,EAAE,iBAAiB,IAAI,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAMvE,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAMpD,OAAO,EACL,gBAAgB,GAMjB,MAAM,yBAAyB,CAAC;AAMjC,OAAO,EAAE,eAAe,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAMlF,OAAO,EAEL,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EAEnB,uBAAuB,EACvB,oBAAoB,GAIrB,MAAM,uBAAuB,CAAC;AAM/B,OAAO,EACL,oBAAoB,EACpB,2BAA2B,EAC3B,wBAAwB,EAIxB,6BAA6B,EAC7B,iCAAiC,EACjC,2BAA2B,EAC3B,+BAA+B,EAC/B,4BAA4B,GAC7B,MAAM,oBAAoB,CAAC"}
|
|
@@ -2,5 +2,5 @@ export { MemoryHealthIndicator } from './memory.indicator.js';
|
|
|
2
2
|
export { EventLoopHealthIndicator } from './event-loop.indicator.js';
|
|
3
3
|
export { DiskHealthIndicator } from './disk.indicator.js';
|
|
4
4
|
export { DatabaseHealthIndicator, type DatabaseHealthOptions, type IDatabaseConnection } from './database.indicator.js';
|
|
5
|
-
export { RedisHealthIndicator
|
|
5
|
+
export { RedisHealthIndicator } from './redis.indicator.js';
|
|
6
6
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/indicators/index.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAM9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAMrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAM1D,OAAO,EAAE,uBAAuB,EAAE,KAAK,qBAAqB,EAAE,KAAK,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAMxH,OAAO,EAAE,oBAAoB,EAAE,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/indicators/index.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAM9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAMrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAM1D,OAAO,EAAE,uBAAuB,EAAE,KAAK,qBAAqB,EAAE,KAAK,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAMxH,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/indicators/index.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAM9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAMrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAM1D,OAAO,EAAE,uBAAuB,EAAwD,MAAM,yBAAyB,CAAC;AAMxH,OAAO,EAAE,oBAAoB,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/indicators/index.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AAM9D,OAAO,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAMrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAM1D,OAAO,EAAE,uBAAuB,EAAwD,MAAM,yBAAyB,CAAC;AAMxH,OAAO,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC"}
|
|
@@ -1,26 +1,11 @@
|
|
|
1
1
|
import { HealthIndicator } from '../health.indicator.js';
|
|
2
|
-
import type { HealthIndicatorResult } from '../health.types.js';
|
|
3
|
-
export interface RedisHealthOptions {
|
|
4
|
-
latencyDegradedThreshold?: number;
|
|
5
|
-
latencyUnhealthyThreshold?: number;
|
|
6
|
-
timeout?: number;
|
|
7
|
-
includeMemoryInfo?: boolean;
|
|
8
|
-
memoryDegradedThreshold?: number;
|
|
9
|
-
memoryUnhealthyThreshold?: number;
|
|
10
|
-
}
|
|
11
|
-
export interface IRedisClient {
|
|
12
|
-
ping(): Promise<string>;
|
|
13
|
-
info?(section?: string): Promise<string>;
|
|
14
|
-
status?: string;
|
|
15
|
-
isReady?: boolean;
|
|
16
|
-
}
|
|
2
|
+
import type { HealthIndicatorResult, IRedisClient, RedisIndicatorOptions } from '../health.types.js';
|
|
17
3
|
export declare class RedisHealthIndicator extends HealthIndicator {
|
|
18
4
|
readonly name = "redis";
|
|
19
5
|
private readonly options;
|
|
20
6
|
private client?;
|
|
21
|
-
constructor(client?: IRedisClient, options?:
|
|
7
|
+
constructor(client?: IRedisClient, options?: RedisIndicatorOptions);
|
|
22
8
|
setClient(client: IRedisClient): void;
|
|
23
9
|
check(): Promise<HealthIndicatorResult>;
|
|
24
|
-
private getMemoryInfo;
|
|
25
10
|
}
|
|
26
11
|
//# sourceMappingURL=redis.indicator.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redis.indicator.d.ts","sourceRoot":"","sources":["../../src/indicators/redis.indicator.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,
|
|
1
|
+
{"version":3,"file":"redis.indicator.d.ts","sourceRoot":"","sources":["../../src/indicators/redis.indicator.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,KAAK,EAAE,qBAAqB,EAAE,YAAY,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAsDrG,qBAAa,oBAAqB,SAAQ,eAAe;IACvD,QAAQ,CAAC,IAAI,WAAW;IAExB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAkC;IAC1D,OAAO,CAAC,MAAM,CAAC,CAAe;IAE9B,YAAY,MAAM,CAAC,EAAE,YAAY,EAAE,OAAO,GAAE,qBAA0B,EAOrE;IAKD,SAAS,CAAC,MAAM,EAAE,YAAY,GAAG,IAAI,CAEpC;IAKK,KAAK,IAAI,OAAO,CAAC,qBAAqB,CAAC,CA6D5C;CACF"}
|
|
@@ -7,6 +7,23 @@ const DEFAULT_OPTIONS = {
|
|
|
7
7
|
memoryDegradedThreshold: 0.8,
|
|
8
8
|
memoryUnhealthyThreshold: 0.95,
|
|
9
9
|
};
|
|
10
|
+
const PING_TIMEOUT = new Error('Redis PING timed out');
|
|
11
|
+
const CONNECTION_STATES = new Set(['wait', 'connecting', 'connect', 'reconnecting', 'close', 'end']);
|
|
12
|
+
function parseMemoryInfo(info) {
|
|
13
|
+
const lines = info.split('\r\n');
|
|
14
|
+
const bytes = (key) => {
|
|
15
|
+
const prefix = key + ':';
|
|
16
|
+
const value = lines.find(line => line.startsWith(prefix))?.slice(prefix.length);
|
|
17
|
+
if (!value || !/^\d+$/.test(value) || !Number.isSafeInteger(Number(value))) {
|
|
18
|
+
throw new Error('Invalid Redis memory statistics');
|
|
19
|
+
}
|
|
20
|
+
return Number(value);
|
|
21
|
+
};
|
|
22
|
+
const used = bytes('used_memory');
|
|
23
|
+
const peak = bytes('used_memory_peak');
|
|
24
|
+
const maxmemory = bytes('maxmemory');
|
|
25
|
+
return { used, peak, maxmemory, usedRatio: maxmemory > 0 ? used / maxmemory : 0 };
|
|
26
|
+
}
|
|
10
27
|
export class RedisHealthIndicator extends HealthIndicator {
|
|
11
28
|
constructor(client, options = {}) {
|
|
12
29
|
super();
|
|
@@ -21,19 +38,22 @@ export class RedisHealthIndicator extends HealthIndicator {
|
|
|
21
38
|
this.client = client;
|
|
22
39
|
}
|
|
23
40
|
async check() {
|
|
24
|
-
|
|
41
|
+
const client = this.client;
|
|
42
|
+
if (!client)
|
|
25
43
|
return this.unhealthy('Redis client not configured');
|
|
26
|
-
}
|
|
27
|
-
if (this.client.status && this.client.status !== 'ready') {
|
|
28
|
-
return this.unhealthy(`Redis not ready: ${this.client.status}`, { status: this.client.status });
|
|
29
|
-
}
|
|
30
|
-
if (this.client.isReady === false) {
|
|
31
|
-
return this.unhealthy('Redis not ready');
|
|
32
|
-
}
|
|
33
44
|
try {
|
|
34
|
-
const
|
|
35
|
-
|
|
36
|
-
|
|
45
|
+
const { status, isReady } = client;
|
|
46
|
+
if (status !== undefined && status !== 'ready') {
|
|
47
|
+
const details = CONNECTION_STATES.has(status) ? { status } : undefined;
|
|
48
|
+
return this.unhealthy('Redis not ready', details);
|
|
49
|
+
}
|
|
50
|
+
if (isReady !== undefined && isReady !== true)
|
|
51
|
+
return this.unhealthy('Redis not ready');
|
|
52
|
+
const start = performance.now();
|
|
53
|
+
const reply = await this.withTimeout(() => client.ping(), this.options.timeout, PING_TIMEOUT);
|
|
54
|
+
const pingLatency = Math.floor(performance.now() - start);
|
|
55
|
+
if (reply !== 'PONG')
|
|
56
|
+
return this.unhealthy('Redis PING returned an unexpected reply');
|
|
37
57
|
const details = {
|
|
38
58
|
latency: pingLatency,
|
|
39
59
|
threshold: {
|
|
@@ -42,9 +62,13 @@ export class RedisHealthIndicator extends HealthIndicator {
|
|
|
42
62
|
},
|
|
43
63
|
};
|
|
44
64
|
let memoryStatus = 'healthy';
|
|
45
|
-
if (this.options.includeMemoryInfo &&
|
|
65
|
+
if (this.options.includeMemoryInfo && client.info) {
|
|
46
66
|
try {
|
|
47
|
-
const
|
|
67
|
+
const remaining = this.options.timeout - (performance.now() - start);
|
|
68
|
+
if (remaining <= 0)
|
|
69
|
+
throw new Error('Redis INFO timed out');
|
|
70
|
+
const info = await this.withTimeout(() => client.info('memory'), remaining);
|
|
71
|
+
const memoryInfo = parseMemoryInfo(info);
|
|
48
72
|
details['memory'] = memoryInfo;
|
|
49
73
|
if (memoryInfo.usedRatio >= this.options.memoryUnhealthyThreshold) {
|
|
50
74
|
memoryStatus = 'unhealthy';
|
|
@@ -61,41 +85,14 @@ export class RedisHealthIndicator extends HealthIndicator {
|
|
|
61
85
|
return this.unhealthy(`Redis issues: latency=${pingLatency}ms, memory=${memoryStatus}`, details);
|
|
62
86
|
}
|
|
63
87
|
if (pingLatency >= this.options.latencyDegradedThreshold || memoryStatus === 'degraded') {
|
|
64
|
-
|
|
88
|
+
const memory = memoryStatus === 'degraded' ? ', memory=degraded' : '';
|
|
89
|
+
return this.degraded(`Redis degraded: latency=${pingLatency}ms${memory}`, details);
|
|
65
90
|
}
|
|
66
91
|
return this.healthy(`Redis responding in ${pingLatency}ms`, details);
|
|
67
92
|
}
|
|
68
93
|
catch (error) {
|
|
69
|
-
|
|
70
|
-
return this.unhealthy(`Redis check failed: ${errorMessage}`, undefined, error instanceof Error ? error : new Error(errorMessage));
|
|
94
|
+
return this.unhealthy(error === PING_TIMEOUT ? 'Redis PING timed out' : 'Redis PING failed');
|
|
71
95
|
}
|
|
72
96
|
}
|
|
73
|
-
async getMemoryInfo() {
|
|
74
|
-
if (!this.client?.info) {
|
|
75
|
-
throw new Error('INFO command not available');
|
|
76
|
-
}
|
|
77
|
-
const infoResult = await this.client.info('memory');
|
|
78
|
-
if (!infoResult) {
|
|
79
|
-
throw new Error('INFO command returned empty result');
|
|
80
|
-
}
|
|
81
|
-
const lines = infoResult.split('\r\n');
|
|
82
|
-
const parseValue = (key) => {
|
|
83
|
-
const line = lines.find((l) => l.startsWith(`${key}:`));
|
|
84
|
-
if (!line)
|
|
85
|
-
return 0;
|
|
86
|
-
const parts = line.split(':');
|
|
87
|
-
const value = parts[1];
|
|
88
|
-
return value ? parseInt(value, 10) || 0 : 0;
|
|
89
|
-
};
|
|
90
|
-
const used = parseValue('used_memory');
|
|
91
|
-
const peak = parseValue('used_memory_peak');
|
|
92
|
-
const maxmemory = parseValue('maxmemory');
|
|
93
|
-
return {
|
|
94
|
-
used,
|
|
95
|
-
peak,
|
|
96
|
-
maxmemory,
|
|
97
|
-
usedRatio: maxmemory > 0 ? used / maxmemory : 0,
|
|
98
|
-
};
|
|
99
|
-
}
|
|
100
97
|
}
|
|
101
98
|
//# sourceMappingURL=redis.indicator.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"redis.indicator.js","sourceRoot":"","sources":["../../src/indicators/redis.indicator.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"redis.indicator.js","sourceRoot":"","sources":["../../src/indicators/redis.indicator.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAMzD,MAAM,eAAe,GAAoC;IACvD,wBAAwB,EAAE,EAAE;IAC5B,yBAAyB,EAAE,GAAG;IAC9B,OAAO,EAAE,IAAI;IACb,iBAAiB,EAAE,KAAK;IACxB,uBAAuB,EAAE,GAAG;IAC5B,wBAAwB,EAAE,IAAI;CAC/B,CAAC;AAEF,MAAM,YAAY,GAAG,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;AACvD,MAAM,iBAAiB,GAAG,IAAI,GAAG,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,EAAE,cAAc,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;AAErG,SAAS,eAAe,CAAC,IAAY;IACnC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjC,MAAM,KAAK,GAAG,CAAC,GAAW,EAAU,EAAE;QACpC,MAAM,MAAM,GAAG,GAAG,GAAG,GAAG,CAAC;QACzB,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAChF,IAAI,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;YAC3E,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;QACrD,CAAC;QACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC,CAAC;IAEF,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC;IAClC,MAAM,IAAI,GAAG,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACvC,MAAM,SAAS,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;IACrC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AACpF,CAAC;AAsBD,MAAM,OAAO,oBAAqB,SAAQ,eAAe;IAMvD,YAAY,MAAqB,EAAE,OAAO,GAA0B,EAAE;QACpE,KAAK,EAAE,CAAC;QAND,SAAI,GAAG,OAAO,CAAC;QAOtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG;YACb,GAAG,eAAe;YAClB,GAAG,OAAO;SACX,CAAC;IACJ,CAAC;IAKD,SAAS,CAAC,MAAoB;QAC5B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAKD,KAAK,CAAC,KAAK;QACT,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAC3B,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;QAElE,IAAI,CAAC;YACH,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;YACnC,IAAI,MAAM,KAAK,SAAS,IAAI,MAAM,KAAK,OAAO,EAAE,CAAC;gBAC/C,MAAM,OAAO,GAAG,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;gBACvE,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,EAAE,OAAO,CAAC,CAAC;YACpD,CAAC;YACD,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI;gBAAE,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;YAExF,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;YAChC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;YAC9F,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC;YAC1D,IAAI,KAAK,KAAK,MAAM;gBAAE,OAAO,IAAI,CAAC,SAAS,CAAC,yCAAyC,CAAC,CAAC;YAEvF,MAAM,OAAO,GAA4B;gBACvC,OAAO,EAAE,WAAW;gBACpB,SAAS,EAAE;oBACT,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,wBAAwB;oBAC/C,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,yBAAyB;iBAClD;aACF,CAAC;YAGF,IAAI,YAAY,GAAyC,SAAS,CAAC;YACnE,IAAI,IAAI,CAAC,OAAO,CAAC,iBAAiB,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;gBAClD,IAAI,CAAC;oBACH,MAAM,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,GAAG,CAAC,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC,CAAC;oBACrE,IAAI,SAAS,IAAI,CAAC;wBAAE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC;oBAC5D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAK,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;oBAC7E,MAAM,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;oBACzC,OAAO,CAAC,QAAQ,CAAC,GAAG,UAAU,CAAC;oBAE/B,IAAI,UAAU,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,wBAAwB,EAAE,CAAC;wBAClE,YAAY,GAAG,WAAW,CAAC;oBAC7B,CAAC;yBAAM,IAAI,UAAU,CAAC,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,uBAAuB,EAAE,CAAC;wBACxE,YAAY,GAAG,UAAU,CAAC;oBAC5B,CAAC;gBACH,CAAC;gBAAC,MAAM,CAAC;oBAEP,OAAO,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,EAAE,gCAAgC,EAAE,CAAC;gBAClE,CAAC;YACH,CAAC;YAGD,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,yBAAyB,IAAI,YAAY,KAAK,WAAW,EAAE,CAAC;gBAC1F,OAAO,IAAI,CAAC,SAAS,CAAC,yBAAyB,WAAW,cAAc,YAAY,EAAE,EAAE,OAAO,CAAC,CAAC;YACnG,CAAC;YAED,IAAI,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,wBAAwB,IAAI,YAAY,KAAK,UAAU,EAAE,CAAC;gBACxF,MAAM,MAAM,GAAG,YAAY,KAAK,UAAU,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC;gBACtE,OAAO,IAAI,CAAC,QAAQ,CAAC,2BAA2B,WAAW,KAAK,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;YACrF,CAAC;YAED,OAAO,IAAI,CAAC,OAAO,CAAC,uBAAuB,WAAW,IAAI,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAEf,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,KAAK,YAAY,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,mBAAmB,CAAC,CAAC;QAC/F,CAAC;IACH,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@omnitron-dev/titan-health",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.4.8",
|
|
4
4
|
"description": "Health check module for Titan framework with extensible indicators",
|
|
5
5
|
"author": "LuxQuant",
|
|
6
6
|
"license": "MIT",
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
"dist"
|
|
18
18
|
],
|
|
19
19
|
"peerDependencies": {
|
|
20
|
-
"@omnitron-dev/titan": "0.
|
|
20
|
+
"@omnitron-dev/titan": "0.4.8",
|
|
21
21
|
"ioredis": "^5.8.2 || ^6.0.0",
|
|
22
22
|
"kysely": "^0.29.4"
|
|
23
23
|
},
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
}
|
|
31
31
|
},
|
|
32
32
|
"devDependencies": {
|
|
33
|
-
"@omnitron-dev/titan": "0.
|
|
33
|
+
"@omnitron-dev/titan": "0.4.8",
|
|
34
34
|
"@types/node": "26.6.6",
|
|
35
35
|
"reflect-metadata": "^0.2.2",
|
|
36
36
|
"typescript": "npm:@typescript/typescript6@^6.0.2",
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"url": "git+https://github.com/omnitron-dev/omni.git",
|
|
43
43
|
"directory": "packages/titan-health"
|
|
44
44
|
},
|
|
45
|
-
"gitHead": "
|
|
45
|
+
"gitHead": "1ae8568eebc2581e2cc2428bd3ca1cf570ed3f03",
|
|
46
46
|
"scripts": {
|
|
47
47
|
"build": "../../scripts/build-package.sh -p ./tsconfig.json",
|
|
48
48
|
"test": "vitest run",
|