Sanitycheck Bundle Laravel Package

Product Decisions This Supports

• Proactive Infrastructure Health Monitoring: Integrate automated, real-time checks for system dependencies (e.g., disk space, permissions, external APIs) to prevent downtime or degraded performance. Reduces reliance on manual monitoring or reactive alerts.
• Pre-Installation/Pre-Deployment Validation: Embed sanity checks in installers or CI/CD pipelines to fail fast if critical requirements (e.g., PHP version, database connectivity) aren’t met, improving deployment reliability.
• Self-Healing or Remediation Workflows: Use checks to trigger automated fixes (e.g., cleaning cache, restarting services) when issues are detected, reducing operational overhead.
• Compliance & Auditing: Ensure systems meet security or regulatory requirements (e.g., file permissions, encryption keys) by automating periodic validation.
• Build vs. Buy: Avoid reinventing custom health-check logic (e.g., cron jobs, scripts) when this bundle offers a maintainable, Symfony-native solution with extensibility.
• Multi-Environment Consistency: Standardize checks across dev/staging/prod to catch environment-specific misconfigurations early (e.g., missing .env variables).

When to Consider This Package

• Look Elsewhere If:

  • You need enterprise-grade monitoring (e.g., Grafana, Datadog) with dashboards, alerting, or historical trend analysis—this is lightweight and check-focused.
  • Your checks require complex metrics (e.g., latency percentiles, custom business logic) beyond binary pass/fail—consider Prometheus or custom solutions.
  • You’re using non-Symfony PHP (e.g., Laravel, plain PHP) without Symfony’s bundle ecosystem—opt for the standalone SanityCheck library.
  • You need integrated alerting (e.g., Slack, PagerDuty)—this bundle runs checks but doesn’t natively trigger notifications (though you can extend it).
  • Your team lacks Symfony familiarity—the bundle assumes Symfony’s dependency injection and event systems.

• Adopt If:

  • You’re a Symfony shop needing lightweight, code-level health checks.
  • Checks are simple but critical (e.g., "Is the queue worker running?" "Are backup directories writable?").
  • You want flexibility to run checks in CLI, installers, or admin panels without tight coupling to a monitoring system.
  • Your team prefers PHP-native solutions over external tools for infrastructure validation.

How to Pitch It (Stakeholders)

For Executives: "This bundle lets us automate ‘health audits’ for our Symfony apps—think of it as a pre-flight check for our infrastructure. For example, it can verify disk space before a deployment, or confirm database connectivity during CI. It’s like adding a ‘smoke detector’ for our systems, but instead of waiting for a fire, we catch issues before they start. Low maintenance, open-source, and it integrates seamlessly with our existing Symfony stack. The cost? Almost zero—just a few lines of code to define what to check."

For Engineering/DevOps: *"SanityCheckBundle gives us a Symfony-native way to embed infrastructure validation anywhere—CLI, installers, or even admin panels. It’s not a replacement for monitoring tools, but it’s perfect for:

• Pre-deployment gates: Fail builds if requirements aren’t met (e.g., ‘PHP 8.1+ required’).
• Self-service checks: Let devs run php bin/console sanitycheck to debug their local environments.
• Custom logic: Need to check if a third-party API is responsive? Define a check in 10 minutes.

It’s MIT-licensed, lightweight, and avoids vendor lock-in. The tradeoff? No built-in alerting or dashboards—we’d need to extend it for those use cases. But for basic sanity checks, it’s a no-brainer."*

For Developers: *"Imagine writing a single check to verify your app’s critical dependencies (e.g., ‘Is the Redis cache reachable?’) and running it automatically before every deploy. This bundle lets you do that with minimal boilerplate. You can:

• Reuse checks: Define once, use in CLI, installers, or controllers.
• Extend easily: Add custom checks by implementing a simple interface.
• Debug locally: Run php bin/console sanitycheck to catch misconfigurations early.

It’s like having a lint tool for your infrastructure. Start small—add checks for your most fragile dependencies—and scale as needed."*