cuba-jm's Introduction

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

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

Find the JavaMelody add-on there.

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

By Coordinates

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

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

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

Configuration

Configure monitoring URLs with the cubajm.monitoringUrl application property. Default values are /core-jm/ and /web-jm/ for middleware and web tiers respectively;
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:

<host> and <tier_port> are the location of a tier that interests us;
<context> is the name of the context of the tier;
<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:

http://localhost:8080/app/web-jm/ - web client monitoring
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.

cuba-jm's People

Contributors

Stargazers

Watchers

cuba-jm's Issues

Easy default user and password is not secure

Having admin/admin by default is not secure. These values are easy to guess.

If deploying person forgets to change password (or he/she is not informed about this add-on attached to the system at all) - then we have an open administrative access window to the system to any who knows system URL and has access to web client.

Remove unused properties and gui module

Create add-on credits file

Description

Create information about Software Components file
https://doc.cuba-platform.com/manual-7.2/credits.html

Release 0.6.0 for cuba 7.1.0

Implement centralized statistics gathering for cluster environment

See https://github.com/cuba-platform/cuba-jm/tree/centralized-monitoring and https://github.com/javamelody/javamelody/wiki/UserGuideAdvanced#7-automatic-registration-of-applications

Also, prepare a tutorial for setting up this monitoring for the clustered environment. Make sure that it works in docker-compose with load-balancer.

Update installation instructions

Update the "Installation and configuration" section of readme.md: describe how to install the component using Add-ons Marketplace

JavaMelody statistics is cleared after tomcat restart

How to reproduce:

Deploy application with JavaMelody to a linux tomcat service. E.g. Ubuntu 18.04, "tomcat8" package.
Run for a while
Restart tomcat
Open /core-jm/ page again.

You will see that all graphs have been reset:

The reason is because JavaMelody by default stores its data in a temp directory. E.g. tomcat/temp/javamelody in tomcat-fast-deployment.
And linux tomcat service cleans temp directory on every server restart - which is reasonable thing. So javamelody stats are cleared during every tomcat service restart.

Suggestion: place javamelody stats to other place, e.g. work directory.