rodm / teamcity-jvm-monitor-plugin

A TeamCity plugin that collects JVM related metrics for any JVM running during the build

JVM Monitor Plugin for TeamCity

The JVM Monitor plugin is a Build Feature that can be added to a build configuration to record the garbage collection metrics for any JVM running during the build.

How to install

Download the plugin using the link above and follow the instructions from the TeamCity documentation, Installing Additional Plugins

How to use the plugin

• Edit a build configuration

• Select the Build Features page and click the 'Add build feature' button.

• Select JVM Monitor from the list of features.

When a build runs the garbage collection metrics are recorded into a text file for each Java process. These files are uploaded as build artifacts and presented as graphs in the JVM Monitor tab of the build results page.

How to build the plugin

• To build and package the plugin run ./gradlew build, the plugin is output to the build/distributions directory.

• To deploy and test the plugin the following commands can be used to download and install a server, deploy the plugin and start the server.

• Download and install a TeamCity server run ./gradlew installTeamCity2018.1

• Deploy the plugin run ./gradlew deployPlugin2018.1

• Start the server run ./gradlew startTeamcity2018.1

• To stop the server run ./gradlew stopTeamcity2018.1

Compatibility

The plugin is compatible with TeamCity 2018.1 and later and requires the build agent to be running on Java 8 or later.

License

This plugin is available under the Apache License, Version 2.0.