@omnitron-dev/titan-health 0.1.1

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 (55) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +19 -0
  3. package/dist/health.indicator.d.ts +29 -0
  4. package/dist/health.indicator.d.ts.map +1 -0
  5. package/dist/health.indicator.js +136 -0
  6. package/dist/health.indicator.js.map +1 -0
  7. package/dist/health.module.d.ts +9 -0
  8. package/dist/health.module.d.ts.map +1 -0
  9. package/dist/health.module.js +302 -0
  10. package/dist/health.module.js.map +1 -0
  11. package/dist/health.rpc-service.d.ts +56 -0
  12. package/dist/health.rpc-service.d.ts.map +1 -0
  13. package/dist/health.rpc-service.js +138 -0
  14. package/dist/health.rpc-service.js.map +1 -0
  15. package/dist/health.service.d.ts +28 -0
  16. package/dist/health.service.d.ts.map +1 -0
  17. package/dist/health.service.js +182 -0
  18. package/dist/health.service.js.map +1 -0
  19. package/dist/health.tokens.d.ts +12 -0
  20. package/dist/health.tokens.d.ts.map +1 -0
  21. package/dist/health.tokens.js +10 -0
  22. package/dist/health.tokens.js.map +1 -0
  23. package/dist/health.types.d.ts +103 -0
  24. package/dist/health.types.d.ts.map +1 -0
  25. package/dist/health.types.js +2 -0
  26. package/dist/health.types.js.map +1 -0
  27. package/dist/index.d.ts +9 -0
  28. package/dist/index.d.ts.map +1 -0
  29. package/dist/index.js +8 -0
  30. package/dist/index.js.map +1 -0
  31. package/dist/indicators/database.indicator.d.ts +25 -0
  32. package/dist/indicators/database.indicator.d.ts.map +1 -0
  33. package/dist/indicators/database.indicator.js +66 -0
  34. package/dist/indicators/database.indicator.js.map +1 -0
  35. package/dist/indicators/disk.indicator.d.ts +16 -0
  36. package/dist/indicators/disk.indicator.d.ts.map +1 -0
  37. package/dist/indicators/disk.indicator.js +159 -0
  38. package/dist/indicators/disk.indicator.js.map +1 -0
  39. package/dist/indicators/event-loop.indicator.d.ts +27 -0
  40. package/dist/indicators/event-loop.indicator.d.ts.map +1 -0
  41. package/dist/indicators/event-loop.indicator.js +150 -0
  42. package/dist/indicators/event-loop.indicator.js.map +1 -0
  43. package/dist/indicators/index.d.ts +6 -0
  44. package/dist/indicators/index.d.ts.map +1 -0
  45. package/dist/indicators/index.js +6 -0
  46. package/dist/indicators/index.js.map +1 -0
  47. package/dist/indicators/memory.indicator.d.ts +13 -0
  48. package/dist/indicators/memory.indicator.d.ts.map +1 -0
  49. package/dist/indicators/memory.indicator.js +103 -0
  50. package/dist/indicators/memory.indicator.js.map +1 -0
  51. package/dist/indicators/redis.indicator.d.ts +26 -0
  52. package/dist/indicators/redis.indicator.d.ts.map +1 -0
  53. package/dist/indicators/redis.indicator.js +101 -0
  54. package/dist/indicators/redis.indicator.js.map +1 -0
  55. package/package.json +44 -0
@@ -0,0 +1,101 @@
1
+ import { HealthIndicator } from '../health.indicator.js';
2
+ const DEFAULT_OPTIONS = {
3
+ latencyDegradedThreshold: 10,
4
+ latencyUnhealthyThreshold: 100,
5
+ timeout: 5000,
6
+ includeMemoryInfo: false,
7
+ memoryDegradedThreshold: 0.8,
8
+ memoryUnhealthyThreshold: 0.95,
9
+ };
10
+ export class RedisHealthIndicator extends HealthIndicator {
11
+ constructor(client, options = {}) {
12
+ super();
13
+ this.name = 'redis';
14
+ this.client = client;
15
+ this.options = {
16
+ ...DEFAULT_OPTIONS,
17
+ ...options,
18
+ };
19
+ }
20
+ setClient(client) {
21
+ this.client = client;
22
+ }
23
+ async check() {
24
+ if (!this.client) {
25
+ 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
+ try {
34
+ const start = Date.now();
35
+ await this.withTimeout(() => this.client.ping(), this.options.timeout);
36
+ const pingLatency = Date.now() - start;
37
+ const details = {
38
+ latency: pingLatency,
39
+ threshold: {
40
+ degraded: this.options.latencyDegradedThreshold,
41
+ unhealthy: this.options.latencyUnhealthyThreshold,
42
+ },
43
+ };
44
+ let memoryStatus = 'healthy';
45
+ if (this.options.includeMemoryInfo && this.client.info) {
46
+ try {
47
+ const memoryInfo = await this.getMemoryInfo();
48
+ details['memory'] = memoryInfo;
49
+ if (memoryInfo.usedRatio >= this.options.memoryUnhealthyThreshold) {
50
+ memoryStatus = 'unhealthy';
51
+ }
52
+ else if (memoryInfo.usedRatio >= this.options.memoryDegradedThreshold) {
53
+ memoryStatus = 'degraded';
54
+ }
55
+ }
56
+ catch {
57
+ details['memory'] = { error: 'Failed to retrieve memory info' };
58
+ }
59
+ }
60
+ if (pingLatency >= this.options.latencyUnhealthyThreshold || memoryStatus === 'unhealthy') {
61
+ return this.unhealthy(`Redis issues: latency=${pingLatency}ms, memory=${memoryStatus}`, details);
62
+ }
63
+ if (pingLatency >= this.options.latencyDegradedThreshold || memoryStatus === 'degraded') {
64
+ return this.degraded(`Redis degraded: latency=${pingLatency}ms`, details);
65
+ }
66
+ return this.healthy(`Redis responding in ${pingLatency}ms`, details);
67
+ }
68
+ catch (error) {
69
+ const errorMessage = error instanceof Error ? error.message : String(error);
70
+ return this.unhealthy(`Redis check failed: ${errorMessage}`, undefined, error instanceof Error ? error : new Error(errorMessage));
71
+ }
72
+ }
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
+ }
101
+ //# sourceMappingURL=redis.indicator.js.map
@@ -0,0 +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;AAyEzD,MAAM,eAAe,GAAiC;IACpD,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;AAsBF,MAAM,OAAO,oBAAqB,SAAQ,eAAe;IAMvD,YAAY,MAAqB,EAAE,UAA8B,EAAE;QACjE,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,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YACjB,OAAO,IAAI,CAAC,SAAS,CAAC,6BAA6B,CAAC,CAAC;QACvD,CAAC;QAGD,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YACzD,OAAO,IAAI,CAAC,SAAS,CAAC,oBAAoB,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;QAClG,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,KAAK,KAAK,EAAE,CAAC;YAClC,OAAO,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;QAC3C,CAAC;QAED,IAAI,CAAC;YACH,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAO,CAAC,IAAI,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;YACxE,MAAM,WAAW,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,CAAC;YAEvC,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,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;gBACvD,IAAI,CAAC;oBACH,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;oBAC9C,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,OAAO,IAAI,CAAC,QAAQ,CAAC,2BAA2B,WAAW,IAAI,EAAE,OAAO,CAAC,CAAC;YAC5E,CAAC;YAED,OAAO,IAAI,CAAC,OAAO,CAAC,uBAAuB,WAAW,IAAI,EAAE,OAAO,CAAC,CAAC;QACvE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,YAAY,GAAG,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC5E,OAAO,IAAI,CAAC,SAAS,CACnB,uBAAuB,YAAY,EAAE,EACrC,SAAS,EACT,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,YAAY,CAAC,CACzD,CAAC;QACJ,CAAC;IACH,CAAC;IAKO,KAAK,CAAC,aAAa;QAMzB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;QAChD,CAAC;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpD,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QACD,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAEvC,MAAM,UAAU,GAAG,CAAC,GAAW,EAAU,EAAE;YACzC,MAAM,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC;YACxD,IAAI,CAAC,IAAI;gBAAE,OAAO,CAAC,CAAC;YACpB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAC9B,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACvB,OAAO,KAAK,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC9C,CAAC,CAAC;QAEF,MAAM,IAAI,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC;QACvC,MAAM,IAAI,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;QAC5C,MAAM,SAAS,GAAG,UAAU,CAAC,WAAW,CAAC,CAAC;QAE1C,OAAO;YACL,IAAI;YACJ,IAAI;YACJ,SAAS;YACT,SAAS,EAAE,SAAS,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;SAChD,CAAC;IACJ,CAAC;CACF"}
package/package.json ADDED
@@ -0,0 +1,44 @@
1
+ {
2
+ "name": "@omnitron-dev/titan-health",
3
+ "version": "0.1.1",
4
+ "description": "Health check module for Titan framework with extensible indicators",
5
+ "author": "LuxQuant",
6
+ "license": "MIT",
7
+ "type": "module",
8
+ "main": "dist/index.js",
9
+ "types": "dist/index.d.ts",
10
+ "exports": {
11
+ ".": {
12
+ "types": "./dist/index.d.ts",
13
+ "default": "./dist/index.js"
14
+ }
15
+ },
16
+ "files": [
17
+ "dist"
18
+ ],
19
+ "peerDependencies": {
20
+ "ioredis": "^5.8.2",
21
+ "kysely": "0.28.12",
22
+ "@omnitron-dev/titan": "0.1.1"
23
+ },
24
+ "peerDependenciesMeta": {
25
+ "ioredis": {
26
+ "optional": true
27
+ },
28
+ "kysely": {
29
+ "optional": true
30
+ }
31
+ },
32
+ "devDependencies": {
33
+ "@types/node": "25.0.3",
34
+ "reflect-metadata": "^0.2.2",
35
+ "typescript": "^5.9.3",
36
+ "vitest": "^4.1.0"
37
+ },
38
+ "scripts": {
39
+ "build": "rm -rf dist node_modules/.tmp && tsc -p ./tsconfig.json",
40
+ "test": "vitest run",
41
+ "clean": "rm -rf dist",
42
+ "typecheck": "tsc --noEmit"
43
+ }
44
+ }