Reliability Analyzers

13 analyzers ensuring your application handles errors gracefully, maintains uptime, and prevents runtime failures.

Overview

Reliability analyzers focus on preventing runtime errors, ensuring proper configuration, validating dependencies, and maintaining application stability. These analyzers help catch issues before they cause production outages or user-facing errors.

Key Analyzers

Configuration & Environment

• Cache Prefix Configuration Analyzer - Ensures cache prefix is set to avoid collisions
• Cache Status Analyzer - Validates cache connectivity and functionality
• Composer Validation Analyzer - Ensures composer.json is valid and follows best practices
• Database Status Analyzer - Ensures database connections are accessible and functioning
• Environment Example Documentation Analyzer - Ensures all environment variables used in .env are documented in .env.example for team collaboration
• Environment File Existence Analyzer - Ensures .env file exists, is readable, not empty, and checks for broken symlinks
• Environment Variables Complete Analyzer - Ensures all required environment variables from .env.example are defined in .env
• Maintenance Mode Status Analyzer - Checks if the application is in maintenance mode

Infrastructure & Permissions

• Custom Error Pages Analyzer - Ensures custom error pages are configured to prevent framework fingerprinting
• Directory Write Permissions Analyzer - Ensures critical Laravel directories (storage/, bootstrap/cache/) have proper write permissions

Queue & Database

• Queue Timeout Configuration Analyzer - Ensures queue timeout and retry_after values are properly configured
• Up-to-Date Migrations Analyzer - Ensures all database migrations are up to date and have been executed

Static Analysis

• PHPStan Static Analysis Analyzer - Comprehensive static analysis detecting 13 categories of code reliability issues:
  • Dead Code - Unreachable statements, unused variables, and code with no effect
  • Deprecated Code - Usage of deprecated methods, classes, and functions
  • Foreach Iterable - Invalid foreach usage with non-iterable values
  • Invalid Function Calls - Calls to undefined or incorrectly parameterized functions
  • Invalid Imports - Invalid use statements for non-existent classes
  • Invalid Method Calls - Calls to undefined or incorrectly parameterized methods
  • Invalid Method Overrides - Incompatible method signature overrides
  • Invalid Offset Access - Invalid array offset access and type mismatches
  • Invalid Property Access - Access to undefined or inaccessible properties
  • Missing Model Relations - References to non-existent Eloquent relations
  • Missing Return Statements - Methods with missing return statements
  • Undefined Constants - References to undefined constants
  • Undefined Variables - References to undefined variables

How They Work

Reliability analyzers use a combination of:

1. Static Analysis (PHPStan): Detects code-level issues like undefined variables, invalid method calls, and type mismatches
2. Configuration Validation: Checks Laravel configuration files, environment variables, and Composer dependencies
3. Runtime Checks: Validates that services (cache, database) are accessible and functioning
4. File System Analysis: Verifies file permissions, existence of required files, and directory structure

Severity Levels

Severity	Description	Examples
Critical	Issues that will cause immediate runtime failures	Undefined variables, invalid method calls, missing environment files
High	Issues that may cause failures under certain conditions	Missing migrations, invalid queue configuration, cache connectivity issues
Medium	Issues that reduce reliability or maintainability	Deprecated code usage, dead code, missing return statements
Low	Best practice violations that don't directly impact reliability	Custom error pages, cache prefix configuration

Running Reliability Analyzers

Run All Reliability Analyzers

php artisan shield:analyze --category=reliability

Run Specific Analyzer

php artisan shield:analyze --analyzer=database-status
php artisan shield:analyze --analyzer=up-to-date-migrations
php artisan shield:analyze --analyzer=cache-status

Run Multiple Analyzers

php artisan shield:analyze --analyzer=composer-validation,queue-timeout-configuration,maintenance-mode-status

Best Practices

Development

• Run reliability analyzers before committing code
• Fix Critical and High severity issues immediately
• Use static analysis (PHPStan) to catch issues early

CI/CD

• Run reliability analyzers on every pull request
• Fail builds on Critical severity issues
• Monitor reliability metrics over time

Production

• Schedule periodic reliability checks
• Monitor for configuration drift
• Validate environment variables on deployment

Related Categories

• Security Analyzers - Prevent security vulnerabilities
• Performance Analyzers - Optimize application performance
• Code Quality Analyzers - Maintain code quality standards
• Best Practices Analyzers - Follow Laravel conventions