Play! Framework plugin with actuator routes that gives you infos about application uptime. You may consider some indicators to define what is Up or Down for your (check more info at Health endpoint details).

This project is inspired by Spring Boot Actuator architecture (Check this post to know more about it) .

You can import as a project dependency in your build.sbt file. Pick the suffix that matches the Play major your application is on (see Cross-building below).

  // Play 2.9 (existing, unsuffixed coordinates - no migration needed)
  libraryDependencies += "io.github.felipebonezi" %% "play-actuator" % "(version)"

  // Play 3.0 (new)
  libraryDependencies += "io.github.felipebonezi" %% "play-actuator_play30" % "(version)"

After that, you need to configure play.actuator.ActuatorRouter into project conf/routes file.

->      /actuator      play.actuator.ActuatorRouter

Run your project and check Actuators endpoints - e.g. /actuator/health.

Below we have all project endpoints available on this project.

Health endpoints return HTTP 200 when the aggregated status is UP and HTTP 503 when any included indicator is DOWN — so Kubernetes liveness and readiness probes work out of the box. Unknown group names return HTTP 404.

You can check all health indicators by simple activating each configuration.

Show to you the total, free and usable disk space.

No need of any extra dependency, it's under the hood.

play.actuator.health.indicators.diskSpace = true

Show to you information about your database using JDBC or Slick connection.

play.actuator.health.indicators.database = true

It depends on which dependency indicator you'll use. You need to choose only one dependency to work with!

  // Play 2.9
  libraryDependencies += "io.github.felipebonezi" %% "play-actuator-jdbc-indicator" % "(version)"
  // Play 3.0
  libraryDependencies += "io.github.felipebonezi" %% "play-actuator-jdbc-indicator_play30" % "(version)"

  // Play 2.9
  libraryDependencies += "io.github.felipebonezi" %% "play-actuator-slick-indicator" % "(version)"
  // Play 3.0
  libraryDependencies += "io.github.felipebonezi" %% "play-actuator-slick-indicator_play30" % "(version)"

Show to you information about your Redis connection. For now, it only works with play-redis as your connector.

play.actuator.health.indicators.redis = true

  // Play 2.9
  libraryDependencies += "io.github.felipebonezi" %% "play-actuator-redis-indicator" % "(version)"
  // Play 3.0
  libraryDependencies += "io.github.felipebonezi" %% "play-actuator-redis-indicator_play30" % "(version)"

play-actuator ships with two opinionated default groups so Kubernetes probes work without any extra configuration:

Both can be overridden in application.conf. You can also define arbitrary custom groups (each becomes a new /actuator/health/<name> endpoint):

play.actuator.health.groups {
  liveness  { include = ["diskSpace"] }
  readiness { exclude = ["diskSpace"] }

  # any user-defined group
  storage   { include = ["database"]  }
}

include is a whitelist (empty means "all indicators"). exclude always subtracts from the include set.

Add the optional metrics module to expose Micrometer-based JVM metrics and a Prometheus scrape endpoint.

  // Play 2.9
  libraryDependencies += "io.github.felipebonezi" %% "play-actuator-metrics" % "(version)"
  // Play 3.0
  libraryDependencies += "io.github.felipebonezi" %% "play-actuator-metrics_play30" % "(version)"

Then mount the metrics sub-router in conf/routes alongside the main actuator router:

->   /actuator           play.actuator.ActuatorRouter
->   /actuator/metrics   play.actuator.metrics.MetricsRouter

This exposes:

JVM and system meter binders (memory, GC, threads, classloader, processor, uptime, file descriptors) are registered eagerly at startup and can be turned off individually under play.actuator.metrics.bindings.*. Apply common tags to every meter (e.g. application/env) via play.actuator.metrics.common-tags { … }.

You can enable to get all operational system info inside the JSON return by /actuator/info route. Default is disabled.

play.actuator.info.system.enabled = true

play-actuator is published for two Play majors. Pick the coordinate suffix that matches the Play version your application is on:

The Play 2.9 axis continues to publish under the original, unsuffixed coordinates — existing consumers do not need to update their libraryDependencies strings when they pick up a new release. Only the new Play 3.0 axis introduces a coordinate suffix.

For local development, switch axes with the play.version JVM property (or the equivalent PLAY_VERSION env var). The default is Play 2.9:

sbt -Dplay.version=2.9 ++2.13.18 compile test    # Play 2.9 / Scala 2.13
sbt -Dplay.version=3.0 ++2.13.18 compile test    # Play 3.0 / Scala 2.13
sbt -Dplay.version=3.0 ++3.3.6   compile test    # Play 3.0 / Scala 3

This project is published for Scala 2.13 on both Play axes, plus Scala 3.3 (LTS) on the Play 3.0 axis.

If you find Play Actuator useful to you, please consider become a backer. If your company seems to feel the same, please consider become a sponsor.