{"id":37019249,"url":"https://github.com/chatwork/healthchecks","last_synced_at":"2026-01-14T02:04:43.060Z","repository":{"id":57718178,"uuid":"354679578","full_name":"chatwork/healthchecks","owner":"chatwork","description":"❌ This is no longer maintained. ❌ tiny healthcheck library for akka-http with Kubernetes liveness/readiness probe support","archived":true,"fork":true,"pushed_at":"2021-04-06T03:17:15.000Z","size":77,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-05T19:52:08.559Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://github.com/everpeace/healthchecks","language":"Scala","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"everpeace/healthchecks","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chatwork.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}},"created_at":"2021-04-05T00:55:00.000Z","updated_at":"2023-08-22T08:54:43.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/chatwork/healthchecks","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/chatwork/healthchecks","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chatwork%2Fhealthchecks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chatwork%2Fhealthchecks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chatwork%2Fhealthchecks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chatwork%2Fhealthchecks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chatwork","download_url":"https://codeload.github.com/chatwork/healthchecks/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chatwork%2Fhealthchecks/sbom","scorecard":{"id":274978,"data":{"date":"2025-08-11","repo":{"name":"github.com/chatwork/healthchecks","commit":"1b87e1c6c5a9b858068234cfc7ecaee9f0ebd344"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.5,"checks":[{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/22 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 21 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T14:12:14.696Z","repository_id":57718178,"created_at":"2025-08-17T14:12:14.696Z","updated_at":"2025-08-17T14:12:14.696Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28408711,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T01:52:23.358Z","status":"online","status_checked_at":"2026-01-14T02:00:06.678Z","response_time":107,"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-14T02:04:42.444Z","updated_at":"2026-01-14T02:04:43.055Z","avatar_url":"https://github.com/chatwork.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# healthchecks\n[![CircleCI](https://circleci.com/gh/chatwork/healthchecks.svg?style=svg)](https://circleci.com/gh/chatwork/healthchecks)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n\ntiny healthcheck library for akka-http with [Kubernetes liveness/readiness probe][k8sprobe] support.\n\n## Installation\n\n```scala\nlibraryDependencies += \"com.chatwork\" %% \"healthchecks-core\" % \u003cversion\u003e\n  \n// when you want kubernetes liveness/readiness probe support.\nlibraryDependencies += \"com.chatwork\" %% \"healthchecks-k8s-probes\" % \u003cversion\u003e\n```\n\n## Getting Started\n- [Simple healthcheck endpoint](#simple-healthcheck-endpoint)\n- [Kubernetes liveness/readiness probe endpoints](#kubernetes-livenessreadiness-probe-endpoints)\n\n### Simple healthcheck endpoint\nAll you need to give is just health check function returning cats `ValidationNel[String, Unit]`.\n\n```scala\n  import akka.actor.ActorSystem\n  import akka.stream.ActorMaterializer\n  import akka.http.scaladsl.Http\n  import akka.http.scaladsl.model.HttpRequest\n  import cats.syntax.validated._\n  import scala.concurrent.Future\n  import scala.util.Random\n\n  implicit val system       = ActorSystem()\n  implicit val materializer = ActorMaterializer()\n  implicit val ec           = system.dispatcher\n\n  import com.github.everpeace.healthchecks._\n  import com.github.everpeace.healthchecks.route._\n\n  // defining sync/async healthchecks\n  val simple = healthCheck(name = \"simple\") {\n    if (Random.nextBoolean()) healthy else \"Unlucky!\".invalidNel\n  }\n\n  val simpleAsync = asyncHealthCheck(\"simpleAsync\") {\n    Future {\n      if (Random.nextBoolean()) healthy else \"Unlucky!\".invalidNel\n    }\n  }\n\n  // start web server listening \"localhost:8888/health\"\n  val serverBinding = Http().bindAndHandle(\n    handler = HealthCheckRoutes.health(simple, simpleAsync),\n    interface = \"localhost\",\n    port = 8888\n  )\n\n  val response = Http().singleRequest(HttpRequest(uri = \"http://localhost:8888/health\"))\n\n  // status code is 200(OK) if healthy, 503(Service Unavailable) if unhealthy.\n  // response body is empty by default for performance.\n  // pass '?full=true' query parameter to see full check result as json. it would be similar to below.\n  // Please see com.github.everpeace.healthchecks.HealthRoutesTest for various response patterns.\n  // {\n  //   \"status\": \"healthy\",\n  //   \"check_results\": [\n  //     { \"name\": \"simple\", \"severity\": \"Fatal\", \"status\": \"healthy\", \"messages\": [] },\n  //     { \"name\": \"simpleAsync\", \"severity\": \"Fatal\", \"status\": \"healthy\", \"messages\": [] }\n  //   ]\n  // }\n```\n\n### Kubernetes liveness/readiness probe endpoints\nIt supports to setup kubernetes liveness/readiness probe really easily like this.  You con configure probe paths and binding setting by typesafe config (i.e. application.conf).  Please refer [reference.conf](k8s-probes/src/main/resources/reference.conf) for details.\n\n```scala\n  import akka.actor.ActorSystem\n  import akka.stream.ActorMaterializer\n  import scala.concurrent.Future\n\n  implicit val system       = ActorSystem()\n  implicit val materializer = ActorMaterializer()\n  implicit val ec           = system.dispatcher\n\n  import com.github.everpeace.healthchecks._\n  import com.github.everpeace.healthchecks.k8s._\n  \n  // by default, listening localhost:8086\n  // and probe paths are\n  //   GET /live\n  //   GET /ready\n  val probeBinding = bindAndHandleProbes(\n    readinessProbe(healthCheck(name = \"readiness_check\")(healthy)),\n    livenessProbe(asyncHealthCheck(name = \"liveness_check\")(Future(healthy)))\n  )\n```\n\nThen you can set kubernetes liveness/readiness probe in the kubernetes manifest like below:\n\n```yaml\n...\n  livenessProbe:\n    httpGet:\n      path: /live\n      port: 8086\n    initialDelaySeconds: 3\n    periodSeconds: 3\n  readinessProbe:\n    httpGet:\n      path: /ready\n      port: 8086\n    initialDelaySeconds: 3\n    periodSeconds: 3\n...\n```\n\n## Contribution policy ##\n\nContributions via GitHub pull requests are gladly accepted from their original author. Along with any pull requests, please state that the contribution is your original work and that you license the work to the project under the project's open source license. Whether or not you state this explicitly, by submitting any copyrighted material via pull request, email, or other means you agree to license the material under the project's open source license and warrant that you have the legal authority to do so.\n\nPlease make sure to follow these conventions:\n- For each contribution there must be a ticket (GitHub issue) with a short descriptive name, e.g. \"Respect host/port configuration setting\"\n- Work should happen in a branch named \"ISSUE-DESCRIPTION\", e.g. \"32-respect-host-and-port\"\n- Before a PR can be merged, all commits must be squashed into one with its message made up from the ticket name and the ticket id, e.g. \"Respect host/port configuration setting (closes #32)\"\n\n## License\nThis code is open source software licensed under MIT License.\n\nPlease note that part of codes in the repository were originally written by [timeoutdigital](https://github.com/timeoutdigital).  Copyright credit presents on relevant sources.\n\n[k8sprobe]: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/ \"Kubernetes liveness/readiness probe\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchatwork%2Fhealthchecks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchatwork%2Fhealthchecks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchatwork%2Fhealthchecks/lists"}