Strapi Health Plugin

A lightweight Strapi plugin that provides health check endpoints for monitoring and Kubernetes readiness/liveness probes.

Features

• ✅ Simple health endpoint at /health
• ✅ Returns uptime, status, and timestamp
• ✅ Perfect for Kubernetes readiness/liveness probes
• ✅ Zero configuration required
• ✅ Minimal performance impact

Installation

npm install strapi-health-plugin

After installation, rebuild your Strapi application:

npm run build
# or
strapi build

Usage

Once installed, the plugin automatically exposes a health endpoint at:

GET /health

Response Format

{
  "uptime": 19122.561740091,
  "message": "OK",
  "timestamp": 1696513452150
}

• uptime: Process uptime in seconds
• message: Status message ("OK" when healthy)
• timestamp: Current timestamp in milliseconds

Kubernetes Configuration

Readiness Probe

readinessProbe:
  httpGet:
    path: /health
    port: 1337
  initialDelaySeconds: 30
  periodSeconds: 10

Liveness Probe

livenessProbe:
  httpGet:
    path: /health
    port: 1337
  initialDelaySeconds: 60
  periodSeconds: 30

Docker Health Check

HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
  CMD curl -f http://localhost:1337/health || exit 1

Troubleshooting

Plugin Not Loading

1. Ensure you've run npm run build after installation
2. Check that the plugin is listed in your package.json dependencies
3. Restart your Strapi application

Endpoint Not Accessible

1. Verify your Strapi server is running
2. Check if custom middleware is blocking the endpoint
3. Ensure no conflicting routes exist

Permission Issues

The health endpoint is publicly accessible by default. If you need to restrict access, you can modify the route configuration in your Strapi application.

Contributing

Contributions are welcome! Please read our Contributing Guidelines before submitting PRs.

Releases

This project uses Changesets for automated releases:

npm run changeset  # Add changeset after changes
git push           # Triggers release PR

Security

For security concerns, please see our Security Policy.

License

MIT © Remi Kristelijn

Support

• 🐛 Report bugs
• 💡 Request features
• 💖 Sponsor the project

Made with ❤️ for the Strapi community