DevGuide

Compilation and development of JavaMelody

Browsing the sources and javadoc

You can browse the development sources from GitHub or you can download the source code zip file of a release which includes the sources of that release.

You can also browse the javadoc.

Building from sources

The "Source code" zip file available in "Releases" contains the java sources with a javamelody-core/pom.xml file for maven. If you want to rebuild the development version and not a particular release, clone from https://github.com/javamelody/javamelody/

After decompressing the zip file or after the checkout, in the javamelody-core directory, you can use the "mvn clean install -DskipTests" command using maven to rebuild the javamelody-core.jar and javamelody-collector-server.war files which are those available in "Releases". You must define the environment variable JAVA_HOME with the path of a JDK 1.8 to compile the sources.

Development

The development is done with Eclipse in its latest version and with the jdk 1.8 for compilation.

The manager of sources is GitHub at https://github.com/javamelody/javamelody/

The charset of files is UTF-8. The style guide is the google's style guide except for tab indentation. The Eclipse configuration is supplied in sources with the configuration of code formater, clean-up, warnings and of checkstyle, pmd, findbugs plugins. The infinitest eclipse plugin is also recommended.

The official languages of the project are french for javadoc but english for technical terms. (This provides a clean separation between functional and technical vocabulary, given that you speak French obviously).

The diagrams in the OpenOffice map or the other one may help to understand.

Tests

The JUnit tests can be launched with the "test" target of the ant script, or with maven.

The manual tests are written in the OpenOffice Test plan.

Plugins

• JIRA/Confluence/Bamboo/Bitbucket plugin : The sources for the JIRA/Confluence/Bamboo/Bitbucket plugin are at https://github.com/javamelody/jira-confluence-javamelody.
• Jenkins plugin : The manager of sources for the Jenkins Monitoring plugin is git at https://github.com/jenkinsci/monitoring-plugin. Use maven commands "mvn hpi:run" or "mvn package" like for all Jenkins plugins.
• Grails plugin : The manager of sources for the JavaMelody Grails plugin is git at https://github.com/javamelody/grails-melody-plugin (previously Subversion at http://svn.codehaus.org/grails-plugins/grails-grails-melody/trunk/)
• Liferay plugin : The manager of sources for the JavaMelody plugin for Liferay is git at https://github.com/javamelody/liferay-javamelody
• Alfresco plugin : The manager of sources for the JavaMelody plugin for Alfresco is git at https://github.com/javamelody/alfresco-javamelody
• Sonar plugin : The manager of sources for the JavaMelody plugin for Sonar is git at https://github.com/javamelody/sonar-javamelody

Other plugins

• Gerrit server plugin : There is also a Gerrit server plugin by David Ostrovsky. The manager of sources is Git at https://gerrit.googlesource.com/plugins/javamelody/+/master
• Nagios plugin : There is also a Nagios plugin by Shawn Bower based on a command reading the last values in the RRD files (it starts a JVM for each value, which may not scale a lot). The manager of sources is Git at https://github.com/sbower/nagios_javamelody_plugin
• Newer Nagios plugin : Another newer Nagios plugin by Armon Dressler based on http requests returning monitoring data as JSON.

Release process

This is an internal reminder of the steps of the release process.

• Edit Maven password
• run release script: https://github.com/javamelody/javamelody/blob/master/javamelody-release.cmd after set releaseVersion=x.y.z and set developmentVersion=x.y.z-SNAPSHOT
• Maven central
  • https://oss.sonatype.org/ : log in, close and release to publish artefacts in Maven central
• update Release notes with version
• jenkins plugin (https://plugins.jenkins.io/monitoring)
  • add release from created tag with release notes for version: https://github.com/jenkinsci/monitoring-plugin/releases
• jira / confluence / bamboo / bitbucket plugin
  • login https://plugins.atlassian.com/plugins/net.bull.javamelody
  • add version from releases
• liferay plugin
  • Login and Add new version from releases to the Liferay Marketplace
• wait artefacts to be available in Maven central http://search.maven.org/#search|ga|1|javamelody
• increment maven version in UserGuide#Dependencies and in SpringBootStarter
• grails plugin (https://github.com/javamelody/grails-melody-plugin, grails documentation), maintainer : Sergio Michels
  • increment javamelody-core and plugin versions in build.gradle
  • edit user / password in .grails\settings.groovy
  • grails clean && grails compile && grails publish-plugin
  • (See plugin in http://grails.org/plugin/grails-melody http://www.grails.org/plugins.html#plugin/grails-melody-plugin)
• update latest version in javamelody.org
• twitter announce https://twitter.com/#!/java_melody
• users' group announce https://groups.google.com/forum/?fromgroups#!forum/javamelody (example)