{"id":19756412,"url":"https://github.com/backstagephp/laravel-ok","last_synced_at":"2025-09-06T14:41:12.244Z","repository":{"id":169670331,"uuid":"645677089","full_name":"backstagephp/laravel-ok","owner":"backstagephp","description":"Is your Laravel app OK? This package can monitor and notify you when something is wrong!","archived":false,"fork":false,"pushed_at":"2025-05-12T21:46:46.000Z","size":271,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-12T14:32:50.934Z","etag":null,"topics":["checker","checks","health","laravel","monitor","php","server","status"],"latest_commit_sha":null,"homepage":"https://vormkracht10.nl","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/backstagephp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":"backstagephp"}},"created_at":"2023-05-26T07:28:53.000Z","updated_at":"2025-02-26T15:22:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"f3c24d91-4cc8-4f9d-9a29-d86bbd6e84e0","html_url":"https://github.com/backstagephp/laravel-ok","commit_stats":null,"previous_names":["vormkracht10/laravel-ok","backstagephp/laravel-ok"],"tags_count":0,"template":false,"template_full_name":"vormkracht10/laravel-package-template","purl":"pkg:github/backstagephp/laravel-ok","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backstagephp%2Flaravel-ok","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backstagephp%2Flaravel-ok/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backstagephp%2Flaravel-ok/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backstagephp%2Flaravel-ok/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/backstagephp","download_url":"https://codeload.github.com/backstagephp/laravel-ok/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/backstagephp%2Flaravel-ok/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273918876,"owners_count":25191194,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-06T02:00:13.247Z","response_time":2576,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checker","checks","health","laravel","monitor","php","server","status"],"created_at":"2024-11-12T03:15:50.424Z","updated_at":"2025-09-06T14:41:12.174Z","avatar_url":"https://github.com/backstagephp.png","language":"PHP","funding_links":["https://github.com/sponsors/backstagephp"],"categories":[],"sub_categories":[],"readme":"# Is your Laravel app OK?\n\n[![Total Downloads](https://img.shields.io/packagist/dt/backstage/laravel-ok.svg?style=flat-square)](https://packagist.org/packages/backstage/laravel-ok)\n[![Tests](https://github.com/backstagephp/laravel-ok/actions/workflows/run-tests.yml/badge.svg?branch=main)](https://github.com/backstagephp/laravel-ok/actions/workflows/run-tests.yml)\n[![PHPStan](https://github.com/backstagephp/laravel-ok/actions/workflows/phpstan.yml/badge.svg?branch=main)](https://github.com/backstagephp/laravel-ok/actions/workflows/phpstan.yml)\n![GitHub release (latest by date)](https://img.shields.io/github/v/release/backstagephp/laravel-ok)\n![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/backstage/laravel-ok)\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/backstage/laravel-ok.svg?style=flat-square)](https://packagist.org/packages/backstage/laravel-ok)\n\nHealth checks made in production to ensure you can sleep well at night and be sure everything is still OK.\n\n## Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require backstage/laravel-ok\n```\n\nYou can then install the package by using the `ok:install` Artisan command:\n\n```bash\nphp artisan ok:install\n```\n\nThis is the contents of the published config file:\n\n```php\nreturn [\n    'notifications' =\u003e [\n        'enabled' =\u003e env('LARAVEL_OK_NOTIFICATIONS_ENABLED', true),\n\n        'failed_notification' =\u003e CheckFailedNotification::class,\n\n        'notifiable' =\u003e Notifiable::class,\n\n        'via' =\u003e [\n            // 'discord' =\u003e [\n            //     'channel' =\u003e 123456790,\n            // ],\n            // 'mail' =\u003e [\n            //     'to' =\u003e 'text@example.com',\n            // ],\n            // 'slack' =\u003e [\n            //     'webhook' =\u003e 'webhook-url',\n            // ],\n            // 'telegram' =\u003e [\n            //     'channel' =\u003e 1234567890,\n            // ],\n        ],\n    ],\n\n    'checks' =\u003e [\n        'audit' =\u003e [\n            'path' =\u003e [\n                // '~/some/bin',\n            ],\n        ],\n    ],\n];\n```\n\n## Usage\n\nTo register checks for your application, you need to register them in the `checks` array in your `AppServiceProvider` register method.\n\n```php\n\nuse Backstage\\Laravel\\OK\\Facades\\OK;\n\nclass AppServiceProvider extends ServiceProvider\n{\n    // ...\n\n    public function register()\n    {\n        OK::checks([\n            EnvironmentCheck::shouldBe('production'),\n            DebugModeCheck::shouldBe('false'),\n        ]);\n    }\n}\n```\n\nYou can now run the checks using the `ok:check` Artisan command:\n\n```bash\nphp artisan ok:check\n```\n\n## Available checks\n\n- **Cache Check**: Check whether reading and writing to the cache is possible.\n- **Composer Outdated Check**: Checks whether there are outdated packages in your project and informs you of the findings.\n- **Composer Audit Check**: Checks whether there are any security vulnerabilities in your composer dependencies.\n- **CPU Load Check**: Checks whether the total CPU load is above a certain percentage on a short, mid and long term.\n- **Config Cache Check**: Checks whether the config is cached.\n- **Database Check**: Checks whether a connection can be established on the configured connection.\n- **Database Connection Count Check**: Checks whether the database's connection count exceeds a configurable limit.\n- **Database Size Check**: Checks whether the database's data exceeds a configurable size limit.\n- **Database Table Size Check**: Does the same as the Database Size Check but for a specific table.\n- **Debug Mode Check**: Checks whether debug mode is enabled.\n- **Directory Check**: Checks whether the configured directories exist.\n- **Disk Space Check**: Checks whether the disk space is below a certain threshold.\n- **DotEnv Check**: Checks whether the configured environment variables are accessible in the application.\n- **Environment Check**: Checks whether the current environment matches the configured environment type.\n- **Event Cache Check**: Checks whether events are cached.\n- **Extension Check**: Checks whether the configured PHP extensions are loaded.\n- **File Check**: Does the same as the Directory Check but for files.\n- **Horizon Check**: Checks whether Horizon is running.\n- **Memory Usage Check**: Checks whether the total memory usage exceeds a configurable limit in the form of a percentage.\n- **NPM Audit Check**: Checks whether there are any security vulnerabilities in your npm dependencies.\n- **NPM Installed Package Check**: Checks whether a certain npm package is installed.\n- **OPCache Check**: Checks whether OP cache and optionally the JIT compiler are configured and running.\n- **Permission Check**: Checks whether the configured filesystem items have the correct permissions for the current user.\n- **Ping check**: Checks whether the application can ping the specified address, if the address is not specified it defaults to `www.google.com`.\n- **Process Count Check**: Checks whether the configured programs are exceeding the configured process count.\n- **Queue Check**: Checks whether the queue is running.\n- **Reboot Check**: Checks whether the server has rebooted recently.\n- **Redis Check**: Checks whether the application can connect to the configured redis connections.\n- **Redis Memory Usage Check**: Checks whether the Redis instance is exceeding a configured amount of memory usage.\n- **Route Cache Check**: Checks whether routes are cached.\n- **Scheduler Check**: Checks whether the scheduler has is still online and running jobs.\n- **Storage Check**: Checks whether the configured disks can be written to and read from.\n- **UptimeCheck**: Checks whether the server's uptime exceeds a configured maximum.\n\n## Inspired by\n\nThis package is inspired by [Laravel Health](https://github.com/spatie/laravel-health).\n\n## Testing\n\n```bash\ncomposer test\n```\n\n## Changelog\n\nPlease see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.\n\n## Security Vulnerabilities\n\nPlease review [our security policy](../../security/policy) on how to report security vulnerabilities.\n\n## Credits\n\n-   [Mark van Eijk](https://github.com/markvaneijk)\n-   [Bas van Dinther](https://github.com/baspa)\n-   [David den Haan](https://github.com/daviddenhaan)\n-   [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n-\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackstagephp%2Flaravel-ok","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbackstagephp%2Flaravel-ok","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbackstagephp%2Flaravel-ok/lists"}