Giter VIP home page Giter VIP logo

healthchecks's Introduction

healthchecks

Build Status Download License

tiny healthcheck library for akka-http with Kubernetes liveness/readiness probe support.

Installation

You need to activate sbt-bintray plugin first. And then, You will add it to your build by including these lines in your sbt file. Please refer to download badge above for the latest version.

resolvers += Resolver.bintrayRepo("everpeace","maven")
  
libraryDependencies += "com.github.everpeace" %% "healthchecks-core" % <version>
  
// when you want kubernetes liveness/readiness probe support.
libraryDependencies += "com.github.everpeace" %% "healthchecks-k8s-probes" % <version>

Getting Started

Simple healthcheck endpoint

All you need to give is just health check function returning cats ValidationNel[String, Unit].

  import akka.actor.ActorSystem
  import akka.stream.ActorMaterializer
  import akka.http.scaladsl.Http
  import akka.http.scaladsl.model.HttpRequest
  import cats.syntax.validated._
  import scala.concurrent.Future
  import scala.util.Random

  implicit val system       = ActorSystem()
  implicit val materializer = ActorMaterializer()
  implicit val ec           = system.dispatcher

  import com.github.everpeace.healthchecks._
  import com.github.everpeace.healthchecks.route._

  // defining sync/async healthchecks
  val simple = healthCheck(name = "simple") {
    if (Random.nextBoolean()) healthy else "Unlucky!".invalidNel
  }

  val simpleAsync = asyncHealthCheck("simpleAsync") {
    Future {
      if (Random.nextBoolean()) healthy else "Unlucky!".invalidNel
    }
  }

  // start web server listening "localhost:8888/health"
  val serverBinding = Http().bindAndHandle(
    handler = HealthCheckRoutes.health(simple, simpleAsync),
    interface = "localhost",
    port = 8888
  )

  val response = Http().singleRequest(HttpRequest(uri = "http://localhost:8888/health"))

  // status code is 200(OK) if healthy, 503(Service Unavailable) if unhealthy.
  // response body is empty by default for performance.
  // pass '?full=true' query parameter to see full check result as json. it would be similar to below.
  // Please see com.github.everpeace.healthchecks.HealthRoutesTest for various response patterns.
  // {
  //   "status": "healthy",
  //   "check_results": [
  //     { "name": "simple", "severity": "Fatal", "status": "healthy", "messages": [] },
  //     { "name": "simpleAsync", "severity": "Fatal", "status": "healthy", "messages": [] }
  //   ]
  // }

Kubernetes liveness/readiness probe endpoints

It 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 for details.

  import akka.actor.ActorSystem
  import akka.stream.ActorMaterializer
  import scala.concurrent.Future

  implicit val system       = ActorSystem()
  implicit val materializer = ActorMaterializer()
  implicit val ec           = system.dispatcher

  import com.github.everpeace.healthchecks._
  import com.github.everpeace.healthchecks.k8s._
  
  // by default, listening localhost:8086
  // and probe paths are
  //   GET /live
  //   GET /ready
  val probeBinding = bindAndHandleProbes(
    readinessProbe(healthCheck(name = "readiness_check")(healthy)),
    livenessProbe(asyncHealthCheck(name = "liveness_check")(Future(healthy)))
  )

Then you can set kubernetes liveness/readiness probe in the kubernetes manifest like below:

...
  livenessProbe:
    httpGet:
      path: /live
      port: 8086
    initialDelaySeconds: 3
    periodSeconds: 3
  readinessProbe:
    httpGet:
      path: /ready
      port: 8086
    initialDelaySeconds: 3
    periodSeconds: 3
...

Contribution policy

Contributions 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.

Please make sure to follow these conventions:

  • For each contribution there must be a ticket (GitHub issue) with a short descriptive name, e.g. "Respect host/port configuration setting"
  • Work should happen in a branch named "ISSUE-DESCRIPTION", e.g. "32-respect-host-and-port"
  • 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)"

License

This code is open source software licensed under MIT License.

Please note that part of codes in the repository were originally written by timeoutdigital. Copyright credit presents on relevant sources.

healthchecks's People

Contributors

everpeace avatar j5ik2o avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.