Strapi Health Plugin

!license
!npm total downloads
!PRs Welcome
!GitHub stars
!Last Commit

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

``bash
npm install strapi-health-plugin
`

After installation, rebuild your Strapi application:

`bash
npm run build


or


strapi build
`

Usage

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

`
GET /health
`

$3

`json
{
"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

$3

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

$3

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

Docker Health Check

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

Troubleshooting

$3

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

$3

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

$3

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.

$3

This project uses Changesets for automated releases:

`bash
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