{"id":18999004,"url":"https://github.com/felipebonezi/play-actuator","last_synced_at":"2025-04-22T14:45:10.946Z","repository":{"id":44372201,"uuid":"511962127","full_name":"felipebonezi/play-actuator","owner":"felipebonezi","description":"Actuator routes for Play! applications.","archived":false,"fork":false,"pushed_at":"2025-04-05T02:07:50.000Z","size":83,"stargazers_count":5,"open_issues_count":7,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-17T04:18:59.673Z","etag":null,"topics":["actuator","health-check","play-actuator","play-framework","playframework","scala"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/felipebonezi.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["felipebonezi"],"open_collective":"felipebonezi"}},"created_at":"2022-07-08T16:40:03.000Z","updated_at":"2024-09-10T21:12:51.000Z","dependencies_parsed_at":"2023-02-18T21:46:01.133Z","dependency_job_id":"85ed9bad-cfb2-41f2-90f0-d705045a1717","html_url":"https://github.com/felipebonezi/play-actuator","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipebonezi%2Fplay-actuator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipebonezi%2Fplay-actuator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipebonezi%2Fplay-actuator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/felipebonezi%2Fplay-actuator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/felipebonezi","download_url":"https://codeload.github.com/felipebonezi/play-actuator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250262264,"owners_count":21401648,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actuator","health-check","play-actuator","play-framework","playframework","scala"],"created_at":"2024-11-08T17:49:03.337Z","updated_at":"2025-04-22T14:45:10.922Z","avatar_url":"https://github.com/felipebonezi.png","language":"Scala","funding_links":["https://github.com/sponsors/felipebonezi","https://opencollective.com/felipebonezi"],"categories":[],"sub_categories":[],"readme":"# play-actuator\n\n[![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)\n[![Renovate](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)\n[![Licence](https://img.shields.io/github/license/felipebonezi/play-actuator?color=blue)](https://github.com/felipebonezi/play-actuator/blob/main/LICENSE)\n\nPlay! Framework plugin with actuator routes that gives you infos about application uptime.\nYou may consider some indicators to define what is `Up` or `Down` for your (check more info at `Health endpoint details`).\n\nThis project is inspired by `Spring Boot Actuator` architecture\n([Check this post to know more about it](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator))\n.\n\n## How to use?\n[![Version](https://img.shields.io/github/v/release/felipebonezi/play-actuator?logo=java)](https://github.com/felipebonezi/play-actuator/releases)\n\nYou can import as a project dependency in your `build.sbt` file.\n\n```sbt\n  libraryDependencies ++= \"io.github.felipebonezi\" %% \"play-actuator\" % \"(version)\"\n```\n\nAfter that, you need to configure `play.actuator.ActuatorRouter` into project `conf/routes` file.\n\n```scala\n-\u003e      /actuator      play.actuator.ActuatorRouter\n```\n\nRun your project and check Actuators endpoints - e.g. `/actuator/health`.\n\n## Actuator endpoints\n\nBelow we have all project endpoints available on this project.\n\n| Endpoint ID | Description                                  | Path                | Ready to use? |\n|-------------|----------------------------------------------|---------------------|---------------|\n| health      | Displays your application’s health status.   | `/actuator/health`  | ✔️            |\n| info        | Displays information about your application. | `/actuator/info`    | ✔️            |\n| logfile     | Returns the contents of the log file.        | `/actuator/logfile` | ✖️            |\n\n## Health endpoint details\n\nYou can check all health indicators by simple activating each configuration.\n\n### Disk Space Indicator\n\nShow to you the total, free and usable disk space.\n\n**No need of any extra dependency, it's under the hood.**\n\n`play.actuator.health.indicators.diskSpace = true`\n\n### Database Indicator\n\nShow to you information about your database using JDBC or Slick connection.\n\n`play.actuator.health.indicators.database = true`\n\nIt depends on which dependency indicator you'll use.\n**You need to choose only one dependency to work with!**\n\n#### JDBC\n```sbt\n  libraryDependencies ++= \"io.github.felipebonezi\" %% \"play-actuator-jdbc-indicator\" % \"(version)\"\n```\n\n#### Slick\n```sbt\n  libraryDependencies ++= \"io.github.felipebonezi\" %% \"play-actuator-slick-indicator\" % \"(version)\"\n```\n\n### Redis Indicator\n\nShow to you information about your Redis connection. \n**For now, it only works with [play-redis](https://github.com/KarelCemus/play-redis) as your connector.**\n\n`play.actuator.health.indicators.redis = true`\n\n```sbt\n  libraryDependencies ++= \"io.github.felipebonezi\" %% \"play-actuator-redis-indicator\" % \"(version)\"\n```\n\n## Info endpoint details\n\nYou can enable to get all operational system info \ninside the JSON return by `/actuator/info` route. Default is disabled.\n\n`play.actuator.info.system.enabled = true`\n\n## Scala compatibility\n\nThis project is compatible with Scala `2.12` and `2.13`, so you need to use the right version.\nBe aware that we're considering to drop `2.12` compatibility, so, we advise you to use `2.13` as your preferred version.\n\n## Sponsors \u0026 Backers\n\nIf you find Play Actuator useful to you, please consider [become a backer](https://github.com/sponsors/felipebonezi).\nIf your company seems to feel the same, please consider [become a sponsor](https://github.com/sponsors/felipebonezi).\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://opencollective.com/felipebonezi\" target=\"_blank\"\u003e\n    \u003cimg src=\"https://opencollective.com/felipebonezi/donate/button@2x.png?color=blue\" width=\"250\" /\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n\n### Thank you to all our backers on OpenCollective!\n\n\u003ca href=\"https://opencollective.com/felipebonezi#section-contributors\"\u003e\u003cimg src=\"https://opencollective.com/felipebonezi/organizations.svg?width=890\u0026button=false\u0026avatarHeight=46\"\u003e\u003c/a\u003e\n\u003ca href=\"https://opencollective.com/felipebonezi#section-contributors\"\u003e\u003cimg src=\"https://opencollective.com/felipebonezi/individuals.svg?width=890\u0026button=false\u0026avatarHeight=46\"\u003e\u003c/a\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelipebonezi%2Fplay-actuator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffelipebonezi%2Fplay-actuator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffelipebonezi%2Fplay-actuator/lists"}