Maven Profiler

A time execution recorder for Maven which log time taken by each mojo in your build lifecycle.

Installation

$M2_HOME refers to maven installation folder.

.
├── bin
├── boot
├── conf
└── lib

OS X ?

You can install a pre-packaged maven named maven-deluxe using brew. It comes with maven-color, maven-notifier and maven-profiler. It is based on latest maven release.

brew tap jcgay/jcgay
brew install maven-deluxe

Maven >= 3.3.x

Get maven-profiler and copy it in %M2_HOME%/lib/ext folder.

Use the core extensions configuration mechanism by creating a ${maven.multiModuleProjectDirectory}/.mvn/extensions.xml file with:

<?xml version="1.0" encoding="UTF-8"?>
<extensions>
    <extension>
      <groupId>fr.jcgay.maven</groupId>
      <artifactId>maven-profiler</artifactId>
      <version>3.2</version>
    </extension>
</extensions>

Maven >= 3.1.x

Get maven-profiler and copy it in %M2_HOME%/lib/ext folder.

Maven 3.0.x

(with limited functionality, kept for compatibility) Get maven-profiler and copy it in %M2_HOME%/lib/ext folder.

Usage

Use property profile when running Maven.

mvn install -Dprofile

This will generate a report in .profiler folder.

You might also add a profile name, which is included in the report and helps identify the experiment:

mvn clean install -Dprofile="No custom JVM options"
export MAVEN_OPTS='-XX:TieredStopAtLevel=1 -XX:+UseParallelGC'
mvn clean install -Dprofile="With custom JVM options=${MAVEN_OPTS}"

The extension also works when mvn is executed on multiple threads (option -T).

Report format

One can choose between HTML (by default), JSON or CONSOLE report using property profileFormat.

mvn install -Dprofile -DprofileFormat=HTML

Or you can compose multiple reporters separated by comma:

mvn install -Dprofile -DprofileFormat=JSON,HTML,CONSOLE

Change sorting

Also you can add the property disableTimeSorting if you want the reported times to be in the order of execution instead of sorted by execution time.

mvn install -Dprofile -DdisableTimeSorting

Report directory

Report default directory (.profiler) can be customized. You can set it as a Maven property, for example in pom.xml:

<properties>
    <maven-profiler-report-directory>${project.build.directory}/custom-directory</maven-profiler-report-directory>
</properties>

or you can define it using a system property:

mvn install -Dprofile -Dmaven-profiler-report-directory=/tmp/profiler-custom-report

Hide parameters in reports

User parameters could leak sensitive data, you can disable reporting them using:

mvn install -Dprofile -DhideParameters=true

Output examples

HTML

mvn install -Dprofile

JSON

mvn install -Dprofile -DprofileFormat=JSON

{
  "name": "maven-profiler",
  "profile_name": "",
  "time": "44681 ms",
  "goals": "clean install",
  "date": "2017/01/21 19:10:04",
  "parameters": "{profile=true, profileFormat=JSON}",
  "projects": [
    {
      "project": "maven-profiler",
      "time": "43378 ms",
      "mojos": [
        {
          "mojo": "org.apache.maven.plugins:maven-invoker-plugin:2.0.0:run {execution: integration-test}",
          "time": "30706 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-surefire-plugin:2.19.1:test {execution: default-test}",
          "time": "7300 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-shade-plugin:2.4.3:shade {execution: default}",
          "time": "1378 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-compiler-plugin:3.6.0:compile {execution: default-compile}",
          "time": "1112 ms"
        },
        {
          "mojo": "org.codehaus.gmavenplus:gmavenplus-plugin:1.5:testCompile {execution: default}",
          "time": "1102 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-invoker-plugin:2.0.0:install {execution: integration-test}",
          "time": "293 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-enforcer-plugin:1.4.1:enforce {execution: enforce-maven}",
          "time": "225 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-clean-plugin:3.0.0:clean {execution: default-clean}",
          "time": "221 ms"
        },
        {
          "mojo": "org.codehaus.plexus:plexus-component-metadata:1.7.1:generate-metadata {execution: default}",
          "time": "195 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-jar-plugin:3.0.2:jar {execution: default-jar}",
          "time": "167 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-source-plugin:3.0.1:jar-no-fork {execution: attach-sources}",
          "time": "138 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-resources-plugin:3.0.2:resources {execution: default-resources}",
          "time": "106 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-toolchains-plugin:1.1:toolchain {execution: default}",
          "time": "72 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-install-plugin:2.5.2:install {execution: default-install}",
          "time": "46 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-resources-plugin:3.0.2:testResources {execution: default-testResources}",
          "time": "2 ms"
        },
        {
          "mojo": "org.apache.maven.plugins:maven-compiler-plugin:3.6.0:testCompile {execution: default-testCompile}",
          "time": "2 ms"
        }
      ]
    }
  ]
}

CONSOLE

mvn install -Dprofile -DprofileFormat=CONSOLE

╒════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════╕
│ maven-profiler (21,27 s)                                                                                                                                   │
├────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
│ Run install on 2021/12/09 22:10:49 without parameters                                                                                                      │
├────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┤
│ maven-profiler (21,07 s)                                                                                                                                   │
├────────────────────────────────────────────────────────────────────────────────────────────────────┬───────────────────────────────────────────────────────┤
│ Plugin execution                                                                                   │ Duration                                              │
├────────────────────────────────────────────────────────────────────────────────────────────────────┼───────────────────────────────────────────────────────┤
│ org.apache.maven.plugins:maven-invoker-plugin:3.2.2:run {execution: integration-test}              │ 9,085 s                                               │
│ org.apache.maven.plugins:maven-surefire-plugin:2.22.2:test {execution: default-test}               │ 6,286 s                                               │
│ org.codehaus.gmavenplus:gmavenplus-plugin:1.12.1:compileTests {execution: default}                 │ 2,281 s                                               │
│ org.apache.maven.plugins:maven-shade-plugin:3.2.4:shade {execution: default}                       │ 1,264 s                                               │
│ org.apache.maven.plugins:maven-invoker-plugin:3.2.2:install {execution: integration-test}          │ 464,0 ms                                              │
│ org.apache.maven.plugins:maven-enforcer-plugin:1.4.1:enforce {execution: enforce-maven}            │ 339,5 ms                                              │
│ org.apache.maven.plugins:maven-compiler-plugin:3.8.1:compile {execution: default-compile}          │ 269,1 ms                                              │
│ org.codehaus.plexus:plexus-component-metadata:2.1.0:generate-metadata {execution: default}         │ 244,5 ms                                              │
│ org.apache.maven.plugins:maven-jar-plugin:3.2.0:jar {execution: default-jar}                       │ 190,1 ms                                              │
│ org.apache.maven.plugins:maven-source-plugin:3.2.1:jar-no-fork {execution: attach-sources}         │ 132,9 ms                                              │
│ org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources {execution: default-resources}     │ 109,6 ms                                              │
│ org.apache.maven.plugins:maven-install-plugin:2.5.2:install {execution: default-install}           │ 64,26 ms                                              │
│ org.apache.maven.plugins:maven-compiler-plugin:3.8.1:testCompile {execution: default-testCompile}  │ 4,127 ms                                              │
│ org.apache.maven.plugins:maven-resources-plugin:3.2.0:testResources {execution:                    │ 2,532 ms                                              │
│ default-testResources}                                                                             │                                                       │
╘════════════════════════════════════════════════════════════════════════════════════════════════════╧═══════════════════════════════════════════════════════╛