{"id":13682753,"url":"https://github.com/kubukoz/sup","last_synced_at":"2025-04-06T00:08:54.601Z","repository":{"id":33856380,"uuid":"162462175","full_name":"kubukoz/sup","owner":"kubukoz","description":"Composable, purely functional healthchecks in Scala.","archived":false,"fork":false,"pushed_at":"2024-09-03T21:37:09.000Z","size":1943,"stargazers_count":185,"open_issues_count":25,"forks_count":27,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-29T22:09:03.808Z","etag":null,"topics":["cats","cats-effect","fp","functional","functional-programming","health","healthcheck","scala","typelevel"],"latest_commit_sha":null,"homepage":"https://sup.kubukoz.com","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kubukoz.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-12-19T16:17:23.000Z","updated_at":"2024-08-28T17:44:56.000Z","dependencies_parsed_at":"2024-11-16T19:02:30.143Z","dependency_job_id":null,"html_url":"https://github.com/kubukoz/sup","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubukoz%2Fsup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubukoz%2Fsup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubukoz%2Fsup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubukoz%2Fsup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kubukoz","download_url":"https://codeload.github.com/kubukoz/sup/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415967,"owners_count":20935387,"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":["cats","cats-effect","fp","functional","functional-programming","health","healthcheck","scala","typelevel"],"created_at":"2024-08-02T13:01:52.588Z","updated_at":"2025-04-06T00:08:54.575Z","avatar_url":"https://github.com/kubukoz.png","language":"Scala","funding_links":[],"categories":["Scala"],"sub_categories":[],"readme":"# sup\n\n[![Join the chat at https://gitter.im/sup-scala/community](https://badges.gitter.im/sup-scala/community.svg)](https://gitter.im/sup-scala/community?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n[![Build Status](https://travis-ci.com/kubukoz/sup.svg?branch=master)](https://travis-ci.com/kubukoz/sup)\n[![Latest version](https://index.scala-lang.org/kubukoz/sup/sup-core/latest.svg)](https://index.scala-lang.org/kubukoz/sup/sup-core)\n[![Maven Central](https://img.shields.io/maven-central/v/com.kubukoz/sup-core_2.12.svg)](http://search.maven.org/#search%7Cga%7C1%7Csup-core)\n[![License](http://img.shields.io/:license-Apache%202-green.svg)](http://www.apache.org/licenses/LICENSE-2.0.txt)\n\n[![Powered by cats](https://img.shields.io/badge/powered%20by-cats-blue.svg)](https://github.com/typelevel/cats)\n![Gluten free](https://img.shields.io/badge/gluten-free-orange.svg)\n\n\n'sup (/sʌp/) provides composable, purely functional healthchecks.\n\n```\n\"com.kubukoz\" %% \"sup-core\" % supVersion\n```\n\nCheck out [the microsite](https://sup.kubukoz.com) and [the usage guide](https://sup.kubukoz.com/guide). \n\n## Why?\n\nIf your application has any external dependencies, its ability to work properly relies on the availability of these dependencies.\nMost applications communicate with at least one database, and sometimes a service provided by someone else (e.g. Amazon S3, PayPal and so on).\nIt's also common to talk to a message broker (Kafka, RabbitMQ, ActiveMQ, etc.). In the microservice world, your applications will probably talk to each other, as welll.\n\nThe last thing you want to happen is some other system's problem causing downtime in yours.\nWe're living in a world where [the network isn't reliable](https://en.wikipedia.org/wiki/Network_partition),\nand even healthy services can fail to respond to your requests due to network issues at any time.\n\nBy relying on systems living beyond your application's control, you reduce your [SLA](https://en.wikipedia.org/wiki/Service-level_agreement)\nto the lowest SLA of your dependencies. Even if your application has nine nines of availability (99.9999999%) on its own,\nbut it requires S3 (with uptime of 99.9%) to be up, your application is only available for 99.9% of the time.\n \nBecause of the risk associated with external services, modern applications employ a range of fault tolerance and isolation mechanisms,\nlike circuit breakers, rate limiters and bulkheads.\nTo ensure that our applications handle failure properly, and that we can react to problems in the system\nknowing what exactly doesn't work, we also track its health by\n[monitoring](https://docs.microsoft.com/en-us/azure/architecture/best-practices/monitoring), tracing and other diagnostics.\n\nWe also use health checks.\n\n## Health checks\n\nThe health check pattern usually involves having an API endpoint that reports the health of your application,\nincluding the health of each external dependency. It's reasonable that the information the endpoint exposes be cached\nand automatically refreshed, and protected by a circuit breaker to ensure that checking the health\ndoesn't make matters worse.\n\n## Goals of this project\n\nThe main goal of sup is to provide a reusable model for working with health checks, as well as\na range of utilities for customizing them by e.g. adding timeouts or error recovery.\nIt also provides implementations for health checks of some popular integrations (JDBC, HTTP, etc.).\n\nIt's a design decision not to include any sort of metrics, response times, version information or other statistics\nin sup - they are simply beyond the scope of health checks.\nAlthough some of these can be implemented by users and used with sup, they're not officially supported.\n\nAnother design decision is that health is binary - a service is either healthy or not,\nand there's no \"unknown\" state.\n\n\n## Code of conduct\n\nThis project supports the [Scala code of conduct](https://www.scala-lang.org/conduct/) and wants communication on all its channels (GitHub etc.) to be inclusive environments.\n\nIf you have any concerns about someone's behavior on these channels, contact [Jakub Kozłowski](mailto:kubukoz@gmail.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubukoz%2Fsup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkubukoz%2Fsup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubukoz%2Fsup/lists"}