hmrc / play-health Edit

A health monitor endpoint for Play applications

Version Matrix

Play Health Plugin

Apache-2.0 license

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]"

Additionally, add the following to the routes file:

    ->     /                          health.Routes

Compatibility

Release Play Scala
>= 3.15.x 2.7 2.11,2.12
>= 3.15.x 2.6 2.11,2.12
>= 3.15.x 2.5 2.11
3.x.x 2.6 2.11,2.12
3.x.x 2.5 2.11
2.x.x 2.5 2.11
1.x.x 2.3 2.11

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.