diff --git a/README.md b/README.md index d229b52..a641d2b 100644 --- a/README.md +++ b/README.md @@ -7,68 +7,82 @@ An application for monitoring, profiling and inspecting a running eXist-db instance. ## Features + The app includes: -* **Monitoring dashboard**: shows memory usage, running queries, locked threads, cache usage and more -* **Query profiling** page: essential for tuning queries and indexes -* **Index browser**: inspect existing indexes -* **Remote console**: send log messages from any query in eXist to the remote console. +- **Monitoring dashboard**: shows memory usage, running queries, locked threads, cache usage and more +- **Query profiling** page: essential for tuning queries and indexes +- **Index browser**: inspect existing indexes +- **Remote console**: send log messages from any query in eXist to the remote console. Uses web sockets for real-time updates. -* **Data visualizer**: get a quick overview of the frequency of elements in a collection. -* **Remote Monitoring**: monitor multiple remote eXistdb instances. Provides timelines for long term monitoring. +- **Data visualizer**: get a quick overview of the frequency of elements in a collection. +- **Remote Monitoring**: monitor multiple remote eXistdb instances. Provides timelines for long term monitoring. ## Configure Monex ### Enable Remote Monitoring #### Preconditions -Monex remote monitoring requires the eXistdb scheduler module to be enabled. Make sure it is enabled in *$eXistdb_home/extensions/build.properties* - # Scheduler module - include.module.scheduler = true +Monex remote monitoring requires the eXistdb scheduler module to be enabled. Make sure it is enabled in `$eXistdb_home/extensions/build.properties` -and in *$eXistdb_home/conf.xml* make sure the Scheduler module is not commented out: +```txt +# Scheduler module +include.module.scheduler = true +``` - +and in `$eXistdb_home/conf.xml` make sure the Scheduler module is not commented out: +```xml + +``` ##### Rebuilding eXistdb -This needs only to be done if *include.module.scheduler* in *extensions/build.properties* was set to *false*. Then eXistdb has to be rebuild to enable the scheduler module. Shutdown the database and in the root of the eXistdb project simply call - ./build.sh +This needs only to be done if `include.module.scheduler` in `extensions/build.properties` was set to `false`. Then eXistdb has to be rebuild to enable the scheduler module. Shutdown the database and in the root of the eXistdb project simply call + +```shell +./build.sh +``` After starting the database again, the remote monitoring tab should show no more error warnings. #### Adding an eXistdb instance to monitor -For each eXistdb instance to monitor its url and its unique token is needed. The token can be found in the data directory on the filesystem . The file is called *jmxservlet.token*. The path to the data directory can be found in *$existdb_home/conf.xml* - +For each eXistdb instance to monitor its url and its unique token is needed. The token can be found in the data directory on the filesystem . The file is called `jmxservlet.token`. The path to the data directory can be found in `$existdb_home/conf.xml` -Each eXistdb installation to monitor is added as an instance entry at */db/apps/monex/instances.xml*. - -**Sample Monex Instances** +```xml + +``` - - - - - - - +Each eXistdb installation to monitor is added as an instance entry at `/db/apps/monex/instances.xml`. + +#### Sample Monex Instances + +```xml + + + + + + + +``` In the Monex Remote Monitoring tab click "Run" to start all remote monitoring jobs. You should now see an entry "localhost" beneath "Remote Monitoring" and beneath that an entry "Timelines". - ## Building + If you wish to build Monex from source code you should follow these steps: -1. Ensure you have Git, Apache Maven 3.3+, and Java JDK 8 installed and available: +1. Ensure you have Git, Apache Maven 3.3+, and Java JDK 8 installed and available: + ```bash $ git --version git version 2.20.0 @@ -82,11 +96,80 @@ Default locale: en_GB, platform encoding: UTF-8 OS name: "mac os x", version: "10.14.1", arch: "x86_64", family: "mac" ``` -3. Clone and build an EXPath package by running: +1. Clone and build an EXPath package by running: + ```bash -$ git clone https://github.com/eXist-db/monex.git -$ cd monex -$ mvn package +git clone https://github.com/eXist-db/monex.git +cd monex +mvn package ``` The resulting XAR will be in the `target/` folder. + +## Release Procedure + +This project is configured to use the [Maven Release Plugin](https://maven.apache.org/maven-release/maven-release-plugin/) to make creating and subsequently publishing a release easy. + +The release plugin will take care of: + +1. Testing the project (all tests must pass) +2. Verifying all rules, e.g. license declarations present, etc. +3. Creating a Git Tag and pushing the Tag to GitHub +4. Building and signing the artifacts (e.g. EXPath Pkg `.xar` file). + +Before performing the release, in addition to the Build requirements you need an installed and functioning copy of GPG or [GnuPG](https://gnupg.org/) with your private key setup correctly for signing. + +Only users with push access to the GitHub repo can act as release manager. + +### Preparation + +Before creating the release, check if: + +- [ ] the changelog is up-to-date for the planned release? +- [ ] the target versions for eXistdb are correctly declared in `pom.xml`? + + ```xml + 5.4.0 + 7.0.0-SNAPSHOT + ``` + + +#### Changelog + +To edit release notes for the planned release within `xar-assembly.xml` located in the root of this repo, e.g.: + +```xml + + +
    +
  • Breaking: Due to internal API changes this version of monex requires eXist-db version 6.1.0 or later - #210, #223
    • +
  • Fixed: Added missing release notes for 3.0.5 release - #217
    • +
+ + +``` + +### Release + +To perform the release, from within your local Git cloned repository run: + +```bash +mvn release:prepare && mvn release:perform +``` + +You will be prompted for the answers to a few questions along the way. The default response will be provided for you, and you can simply press "Enter" (or "Return") to accept it. Alternatively you may enter your own value and press "Enter" (or "Return"). + +```bash +What is the release version for "monex"? (org.exist-db.apps:monex) 2.3.1: : 2.4.0 +What is SCM release tag or label for "monex"? (org.exist-db.apps:monex) 2.4.0: : +What is the new development version for "monex"? (org.exist-db.apps:monex) 2.4.1-SNAPSHOT: : +``` + +- For the `release version`, please sensibly consider using the next appropriate [SemVer 2.0.0](https://semver.org/) version number. +- For the `SCM release tag`, please use the same value as the `release version`. +- For the `new development version`, the default value should always suffice. + +Once the release process completes, there will be a `.xar` file in the `target/` sub-folder. This file may be published to: + +1. [GitHub Releases](https://github.com/eXist-db/monex/releases) +2. [The eXist-db Public EXPath Repository](https://exist-db.org/exist/apps/public-repo/admin) \ No newline at end of file