Myaku Health Check Laravel Package

Product Decisions This Supports

• Observability & Reliability: Enables proactive monitoring of critical infrastructure (disk, RAM, DB, cache) with standardized health checks, reducing MTTR (Mean Time to Repair) for outages.
• Security Hardening: Adds IP whitelisting and token-based authentication to /health endpoints, mitigating unauthorized access risks (e.g., scraping, DDoS).
• DevOps Efficiency: Simplifies integration with monitoring tools (e.g., Prometheus, Datadog) via structured JSON responses and HTTP status codes (200/503).
• Roadmap Prioritization:
  • Build vs. Buy: Avoids reinventing health-check logic for Symfony/Laravel apps, accelerating feature delivery.
  • Multi-tenant SaaS: Critical for validating infrastructure health per tenant (e.g., shared hosting environments).
• Use Cases:
  • Incident Response: Automatically flags degraded performance (e.g., disk at 85% → triggers alerts).
  • CI/CD Pipelines: Validates infrastructure health pre-deployment (e.g., fail builds if DB latency > 500ms).
  • SRE Practices: Aligns with SLIs (Service Level Indicators) for uptime/SLOs (e.g., "99.9% DB connectivity").

When to Consider This Package

• Adopt When:

  • Your stack is Symfony 7.4+/8.0+ (or Laravel via Symfony bridge) and needs standardized health checks.
  • You require fine-grained thresholds (e.g., alert at 80% disk usage) with auto-detection of DB/cache.
  • Security is a priority: IP whitelisting + token auth are mandatory for /health.
  • You’re deploying in shared hosting (e.g., Heroku, AWS ECS) where resource monitoring is critical.
  • Your team lacks time to build a custom health-check solution (low-code, MIT-licensed).

• Look Elsewhere If:

  • You’re on PHP < 8.2 or non-Symfony/Laravel (e.g., pure PHP CLI apps).
  • You need Windows/macOS RAM monitoring (Linux-only for now).
  • Your health-check requirements are highly custom (e.g., Kubernetes-specific metrics).
  • You’re using alternative monitoring tools (e.g., Blackbox Exporter) that already cover these checks.
  • Your app is serverless (e.g., AWS Lambda) where disk/RAM checks are irrelevant.

How to Pitch It (Stakeholders)

For Executives:

"This package gives us a turnkey health-check endpoint (/health) that proactively monitors our infrastructure—disk, RAM, database, and cache—with security controls (IP whitelisting + tokens) to prevent abuse. It’s like a ‘check engine’ light for our servers, reducing downtime and alerting us to issues before users notice. For example, if disk space hits 80%, we’ll auto-trigger alerts via our existing monitoring tools. It’s low-risk (MIT license), fast to implement (2 config steps), and future-proof for scaling our SaaS."

ROI:

• Faster incident response: Automated health flags cut troubleshooting time by 30%.
• Security compliance: Token/IP controls meet audit requirements for /health exposure.
• DevOps efficiency: No custom code needed; integrates with Prometheus/Datadog out-of-the-box.

For Engineering:

*"This is a Symfony bundle that solves health checks with minimal setup:

• Auto-detects Doctrine DB and Symfony cache (no manual config).
• Structured JSON responses with thresholds (e.g., threshold_targeted: true for alerts).
• Security-first: Forces x-myaku-token header + IP whitelisting (configurable).
• Cross-platform: Works on Linux (RAM checks), macOS/Windows (disk/DB/cache).

Why not build it?

• 3 hours vs. 3 days: We’d spend weeks writing tests for edge cases (e.g., DB connection errors).
• Battle-tested: Part of the Myaku ecosystem, used in production.
• Extensible: We can override controllers/checks later if needed.

Trade-offs:

• Linux-only RAM monitoring (fine for our AWS/GCP stack).
• Symfony-focused (but we’re migrating to Symfony 8 anyway).

Next Steps:

1. Spike: Test in staging with our current thresholds (e.g., space: 85%).
2. Integrate: Wire responses to our PagerDuty alerts.
3. Document: Add /health to our API spec as a required endpoint for all environments."*