Gradleタスク

JProfilerは特別なタスクを使用してGradleからのプロファイリングをサポートしています。また、JProfilerは スナップショットを操作するためのコマンドラインの実行ファイル を多数提供しており、それらに対応するGradleタスクがあります。

Gradleタスクの使用

JProfilerのGradleタスクをGradleビルドファイルで使用できるようにするには、plugins ブロックを使用します。

plugins {
    id 'com.jprofiler' version 'X.Y.Z'
}

この目的でGradleプラグインリポジトリを使用したくない場合、Gradleプラグインはファイルbin/gradle.jarに同梱されています。

次に、JProfilerのGradleプラグインにJProfilerのインストール場所を指定する必要があります。

jprofiler {
    installDir = file('/path/to/jprofiler/home')
}

Gradleからのプロファイリング

com.jprofiler.gradle.JavaProfileタイプのタスクを使用すると、任意のJavaプロセスをプロファイルできます。 このクラスはGradleの組み込みJavaExecを拡張しているため、プロセスの設定に同じ引数を使用できます。 テストのプロファイリングには、GradleのTestタスクを拡張したcom.jprofiler.gradle.TestProfileタイプのタスクを使用します。

追加の設定なしでは、両方のタスクはインタラクティブなプロファイリングセッションを開始し、プロファイリングエージェントはデフォルトポート8849でJProfiler GUIからの接続を待機します。オフラインプロファイリングの場合、エクスポートされた設定ファイルを参照するか、以下の表に示す属性を使用して共通のセッション設定と自動記録を直接設定できます。

含まれるプロジェクトによってコンパイルされたmainメソッドを持つJavaクラスをプロファイルする例を以下に示します：

task run(type: com.jprofiler.gradle.JavaProfile) {
    mainClass = 'com.mycorp.MyMainClass'
    classpath sourceSets.main.runtimeClasspath
    offline = true
    callTreeMode = 'sampling'
    profile = ['com.mycorp.', 'org.example.']
    snapshotFile = file('build/snapshots/run.jps')
    recording = ['cpu', 'allocation', 'jdbc']
    duration = '10m'
}

設定ファイルなしの属性でカバーされない高度な設定については、設定ファイルをエクスポートし、configFileとsessionIdで参照してください。

task run(type: com.jprofiler.gradle.JavaProfile) {
    mainClass = 'com.mycorp.MyMainClass'
    classpath sourceSets.main.runtimeClasspath
    offline = true
    sessionId = 80
    configFile = file('path/to/jprofiler_config.xml')
}

このタスクの実行可能な例はapi/samples/offlineサンプルプロジェクトで確認できます。標準のJavaExecタスクとは異なり、JavaProfileタスクはcreateProcess()を呼び出すことでバックグラウンドで起動することもできます。この機能のデモについてはapi/samples/mbeanサンプルプロジェクトを参照してください。

プロファイリングに必要なVMパラメーターが必要な場合、com.jprofiler.gradle.SetAgentpathPropertyタスクはpropertyName属性で設定された名前のプロパティにそれを割り当てます。JProfilerプラグインを適用すると、setAgentPathPropertyという名前のこのタイプのタスクがプロジェクトに自動的に追加されます。前の例で使用されるVMパラメーターを取得するには、次のように追加します：

setAgentPathProperty {
    propertyName = 'profilingVmParameter'
    offline = true
    callTreeMode = 'sampling'
    profile = ['com.mycorp.', 'org.example.']
}

をプロジェクトに追加し、setAgentPathPropertyへの依存関係を他のタスクに追加します。その後、そのタスクの実行フェーズでプロジェクトプロパティprofilingVmParameterを使用できます。プロパティを他のタスクプロパティに割り当てる際は、Gradleの設定フェーズではなく実行フェーズにいることを確認するために、その使用箇所をdoFirst {...}コードブロックで囲んでください。

スナップショットからのデータエクスポート

com.jprofiler.gradle.Exportタスクは保存されたスナップショットからビューをエクスポートするために使用でき、 bin/jpexport コマンドラインツールの引数を複製します。 以下の属性をサポートしています：

エクスポートタスクでは、viewsメソッドを呼び出し、クロージャを渡して、その中でview(name, file[, options])を1回または複数回呼び出します。viewへの各呼び出しは1つの出力ファイルを生成します。name引数はビュー名です。利用可能なビュー名の一覧については、 jpexport コマンドライン実行ファイルのヘルプページを参照してください。 引数fileは出力ファイルで、絶対パスまたはプロジェクトからの相対パスのファイルです。最後に、オプションのoptions引数は選択したビューのエクスポートオプションを含むマップです。

エクスポートタスクの使用例：

task export(type: com.jprofiler.gradle.Export) {
    snapshotFile = file('snapshot.jps')
    views {
        view('CallTree', 'callTree.html')
        view('HotSpots', 'hotSpots.html',
            [threadStatus: 'all', expandBacktraces: 'true'])
    }
}

スナップショットの比較

bin/jpcompare コマンドラインツールと同様に、 com.jprofiler.gradle.Compareタスクは2つ以上のスナップショットを比較できます。 その属性は以下の通りです：

エクスポートされたビューがExportタスクに定義されるのと同様に、Compareタスクにはcomparisonsメソッドがあり、comparison(name, file[, options])へのネストされた呼び出しで実行する比較を定義します。利用可能な比較名の一覧は jpcompare コマンドライン実行ファイルのヘルプページで確認できます。

compareタスクの使用例：

task compare(type: com.jprofiler.gradle.Compare) {
    snapshotFiles = files('snapshot1.jps', 'snapshot2.jps')
    comparisons {
        comparison('CallTree', 'callTree.html')
        comparison('HotSpots', 'hotSpots.csv',
            [valueSummation: 'total', format: 'csv'])
    }
}

または、複数のスナップショットのテレメトリー比較を作成する場合：

task compare(type: com.jprofiler.gradle.Compare) {
    snapshotFiles = fileTree(dir: 'snapshots', include: '*.jps')
    sortByTime = true
    comparisons {
        comparison('TelemetryHeap', 'heap.html', [valueType: 'maximum'])
        comparison('ProbeTelemetry', 'jdbc.html', [probeId: 'JdbcProbe'])
    }
}

ヒープスナップショットの分析

Gradleタスクcom.jprofiler.gradle.Analyzeは bin/jpanalyze コマンドラインツールと同じ機能を持ちます。

このタスクには、処理するスナップショットを指定するためのCompareタスクと同様のsnapshotFiles属性と、難読化解除のためのExportタスクと同様のobfuscatorおよびmappingfile属性があります。removeUnreferenced、retainSoft、retainWeak、retainPhantom、retainFinalizer、retained属性はコマンドラインツールの引数に対応します。

Analyzeタスクの使用例を以下に示します：

task analyze(type: com.jprofiler.gradle.Analyze) {
    snapshotFiles = fileTree(dir: 'snapshots', include: '*.jps')
    retainWeak = true
    obfuscator = 'proguard'
    mappingFile = file('obfuscation.txt')
}