Health monitor status for admin panel #10186
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ehconitin
commented
Feb 13, 2025
packages/twenty-server/src/engine/core-modules/health/health.controller.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/health.controller.ts
Outdated
Show resolved
Hide resolved
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR implements a comprehensive health monitoring system for the admin panel, adding detailed status checks for core services and message synchronization with proper error handling and caching.
- Added three new health indicators in
/packages/twenty-server/src/engine/core-modules/health/indicators/for database, Redis, and worker status monitoring - Implemented
/healthz/system-statusendpoint inhealth.controller.tsreturning detailed service statuses with typed responses - Added
HealthCacheServicewith time-windowed monitoring for message sync jobs and invalid captcha attempts - Introduced worker health monitoring in
worker.health.tsthat checks active workers across all BullMQ queues - Added proper TypeScript types and enums in
/typesdirectory for consistent health status reporting
10 file(s) reviewed, 10 comment(s)
Edit PR Review Bot Settings | Greptile
packages/twenty-server/src/engine/core-modules/health/health.controller.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/enums/heath-service-status.enum.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/enums/heath-service-status.enum.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/health-cache.service.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/indicators/database.health.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/indicators/database.health.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/indicators/redis.health.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/indicators/redis.health.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/indicators/worker.health.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/types/health-service.types.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/controllers/health.controller.ts
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/admin-panel/admin-panel-health.service.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/admin-panel/admin-panel.service.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/controllers/health.controller.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/indicators/database.health.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/indicators/redis.health.ts
Outdated
Show resolved
Hide resolved
packages/twenty-server/src/engine/core-modules/health/indicators/worker.health.ts
Show resolved
Hide resolved
ehconitin
changed the title
ehconitin
changed the title
FelixMalfait
approved these changes
Feb 18, 2025
|
Thanks @ehconitin for your contribution! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Health Monitoring for Self-Hosted Instances
This PR implements basic health monitoring for self-hosted instances in the admin panel.
Service Status Checks
We're adding real-time health checks for:
Existing Functionality
We already have message sync and captcha counters that store aggregated metrics in cache within a configurable time window (default: 5 minutes).
New Endpoints
/healthz- Basic server health check for Kubernetes pod monitoring/healthz/{serviceName}- Individual service health checks (returns 200 if healthy)/metricsz/{metricName}- Time-windowed metrics (message sync, captcha)All endpoints use the same underlying service, with different presentation layers for infrastructure and UI needs.