{"id":36294080,"url":"https://github.com/cego/service-health-checking","last_synced_at":"2026-01-11T10:01:35.362Z","repository":{"id":40430744,"uuid":"413414197","full_name":"cego/service-health-checking","owner":"cego","description":"Package that helps implement health checks for services","archived":false,"fork":false,"pushed_at":"2025-03-14T14:39:26.000Z","size":120,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-09-23T22:42:06.214Z","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":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cego.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2021-10-04T12:35:21.000Z","updated_at":"2025-03-14T14:38:54.000Z","dependencies_parsed_at":"2023-12-15T03:41:30.076Z","dependency_job_id":"d1788517-6304-4c1a-9a93-4ddea7ecf382","html_url":"https://github.com/cego/service-health-checking","commit_stats":{"total_commits":52,"total_committers":4,"mean_commits":13.0,"dds":"0.15384615384615385","last_synced_commit":"b2dd9c870a423738f0dd1fd4b885c895d4e440b2"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"purl":"pkg:github/cego/service-health-checking","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cego%2Fservice-health-checking","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cego%2Fservice-health-checking/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cego%2Fservice-health-checking/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cego%2Fservice-health-checking/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cego","download_url":"https://codeload.github.com/cego/service-health-checking/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cego%2Fservice-health-checking/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28299709,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-11T08:21:30.231Z","status":"ssl_error","status_checked_at":"2026-01-11T08:21:26.882Z","response_time":60,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-11T10:01:21.665Z","updated_at":"2026-01-11T10:01:35.354Z","avatar_url":"https://github.com/cego.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Service Health Checking\nThis package contains core functionality for HTTP health checking of Laravel services.\n\n## Usage\nWhen the package is installed, a health endpoint, `/vendor/service-health-checking` is exposed. The endpoint\nreturns `200 OK` and a body with a JSON data object with the following format:\n```json\n{\n    \"status\": \"pass|warn|fail\",\n    \"checks\": [\n        {\n            \"status\": \"pass|warn|fail\",\n            \"name\": \"HealthCheckClassName\",\n            \"description\": \"Description defined in the health check class\",\n            \"message\": \"Message set in the HealthStatus object\"\n        }\n    ]\n}\n```\nThe `checks` array contains an entry for each registered health check.\n\n## Creating health checks\nTo create a health check for your service, simply create a class that extends\n`\\Cego\\ServiceHealthChecking\\BaseHealthCheck`. The base method has 2 abstract methods:\n1. `check(): HealthStatus` should perform the check and return a `HealthStatus` object.\n2. `getDescription(): string` should return a description of the health check.\n\n## Registering health checks\nFirstly, publish the package assets by running:\n```\nphp artisan vendor:publish --provider=\"Cego\\ServiceHealthChecking\\ServiceHealthCheckingServiceProvider\"\n```\nThe package will publish a config file, `service-health-checking.php`, in which health check classes must be \nregistered, in order for them to run. The package is shipped with a basic database connection check, which is registered \nby default.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcego%2Fservice-health-checking","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcego%2Fservice-health-checking","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcego%2Fservice-health-checking/lists"}