diff --git a/README.md b/README.md index 05a49028..02a8ccb0 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,27 @@ [![CI](https://github.com/felipebonezi/play-actuator/actions/workflows/continouos-integration.yml/badge.svg)](https://github.com/felipebonezi/play-actuator/actions/workflows/continouos-integration.yml) [![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com) -[![Version](https://img.shields.io/github/v/release/felipebonezi/play-actuator?logo=java)](https://github.com/felipebonezi/play-actuator/releases) -[![CLA assistant](https://cla-assistant.io/readme/badge/felipebonezi/play-actuator)](https://cla-assistant.io/felipebonezi/play-actuator) [![Licence](https://img.shields.io/github/license/felipebonezi/play-actuator?color=blue)](https://github.com/felipebonezi/play-actuator/blob/main/LICENSE) -Play! Framework plugin with actuator actions about your application. +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](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator)) . ## How to use? +[![Version](https://img.shields.io/github/v/release/felipebonezi/play-actuator?logo=java)](https://github.com/felipebonezi/play-actuator/releases) -You must import as project dependency in your `build.sbt` file. +You can import as a project dependency in your `build.sbt` file. ```sbt - libraryDependencies ++= "io.github.felipebonezi" % "play-actuator" % "(version)" + libraryDependencies ++= "io.github.felipebonezi" %% "play-actuator" % "(version)" ``` After that, you need to configure `play.actuator.ActuatorRouter` into project `conf/routes` file. -``` +```scala -> /actuator play.actuator.ActuatorRouter ``` @@ -30,11 +30,13 @@ Run your project and check Actuators endpoints - e.g. `/actuator/health`. ## Actuator endpoints -| Endpoint ID | Description | Path | Ready to use | -|-------------|----------------------------------------------|---------------------|--------------| -| health | Displays your application’s health status. | `/actuator/health` | ✔️ | -| info | Displays information about your application. | `/actuator/info` | ✖️ | -| logfile | Returns the contents of the log file. | `/actuator/logfile` | ✖️ | +Below we have all project endpoints available on this project. + +| Endpoint ID | Description | Path | Ready to use? | +|-------------|----------------------------------------------|---------------------|---------------| +| health | Displays your application’s health status. | `/actuator/health` | ✔️ | +| info | Displays information about your application. | `/actuator/info` | ✖️ | +| logfile | Returns the contents of the log file. | `/actuator/logfile` | ✖️ | ## Health endpoint details @@ -42,12 +44,55 @@ You can check all health indicators by simple activating each configuration. ### Disk Space Indicator +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` -### JDBC Indicator +### Database Indicator + +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!** + +#### JDBC +```sbt + libraryDependencies ++= "io.github.felipebonezi" %% "play-actuator-jdbc-indicator" % "(version)" +``` -`play.actuator.health.indicators.jdbc = true` +#### Slick +```sbt + libraryDependencies ++= "io.github.felipebonezi" %% "play-actuator-slick-indicator" % "(version)" +``` ### Redis Indicator +Show to you information about your Redis connection. +**For now, it only works with [play-redis](https://github.com/KarelCemus/play-redis) as your connector.** + `play.actuator.health.indicators.redis = true` + +## Scala compatibility + +This project is compatible with Scala `2.12` and `2.13`, so you need to use the right version. +Be aware that we're considering to drop `2.12` compatibility, so, we advise you to use `2.13` as your preferred version. + +## Sponsors & Backers + +If you find Play Actuator useful to you, please consider [become a backer](https://github.com/sponsors/felipebonezi). +If your company seems to feel the same, please consider [become a sponsor](https://github.com/sponsors/felipebonezi). + +
+ + + +
+ +### Thank you to all our backers on OpenCollective! + + +