diff --git a/README.md b/README.md index 851fd42..66b7c19 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -Vert.x Console -== +# Vert.x Console [![Release](https://jitpack.io/v/yunyu/vertx-console.svg?style=flat-square)](https://jitpack.io/#yunyu/vertx-console) @@ -37,7 +36,7 @@ To use, merge the following into your POM (or the equivalent into your Gradle bu Then, create a `WebConsoleRegistry` in your application with a specified path, add the pages you wish to display, and mount it to a router: - // Example with several pages loaded + // Example with several pages loaded WebConsoleRegistry.create("/admin") // Add pages .addPage(MetricsConsolePage.create(dropwizardRegistry)) @@ -57,8 +56,7 @@ See Vert.x Web documentation for details ([regarding auth](http://vertx.io/docs/ The console will be accessible at the specified path (`/admin` in this example). -vertx-console-metrics -== +# vertx-console-metrics ![](https://i.imgur.com/pWcM3TY.png) @@ -73,7 +71,7 @@ It requires the following dependencies (note: the versions listed may not be the io.vertx vertx-dropwizard-metrics - 3.5.1 + 3.5.4 io.prometheus @@ -107,8 +105,7 @@ If you are not using the [Vert.x launcher](http://vertx.io/docs/vertx-core/java/ The metrics page uses the default Prometheus registry. If you wish to use it with another registry, register the appropriate collectors as [listed here](https://github.com/yunyu/vertx-console-metrics/blob/49a70a5ea43f9bf7d6961278a756d378225f1748/src/main/java/in/yunyul/vertx/console/metrics/MetricsConsolePage.java#L24), and use `MetricsConsolePage.create(CollectorRegistry myPrometheusRegistry)`. -vertx-console-services -== +# vertx-console-services ![](https://i.imgur.com/dfbvdHO.png) @@ -127,8 +124,7 @@ Once these have been added, pass your service discovery instance to the console // Set up web console registry webConsoleRegistry.addPage(ServicesConsolePage.create(discovery)); -vertx-console-logging -== +# vertx-console-logging ![](https://i.imgur.com/KU8PoSX.png) @@ -146,8 +142,7 @@ Once this has been added, you can add the console page directly. For example: // Set up web console registry webConsoleRegistry.addPage(LoggingConsolePage.create()); -vertx-console-circuit-breakers -== +# vertx-console-circuit-breakers ![](https://i.imgur.com/G56nGtH.png) @@ -165,8 +160,7 @@ Once this has been added, you can add the console page directly. For example: // Set up web console registry webConsoleRegistry.addPage(CircuitBreakersConsolePage.create()); -vertx-console-shell -== +# vertx-console-shell ![](https://i.imgur.com/DlmyqeK.png) @@ -181,7 +175,7 @@ It requires the following dependencies (note: the versions listed may not be the io.vertx vertx-shell - 3.5.1 + 3.5.4 Once these have been added, you can add the console page directly. For example: @@ -189,8 +183,7 @@ Once these have been added, you can add the console page directly. For example: // Set up web console registry webConsoleRegistry.addPage(ShellConsolePage.create()); -vertx-console-health -== +# vertx-console-health ![](https://i.imgur.com/W4tKZtw.png) @@ -208,8 +201,7 @@ Once these have been added, pass your health checks instance to the console page // Set up web console registry webConsoleRegistry.addPage(HealthConsolePage.create(healthChecks)); -vertx-console-pools -== +# vertx-console-pools ![](https://i.imgur.com/9w4kk5U.png) @@ -229,8 +221,7 @@ Once these have been added, pass your MetricsService instance to the console pag MetricsService metricsService = MetricsService.create(vertx); webConsoleRegistry.addPage(PoolsConsolePage.create(metricsService)); -vertx-console-eventbus -== +# vertx-console-eventbus ![](https://i.imgur.com/NovstcH.png) @@ -249,12 +240,11 @@ Once these have been added, pass your MetricsService instance to the console pag MetricsService metricsService = MetricsService.create(vertx); webConsoleRegistry.addPage(EventBusConsolePage.create(metricsService)); -vertx-console-http-clients -== +# vertx-console-http-clients ![](https://i.imgur.com/ZMNSQtj.png) -This page provides an overview of the HTTP clients that are used in your application. +This page provides an overview of the HTTP clients that are used in your application. It requires the following dependency (on top of the ones necessary for metrics): @@ -269,8 +259,7 @@ Once these have been added, pass your MetricsService instance to the console pag MetricsService metricsService = MetricsService.create(vertx); webConsoleRegistry.addPage(EventBusConsolePage.create(metricsService)); -API -== +# API Javadocs for the latest version are available [on JitPack](https://jitpack.io/com/github/yunyu/vertx-console/vertx-console-parent/95c911d7f0/javadoc/). diff --git a/pom.xml b/pom.xml index 800f41e..fa69886 100644 --- a/pom.xml +++ b/pom.xml @@ -66,13 +66,13 @@ io.vertx vertx-core - 3.5.1 + 3.5.4 provided io.vertx vertx-web - 3.5.1 + 3.5.4 provided diff --git a/vertx-console-eventbus b/vertx-console-eventbus index 66ba426..02f22ac 160000 --- a/vertx-console-eventbus +++ b/vertx-console-eventbus @@ -1 +1 @@ -Subproject commit 66ba4262195876970cd3417075e202672a30b684 +Subproject commit 02f22ac86f93336f19480f7d0a711dc2403e5d69 diff --git a/vertx-console-health b/vertx-console-health index 090591c..3b90a11 160000 --- a/vertx-console-health +++ b/vertx-console-health @@ -1 +1 @@ -Subproject commit 090591cbeb86309e3f40602454d16aa76c232cd8 +Subproject commit 3b90a1124ce4381a2b96a332461e4810ff7a7624 diff --git a/vertx-console-http-clients b/vertx-console-http-clients index b3337ac..a094798 160000 --- a/vertx-console-http-clients +++ b/vertx-console-http-clients @@ -1 +1 @@ -Subproject commit b3337ace27f0cde21e994544cde1baa05f2736bb +Subproject commit a0947984b918b781c6f479f9942aeb5e887ec9bb diff --git a/vertx-console-metrics b/vertx-console-metrics index 5b736e8..ba560e3 160000 --- a/vertx-console-metrics +++ b/vertx-console-metrics @@ -1 +1 @@ -Subproject commit 5b736e8a506a065dbb3446557a5073777d0f941f +Subproject commit ba560e30492f0130c5f3293237a08d8e56f7d8e4 diff --git a/vertx-console-pools b/vertx-console-pools index 548eee9..318b83d 160000 --- a/vertx-console-pools +++ b/vertx-console-pools @@ -1 +1 @@ -Subproject commit 548eee90e187d5eeb21c888e123074a7e93d1d50 +Subproject commit 318b83d19b31db27c5bd1f876bb72ae4c7bfff92 diff --git a/vertx-console-services b/vertx-console-services index 393c469..277837a 160000 --- a/vertx-console-services +++ b/vertx-console-services @@ -1 +1 @@ -Subproject commit 393c469a876c4558159cd40633006c377109ffaf +Subproject commit 277837afb7f6cb0aa37f4558c6530a47d13eb6e5 diff --git a/vertx-console-shell b/vertx-console-shell index 3a84509..4c4658f 160000 --- a/vertx-console-shell +++ b/vertx-console-shell @@ -1 +1 @@ -Subproject commit 3a845097b8fbad1721a6722fb1e5b4a1514bee21 +Subproject commit 4c4658f670f8f4607f1dc210e4f4d1f561315b73