A dashboard that shows log output and service state, typically when in a development environment.
The dashboard shows a configured list of services. These services can be:
- Started by this server. The process output then is analyzed to determine the state.
- Logfile, handled like process output.
- External connection, tested to be alive. Can be configured to act as watchdog.
See the built in services.yaml file for service configuration options.
When no services.yaml file is found, a default one (including documentation) is saved to the directory the jar runs from (unless --root is given, see below). The server will update itself when it detects any change in the configuration file.
I created this application in my spare-time while on an assignment in 2018 where a team of developers used it to handle running a few dozen micro-services at development time. Since then I also it on multiple assignments in more companies. So it seems this functionality is helpful in other environments as well. Therefore, I made it available on github.
You can build it yourself (check out this repository and do a mvn clean install) or download
the newest version from rutilo.nl/dashboard.jar (my personal site). When a
new version is available the dashboard will provide an option to update with a single click.
Updates are done by downloading a small patch file (created by ZipDiff)
from the same location.
There are a few command-line options that can (but generally don't need to) be used.
Possible JVM options:
-Dserver.port=<port> Server port (default is 8099 or from services.yaml, 0 for random)
-Droot=<dir> Where to load jars from (default is current directory)
-DpropFile=<file> yaml file (default is services.yaml in local dir, then inner)
-Dnotray Don't add a tray icon
Possible options:
--root[=]<dir> Where to load jars or run commands from (default is current directory)
--server.port=<port> Server port (default is 8099 or from services.yaml, 0 for random)
--notray Don't add a tray icon
--noautostart Ignore the 'start' keys of the services configuration
--startall Act as if all services have the 'start: true' configuration
--config[=]<path> Location where the load the configuration. When a directory path
is provided, 'services.yaml' will be appended.
--configDoc Prints the example services.yaml file that includes documentation
on what fields are available and can be configured per service.
This file will be saved to current directory when started without
a services.yaml to load.