ferstl / jitwatch-jarscan-maven-plugin

A Maven plugin for the JitWatch JarScan Utility

jitwatch-jarscan-maven-plugin

- A Maven plugin for the JITWatch JarScan Tool

The jitwatch-jarscan-maven-plugin integrates JITWatch's JarScan Tool with Apache Maven. It allows you to scan your projects' artifacts and their dependencies during a Maven build. The supported scan modes are:

• maxMethodSize
• sequenceCount
• invokeCount
• nextInstructionFreq
• allocationCount
• instructionCount
• sequenceSearch
• methodSizeHisto
• methodLength

Please refer to the plugin documentation for all configuration options of this plugin.

How to use it

The plugin is available on Maven Central. So no further repository configuration is required.

Option 1: Run it directly on your project

mvn com.github.ferstl:jitwatch-jarscan-maven-plugin:<mode>

# Example
mvn com.github.ferstl:jitwatch-jarscan-maven-plugin:maxMethodSize -Dlimit=325

If you add com.github.ferstl as <pluginGroup> to your settings.xml file, you can just run:

mvn jarscan:maxMethodSize -Dlimit=325

Option 2: Integrate it into your Maven build

The plugin runs during the verify phase by default in order to be able to scan the artifact which was built in the preceding package phase.

<plugin>
  <groupId>com.github.ferstl</groupId>
  <artifactId>jitwatch-jarscan-maven-plugin</artifactId>
  <version>1.1</version>
  <executions>
    <execution>
      <id>max-method-size</id>
      <goals>
        <goal>maxMethodSize</goal>
      </goals>
      <configuration>
        <limit>325</limit>
        <packages>com.github.ferstl</packages>
        <reportFile>${project.build.directory}/jarscan-max-method-size.txt</reportFile>
      </configuration>
    </execution>
  </executions>
</plugin>

FAQ

Q: Where is the plugin documentation?

A: Here: http://ferstl.github.io/jitwatch-jarscan-maven-plugin/plugin-info.html

---

Q: How does this Maven plugin scan the own artifact for a project

A: The plugin runs in the verify phase of the Maven build by default. This phase is after the package phase in the build lifecycle where the JAR file for the project is crated. If you invoke the plugin directly you need to make sure to have a built project artifact in your target folder. The plugin will log a warning if no artifact is found.

---

Q: There are no releases or tags of JITWatch at the moment. How do you integrate it?

A: JITWatch is added to this project as Git submodule. The Maven build for this plugin will copy the classes for the JarScan Tool and makes it part of this project. Take a look at the Git repository of this project to see which revision of JITWatch is used.

Build

Build the Plugin:

# Use --recursive for the submodule
git clone --recursive [e-mail]:ferstl/jitwatch-jarscan-maven-plugin.git
mvn install

# Alternatively inititialize the submodule after cloning:
git clone [e-mail]:ferstl/jitwatch-jarscan-maven-plugin.git
git submodule init
git submodule update
mvn install

Create and deploy the plugin documentation:

mvn site-deploy

Create the Release:

mvn release:prepare -DpreparationGoals="clean deploy site-deploy"

(mvn release:prepare release:perform does not work because the jitWatch sumodule is not checked out during release:perform)