本文へスキップ

ビルドパックを使用したJavaエージェントのインストール

Gradleを使用するJavaアプリケーションで実行可能なドッカーイメージをビルドする場合は、ビルドパックを使用してエージェントをインストールできます。

WhaTap buildpack基本設定​

build.gradle
tasks.named("bootBuildImage") {
	buildpacks = ["urn:cnb:builder:paketo-buildpacks/java",	
								"docker.io/whatap/paketo-buildpack-apm"]
}

オプション設定​

WhaTap収集サーバーに接続されていないとデータは収集されません。 アクセスキー(accesskey)、WhaTap収集サーバーアドレス(whatap.server.host)情報は必須です。 その他、環境や機能の必要に応じてオプションを追加設定できます。

build.gradle
tasks.named("bootBuildImage") {
  // Whatap 
  environment["BP_WHATAP_ENABLED"] = "true"
  // java 17, There must be a space at the beginning.
  environment["BPE_APPEND_JAVA_TOOL_OPTIONS"] = " --add-opens=java.base/java.lang=ALL-UNNAMED "
  // add multi options, delimeter is linefeed character
  environment["BP_WHATAP_OPTIONS"] = "accesskey=aaa-bbb-ccc\nwhatap.server.host=1.1.1.1/2.2.2.2"

  buildpacks = ["urn:cnb:builder:paketo-buildpacks/java",	"docker.io/whatap/paketo-buildpack-apm"]
}

  • BP_WHATAP_ENABLED

    WhaTapエージェントの有効の有無を設定します。 値がfalseの場合、インストールは続行されますが、モニタリングが停止した状態で開始されます。 後で、WhaTapモニタリングサービスの管理 > エージェント設定メニューからtrueに変更できます。

  • BPE_APPEND_JAVA_TOOL_OPTIONS

    Java17バージョン以降を使用する場合は、必要に応じてjvmオプションを追加してください。

    environment["BPE_DELIM_JAVA_TOOL_OPTIONS"] = " "
    environment["BPE_APPEND_JAVA_TOOL_OPTIONS"] = "--add-opens=java.base/java.lang=ALL-UNNAMED"

    delimeter環境変数を使用しない場合は、前後に空白を追加してください。

    environment["BPE_APPEND_JAVA_TOOL_OPTIONS"] = " --add-opens=java.base/java.lang=ALL-UNNAMED "

  • BP_WHATAP_OPTIONS

    WhaTapエージェント設定を追加できます。 ラインフィード"\n"を区切り文字としてプションを設定します。 オプションはkey=valueとなります。 設定したオプション値は、Docker Image生成段階でwhatap.confファイルに保存されます。

    environment["BP_WHATAP_OPTIONS"] = "accesskey={アクセスキー}\nwhatap.server.host={収集サーバーアドレス}"
    // 例：environment["BP_WHATAP_OPTIONS"] = "accesskey=aaa-bbb-ccc\nwhatap.server.host=1.1.1.1/2.2.2.2"

Tomcat10環境​

Tomcat環境では、weaving=tomcat10オプションを必須で追加する必要があります。

environment["BP_WHATAP_OPTIONS"] = "accesskey={アクセスキー}\nwhatap.server.host={収集サーバーアドレス}\nweaving=tomcat10"

Container実行オプション​

コンテナ(Container) の実行時、環境変数としてアクセスキーとWhaTap収集サーバーアドレスを次のように設定できます。

docker run --rm -p 8080:8080 \
  -e accesskey={アクセスキー} \
  -e whatap.server.host={収集サーバーのアドレス} \
  -e weaving=tomcat10,webflux-6.0 \
  spring-boot-gradle-hello-world-pcketo-buildpack-whatap