{"id":35539292,"url":"https://github.com/chris-ware/pulse-health-check","last_synced_at":"2026-01-04T04:01:29.663Z","repository":{"id":212180198,"uuid":"730889534","full_name":"chris-ware/pulse-health-check","owner":"chris-ware","description":"Combine the power of Laravel Pulse with Spatie's Health Checks","archived":false,"fork":false,"pushed_at":"2025-12-11T14:04:23.000Z","size":60,"stargazers_count":5,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-12T17:36:00.126Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/chris-ware.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"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}},"created_at":"2023-12-12T22:36:50.000Z","updated_at":"2025-12-11T14:04:25.000Z","dependencies_parsed_at":"2025-08-18T22:06:57.095Z","dependency_job_id":"7e8e7817-0cb7-4b20-b8d4-4216a3074c84","html_url":"https://github.com/chris-ware/pulse-health-check","commit_stats":null,"previous_names":["chris-ware/pulse-health-check"],"tags_count":5,"template":false,"template_full_name":"spatie/package-skeleton-laravel","purl":"pkg:github/chris-ware/pulse-health-check","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-ware%2Fpulse-health-check","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-ware%2Fpulse-health-check/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-ware%2Fpulse-health-check/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-ware%2Fpulse-health-check/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chris-ware","download_url":"https://codeload.github.com/chris-ware/pulse-health-check/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chris-ware%2Fpulse-health-check/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28197443,"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":"2026-01-04T02:00:06.065Z","response_time":58,"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":[],"created_at":"2026-01-04T04:01:01.288Z","updated_at":"2026-01-04T04:01:29.657Z","avatar_url":"https://github.com/chris-ware.png","language":"PHP","funding_links":[],"categories":["Cards"],"sub_categories":["External Services"],"readme":"#  Pulse Health Checks\n\n[![Latest Version on Packagist](https://img.shields.io/packagist/v/chris-ware/pulse-health-check.svg?style=flat-square)](https://packagist.org/packages/chris-ware/pulse-health-check)\n[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/chris-ware/pulse-health-check/run-tests.yml?branch=main\u0026label=tests\u0026style=flat-square)](https://github.com/chris-ware/pulse-health-check/actions?query=workflow%3Arun-tests+branch%3Amain)\n[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/chris-ware/pulse-health-check/fix-php-code-style-issues.yml?branch=main\u0026label=code%20style\u0026style=flat-square)](https://github.com/chris-ware/pulse-health-check/actions?query=workflow%3A\"Fix+PHP+code+style+issues\"+branch%3Amain)\n[![Total Downloads](https://img.shields.io/packagist/dt/chris-ware/pulse-health-check.svg?style=flat-square)](https://packagist.org/packages/chris-ware/pulse-health-check)\n\nCombine the power of Laravel Pulse with Spatie's Health Checks\n\n## Installation\n\nYou can install the package via composer:\n\n```bash\ncomposer require chris-ware/pulse-health-check\n```\n\n## Usage\n\n### Cache Hit Ratio Check\n\nThis check will warn or fail if the cache hit ratio hits a certain percentage threshold. By default, it will fail at 10% hit ratio and warn at 25%.\n\n```php\nuse ChrisWare\\PulseHealthCheck\\Checks\\PulseCacheHitRatioCheck;\n\nPulseCacheHitRatioCheck::new();\n```\n\nConfigure the failure and warning levels:\n\n```php\nuse ChrisWare\\PulseHealthCheck\\Checks\\PulseCacheHitRatioCheck;\n\nPulseCacheHitRatioCheck::new()-\u003efailWhenSizeRatioBelow(25)-\u003ewarnWhenSizeRatioBelow(50);\n```\n### Generic Check\n\nThis generic check will accommodate most basic circumstances for Pulse aggregates. Every check must have a defined `for` method on it for it to understand which aggregate type to use.\n\nExample for slow query aggregation:\n\n```php\nuse ChrisWare\\PulseHealthCheck\\Checks\\PulseCheck;\n\nPulseCheck::new()\n    -\u003efor('slow_query')\n    -\u003efailWhenAbove(5)\n    -\u003ewarnWhenAbove(3)\n    -\u003einterval(\\Carbon\\CarbonInterval::minutes(5));\n```\n\nExample for user request aggregation:\n\n```php\nuse ChrisWare\\PulseHealthCheck\\Checks\\PulseCheck;\n\nPulseCheck::new()\n    -\u003efor('user_request')\n    -\u003eaggregate('count')\n    -\u003efailWhenAbove(500)\n    -\u003ewarnWhenAbove(300)\n    -\u003einterval(\\Carbon\\CarbonInterval::minutes(5));\n```\n\n#### Available methods\n\n**for**: Determine the aggregation type to use\n\n**aggregate**: Determine the aggregation value to use (defaults to `max`)\n\n**failWhenAbove**: Set the value to fail if greater than or equal to\n\n**failWhenBelow**: Set the value to fail if less than or equal to\n\n**warnWhenAbove**: Set the value to warn if greater than or equal to\n\n**warnWhenBelow**: Set the value to warn if less than or equal to\n\n**interval**: The CarbonInterval for aggregations to be evaluated (defaults to 1 hour)\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## Credits\n\n- [Chris Ware](https://github.com/chris-ware)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchris-ware%2Fpulse-health-check","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchris-ware%2Fpulse-health-check","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchris-ware%2Fpulse-health-check/lists"}