Skip to main content

Javaエージェントのインストール

Javaエージェントのインストール方法はいくつかありますので、ご利用の環境に合わせて選択してください。 Contrastを使用する場所(例えば、開発環境でAssess、本番環境ではProtectなど)、既存のビルドツール、アプリケーションのデプロイ方法などを考慮する必要があります。

ヒント

エージェントベースのテクノロジを複数使用していて、Contrast Javaエージェントを並行して使用する場合は、起動時にロードされる最初のエージェントとして、Contrast Javaエージェントを必ず指定してください。例:

java -javaagent:contrast.jar -javaagent:newrelic.jar

Contrast Javaエージェントを最初にロードすることで、パフォーマンスへの影響を抑えることができます。

Contrastとホットデプロイ

ホットデプロイとは、アプリケーションサーバのプロセスを停止して再起動することなく、稼働中のサーバに新しいコンポーネント(WARファイル、サーブレット、JSPファイルなど)を追加することを指します。

Contrastエージェントは、ホットデプロイ中もホットリロード中も動作し続けますが、以下の点を考慮してください。

  • ホットデプロイ中に動的に追加または削除されたライブラリは、Contrastで検出されない場合があります。

  • ホットデプロイ中にセッションメタデータは更新されません。

  • 一部のWebSphereユーザで問題が発生する可能性があります。

ホットデプロイでの問題が発生した場合は、アプリケーションサーバを再起動してください。

ContrastとOpenTelemetryエージェント

Contrastエージェントと同じ環境でOpenTelemetryエージェントを使用する場合は、ContrastクラスのOpenTelemetryのインストゥルメンテーションを止めることを検討してください。これにより、Contrastエージェントとの競合を防ぐことができます。

OpenTelemetryのインストルメンテーションを止めるには、この除外を環境変数として追加します。

OTEL_JAVAAGENT_EXCLUDE_CLASSES="com.contrast*"  

または、JVMオプションで指定します。

-Dotel.javaagent.exclude-classes=com.contrast*

クイックスタート

Javaエージェントがどのように動作するか試してみたい場合は、こちらのJavaクイックスタートガイドをご覧ください。

基本のインストール

Javaエージェントのインストールは、ほとんどの場合(Tomcatのなどのアプリケーションサーバ、Dockerなどのコンテナを使用する場合)、Javaエージェントを取得するリポジトリを選択し、各リポジトリの手順に従ってエージェントをダウンロードしてインストールしてください。

ビルドに組み込むインストール

開発環境でAssessを使用しており、脆弱性検出時に既存のソフトウェアプロジェクトでビルド結果を設定したい場合は、以下を参照してエージェントをインストールしてください。