agiledigital / play2-health-checker-module 5.0.0

GitHub

Scala versions: 2.12

play2-health-checker-module

To install locally

Clone the repository.
Change directory into the cloned repository.
Start sbt.
Publish to local Ivy repository with publishLocal.

To use in an application

First, edit build.sbt to add the dependency:

  libraryDependencies ++= Seq(
    ...
    "au.com.agiledigital" %% "play2-health-checker" % "5.0.0"
    ...
  )

Edit conf/application.conf to add the dependency:

play.modules.enabled += "au.com.agiledigital.healthchecker.HealthCheckerModule"

Finally, add a route to the health check controller into <conf/routes>:

# Wire in the health check controller
GET     /hc                         au.com.agiledigital.healthchecker.controllers.HealthCheckController.checkHealth(serverErrorOnFailure: Boolean ?= true)