{"id":25103030,"url":"https://github.com/localghost/healthy","last_synced_at":"2025-04-02T07:12:34.345Z","repository":{"id":71716878,"uuid":"156652989","full_name":"localghost/healthy","owner":"localghost","description":"Light health checker with HTTP REST API.","archived":false,"fork":false,"pushed_at":"2019-01-08T05:55:12.000Z","size":3726,"stargazers_count":1,"open_issues_count":13,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-07T21:37:18.659Z","etag":null,"topics":["health-check","healthcheck","rest-api","service-health"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/localghost.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2018-11-08T05:06:34.000Z","updated_at":"2024-03-30T09:36:09.000Z","dependencies_parsed_at":"2023-05-16T09:45:20.863Z","dependency_job_id":null,"html_url":"https://github.com/localghost/healthy","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localghost%2Fhealthy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localghost%2Fhealthy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localghost%2Fhealthy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localghost%2Fhealthy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/localghost","download_url":"https://codeload.github.com/localghost/healthy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246769976,"owners_count":20830771,"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","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":["health-check","healthcheck","rest-api","service-health"],"created_at":"2025-02-07T21:36:38.029Z","updated_at":"2025-04-02T07:12:34.328Z","avatar_url":"https://github.com/localghost.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# healthy [![Build Status](https://travis-ci.org/localghost/healthy.svg?branch=master)](https://travis-ci.org/localghost/healthy) [![Coverage Status](https://coveralls.io/repos/github/localghost/healthy/badge.svg?branch=master)](https://coveralls.io/github/localghost/healthy?branch=master)\n\n_healthy_ is a service that via HTTP REST API exposes current status of configured health checks.\n\nThe main use case for this service is to have single endpoint for checking current status of an entire infrastructure.\nFor example, in CI, after deploying or modifying your infrastructure the test can easily check whether the infrastructure\nis fully operational before executing its scenario.\nThe same in product, having a single check is very convenient for the Ops team to quickly verify product status.\n\n## configuration\n\nConfiguration can be either JSON or YAML or actually anything that is supported by the [spf13/viper](https://github.com/spf13/viper) library.\nConfiguration options can also be set via environment variables with the names of the variables prefixed with `HEALTHY_`, e.g.:\n```\nHEALTHY_SERVER_LISTEN_ON=localhost:8888 ./healthy --config ./healthy.yml \n```\n\nThere are two main configuration sections: `server` and `checks`, for details please see [here](https://github.com/localghost/healthy/wiki/Configuration-schema).\n\n### example\n\n```\nserver:\n  listen_on: 127.0.0.1:8199\n\nchecks:\n  google:\n    type: http\n    url: http://google.com\n  rabbit:\n    type: dial\n    address: 127.0.0.1:5672\n  echo:\n    command: echo \"hello world!\"\n```\n\nOther examples can be found in `examples/`.\n\n## endpoints\n\nCurrently, there are two endpoints available:\n* getting status of selected checks\n  ```bash\n  curl -f http://localhost:8199/v1/check/google\n  curl -f http://localhost:8199/v1/check/google,rabbit\n  ```\n* getting status of all configured checks\n  ```bash\n  curl -f http://localhost:8199/v1/status\n  ```\nIn both cases, success is determined by response with status code 200. Other status codes mean the check has failed.\n\n## docker images   \n\n_healthy_ is also released as docker image available for example as `zkostrzewa/healthy:0.1.0`.\n\nUntil [#20](https://github.com/localghost/healthy/issues/20) is fixed docker image requires mounting custom configuration file to `/etc/healthy/healthy.yml` or `/healthy.yml`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalghost%2Fhealthy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flocalghost%2Fhealthy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalghost%2Fhealthy/lists"}