hmrc / play-health

A health monitor endpoint for Play applications

GitHub

#Play Health Plugin

Apache-2.0 license

Build Status Download

Plugin to provide common health check functionality for Play +2.2.3 projects.

##Endpoints

This adds two endpoints:

     /ping/ping     - Returns 200 and an empty body
	 /admin/details - Returns information about the running service

##Setup

Add the jar to the projects dependencies:

    "uk.gov.hmrc" %% "play-health" % "[INSERT VERSION]"

For Java 7 use versions <= 0.8.0

Add plugin to play.plugins:

    {priority}:uk.gov.hmrc.play.health.HealthPlugin

Additionally, add the following to the routes file:

    ->     /                                    health.Routes

Configuration

The plugin expects to find the apps name in the application.conf under the key appName. For the /admin/details endpoint to work as expected, the applications manifest.mf must include a key Implementation-Title with the same value as appName.

License

This code is open source software licensed under the Apache 2.0 License.

Documentation

libraryDependencies += "uk.gov.hmrc" %% "play-health" % "3.1.0-1-g3cf1975"
resolvers += Resolver.bintrayRepo("hmrc", "release-candidates")
Ammonite REPL 
import $ivy.`uk.gov.hmrc::play-health:3.1.0-1-g3cf1975`
import ammonite._, Resolvers._
val res = Resolver.Http(
  "Bintray hmrc release-candidates",
  "Some(https://dl.bintray.com/hmrc/release-candidates)",
  IvyPattern,
  false)
interp.resolvers() = interp.resolvers() :+ res
<dependency>
  <groupId>uk.gov.hmrc</groupId>
  <artifactId>play-health_2.12</artifactId>
  <version>3.1.0-1-g3cf1975</version>
</dependency>
compile group: 'uk.gov.hmrc', name: 'play-health_2.12', version: '3.1.0-1-g3cf1975'
Mill build tool 
ivy"uk.gov.hmrc::play-health:3.1.0-1-g3cf1975"
MavenRepository("https://dl.bintray.com/hmrc/release-candidates")
Try online with Scastie
Try on Scastie

Statistics

Contributors

License

12 Dependencies

Java Dependency