Skills
.Work. You
Rest

serverpod-health-checks

Official

Expose Kubernetes-ready health endpoints safely.

Software Engineering#monitoring#dart#readiness#liveness#server health#kubernetes probes#healthindicator
Authorserverpod
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Server operators need reliable, probe-friendly health endpoints that clearly separate liveness from readiness and startup so orchestration systems (like Kubernetes) can make correct routing and restart decisions.

Core Features & Use Cases

  • Liveness endpoint: Use /livez to confirm the process is alive without checking dependencies.
  • Readiness endpoint: Use /readyz to report whether dependencies (like configured DB/Redis) are healthy and return 503 when they are not.
  • Startup endpoint: Use /startupz to indicate the server has finished initializing.
  • Built-in indicators: ServerpodStartupIndicator, DatabaseHealthIndicator, and RedisHealthIndicator (when enabled).
  • Custom health indicators: Add your own HealthIndicator implementations (for example, to check an external service) and register them via HealthConfig.

Quick Start

Configure your Serverpod instance with HealthConfig and add any custom readiness or startup indicators you need, then probe /livez, /readyz, and /startupz on port 8080.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: serverpod-health-checks
Download link: https://github.com/serverpod/serverpod/archive/main.zip#serverpod-health-checks

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.