CUBA JavaMelody Monitoring Integration Add-On

Overview

The add-on adds an ability to use JavaMelody monitoring in CUBA-based applications.

JavaMelody: monitoring of JavaEE applications [GitHub].

Installation

The add-on can be added to your project in one of the ways described below. Installation from the Marketplace is the simplest way. The last version of the add-on compatible with the used version of the platform will be installed. Also, you can install the add-on by coordinates choosing the required version of the add-on from the table.

In case you want to install the add-on by manual editing or by building from sources see the complete add-ons installation guide in CUBA Platform documentation.

From the Marketplace

1. Open your application in CUBA Studio. Check the latest version of CUBA Studio on the CUBA Platform site.
2. Go to CUBA -> Marketplace in the main menu.

3. Find the JavaMelody add-on there.

4. Click Install and apply the changes. The add-on corresponding to the used platform version will be installed.

By Coordinates

1. Open your application in CUBA Studio. Check the latest version of CUBA Studio on the CUBA Platform site.
2. Go to CUBA -> Marketplace in the main menu.
3. Click the icon in the upper-right corner.

4. Paste the add-on coordinates in the corresponding field as follows:

com.haulmont.addon.cubajm:cuba-jm-global:<add-on version>

where <add-on version> is compatible with the used version of the CUBA platform.

Platform Version	Add-on Version
7.2.x	0.7.1
7.1.0	0.6.0
7.0.0	0.5.1
6.10.0	0.4.0
6.9.0	0.3.1
6.8.1	0.2.0
6.8.0	0.1.0

5. Click Install and apply the changes. The add-on will be installed to your project.

Configuration

1. Configure monitoring URLs with the cubajm.monitoringUrl application property. Default values are /core-jm/ and /web-jm/ for middleware and web tiers respectively;
2. Configure monitoring dashboard authorization credentials with cubajm.authorizedUserLogin & cubajm.authorizedUserPassword application properties. The default values are admin, admin;

All described here application properties can also be found in the JavaMelodyConfig configuration interface.

Usage

When the add-on is installed and configured you can access to the monitoring dashboard by the URL: http://<host>:<tier_port>/<context>/<monitoring_url>/. Where:

1. <host> and <tier_port> are the location of a tier that interests us;
2. <context> is the name of the context of the tier;
3. <monitoring_url> equals to a value that is used for the cubajm.monitoringUrl application property.

Pay attention: trailing slash should be present in the URL.

Example URLs for default settings:

1. http://localhost:8080/app/web-jm/ - web client monitoring
2. http://localhost:8080/app-core/core-jm/ - middleware monitoring

Pay attention: in case of SingleWAR deployment the single monitoring dashboard is used for both middleware and web tiers. It's available by the monitoring URL configured for the middleware block.