{"id":15330207,"url":"https://github.com/lhotari/akka-http-health","last_synced_at":"2025-04-15T02:54:09.486Z","repository":{"id":57733937,"uuid":"81428972","full_name":"lhotari/akka-http-health","owner":"lhotari","description":"Library for creating health endpoint checks for Akka Http applications","archived":false,"fork":false,"pushed_at":"2020-02-29T09:08:49.000Z","size":35,"stargazers_count":39,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-15T02:53:59.506Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Scala","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/lhotari.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":"2017-02-09T08:46:10.000Z","updated_at":"2023-04-07T06:42:23.000Z","dependencies_parsed_at":"2022-09-26T22:10:44.602Z","dependency_job_id":null,"html_url":"https://github.com/lhotari/akka-http-health","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhotari%2Fakka-http-health","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhotari%2Fakka-http-health/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhotari%2Fakka-http-health/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lhotari%2Fakka-http-health/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lhotari","download_url":"https://codeload.github.com/lhotari/akka-http-health/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248997090,"owners_count":21195797,"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":[],"created_at":"2024-10-01T09:52:00.128Z","updated_at":"2025-04-15T02:54:09.469Z","avatar_url":"https://github.com/lhotari.png","language":"Scala","funding_links":[],"categories":["容错组件"],"sub_categories":["微服务框架"],"readme":"[![Build Status](https://travis-ci.org/lhotari/akka-http-health.svg?branch=master)](https://travis-ci.org/lhotari/akka-http-health)\n\n# akka-http-health\n\nLibrary for adding `/health` endpoint checks for Akka Http applications.\n\nProvides a default `/health` endpoint that checks:\n* that the memory state is healthy\n* that there is enough available disk space\n\nA load balancer like AWS ELB can be configured to call the health endpoint and\nit could decide to destroy any unhealthy instances.\n\nThis is not a metrics library. Please take a look at [Kamon](http://kamon.io) if you are looking for a metrics and tracing library that's well suited for akka-http applications. \n\n### Getting Started\n\n#### Adding the dependency\n\nsbt 0.13.6+\n```\nresolvers += Resolver.jcenterRepo\nlibraryDependencies += \"io.github.lhotari\" %% \"akka-http-health\" % \"1.0.9\"\n```\nThe library gets published on bintray/jcenter and synchronized from there to Sonatype OSS for staging to Maven central (starting since version `1.0.7`).\nIt's recommended to use the jcenter repository since new releases will be available there instantly.\n\n#### Simple use\n\nThe route instance created by calling `io.github.lhotari.akka.http.health.HealthEndpoint.createDefaultHealthRoute()` will handle `/health` with default settings.\nAppend that route instance to the desired route binding.\n\nBecause of security concerns, it is generally adviced to serve the health endpoint on a separate port that isn't exposed to the public.\n\n#### Advanced use\n\nFor customization, use the trait `io.github.lhotari.akka.http.health.HealthEndpoint` and override protected methods. Calling the `createHealthRoute()` method creates the route instance.\n\n### Contributing\n\nPull requests are welcome.\n\nSome basic guidelines:\n* A few unit tests would help a lot as well - someone has to do that before the PR gets merged.\n* Please rebase the pull request branch against the current master.\n* When writing a commit message please follow [these conventions](http://chris.beams.io/posts/git-commit/#seven-rules).\n* If you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit message (where `XXXX` is the issue number).\n* Add the license header to each source code file (see existing source code files for an example)\n\n### Contact\n\n[Lari Hotari](mailto:lari@hotari.net)\n\n### License\n\nThe library is Open Source Software released under the MIT license. See the [LICENSE file](LICENSE) for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flhotari%2Fakka-http-health","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flhotari%2Fakka-http-health","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flhotari%2Fakka-http-health/lists"}