Skip to main content

.NET FrameworkエージェントのWindowsインストーラ

Contrast .NET Frameworkエージェントのインストーラは、標準のMSIを利用して作られたWindowsアプリケーションの一般的なインストーラです。インストーラは、対象となるサーバが要件(サーバのオペレーティングシステムがサポート対象であることなど)を満たしいるかを検証します。サーバが全ての要件を満たしていれば、インストーラによって以下が行われます。

  • .NET FrameworkエージェントをWindowsの標準プログラムとして登録します。

  • 指定されたインストール場所(例、 C:\Program Files\Contrast\dotnet)にエージェントのファイルを配置します。これには、いくつかのダイナミックリンクライブラリ(DLL)や、エージェントをバックグランドで動作させるWindowsサービスなどの実行ファイルが含まれます。

  • エージェントのログファイルや設定を主に保存するためのデータディレクトリ(例、C:\ProgramData\Contrast\dotnet)を作成します。

  • エージェントをバックグラウンドで実行させるWindowsサービスをオペレーティングシステムに登録します。

  • エージェントのネイティブモジュールをIISに追加します。ネイティブモジュールは、環境変数によってエージェントのプロファイラコンポーネントをIISに登録します。これにより、CLRはエージェントのプロファイラをロードし、解析対象のアプリケーションにエージェントが組み込まれます。

  • エージェントのWindowsサービスとContrastトレイアプリケーションを起動します。このサービスは次の処理を行います。

    • ローカルの名前付きパイプによって、プロファイラとセンサコンポーネントとを通信します。

注記

Contrast Webインターフェイスから.NET Frameworkエージェントをインストール:

Contrast Webインターフェイスから.NET Frameworkエージェントをインストール

  1. Contrast Webインターフェイスで、右上の新規登録を選択します。

  2. アプリケーション言語のドロップダウンメニューで.NET Frameworkを選択し、IISでホストを選択したら、エージェントとYAML設定ファイルをダウンロードへのリンクを選択します。

  3. ダウンロードしたZIPアーカイブをWebサーバに展開し、ContrastSetup.exeを実行します。これで、.NET Frameworkエージェントがインストールされます。

    インストーラによって、contrast_security.yamlファイルがエージェントのデータディレクトリにコピーされます。デフォルトは、C:\ProgramData\Contrast\dotnet\contrast_security.yamlになります。コピー先に既にYAMLファイルが存在する場合は、インストーラはYAMLファイルをコピーしません。

    • コマンドラインを使用すると、.NET FrameworkエージェントのWindowsインストーラでサポートされるその他のオプションを利用できます。

    • この環境で別のプロファイラ(New RelicやAppDynamicsなどのAPMなど)を使用している場合は、Contrastプロファイラチェーンを有効にする必要があります。

  4. NET FrameworkエージェントのYAMLテンプレートを使用して、.NET Frameworkエージェントの設定をより詳細に指定できます。

  5. 通常通りにアプリケーションを疎通し、Contrastでアプリケーションが認識されていることを確認します。

    解析する必要のないアプリケーションがある場合や、パフォーマンスの有効活用を考える場合には、アプリケーションプールを利用して検査対象のアプリケーションの数を制限することを検討してください。

コマンドラインから.NET Frameworkエージェントをインストール

コマンドラインを使用してインストールすると、.NET FrameworkエージェントのWindowsインストーラでサポートされるその他のオプションを利用できます。

.NETエージェントは、Windowsのインターフェイスを使用してインストールし、Windowsの標準機能(コントロールパネルのプログラムと機能やPowershellなど)を使用してアンインストールや修復を行うことができます。ただし、自動化されたスクリプトなどの特定のシナリオでは、.NET FrameworkエージェントのWindowsインストーラを使用して、以下の操作が必要な場合があります。

有人モードには、以下のコマンドを使用します。

  • インストール: ContrastSetup.exe

  • アンインストール: ContrastSetup.exe -uninstall

  • 修復: ContrastSetup.exe -repair

無人モードまたはサイレントモードには、以下のコマンドを使用します。

  • インストール: ContrastSetup.exe -s -norestart

  • アンインストール: ContrastSetup.exe -uninstall -s -norestart

  • 修復: ContrastSetup.exe -repair -s -norestart

コマンドラインを使用してのインストールでは、.NET FrameworkエージェントのWindowsインストーラで利用できるその他のオプションを指定できます。

オプション

説明

INSTALLFOLDER

インストール先ディレクトリを指定します。このディレクトリに、プログラムファイルが書き込まれます。デフォルトはOSの変数によって異なります。

INSTALLFOLDER="D:\Programs\Contrast"

DATAFOLDER

データディレクトリを指定します。このディレクトリに、ログやcontrast_security.yamlファイルが書き込まれます。デフォルトはOSの変数によって異なります。

DATAFOLDER ="D:\Data\Contrast"

StartTray

0に設定すると、エージェントのインストール完了時にトレイアプリケーションが起動しなくなります。Windows Server Coreインスタンスにエージェントをインストールする場合は、この設定を推奨します。デフォルトは、1です。

StartTray=0

PathToYaml

カスタムYAML設定ファイルを指定します。デフォルトは、インストーラの場所に対して相対パスにあるcontrast_security.yamlファイルです。

PathToYaml=c:\contrast_security.yaml

SERVICE_STARTUP_TYPE_MANUAL

このオプションは、エージェントのインストール、更新、修復時に指定する必要があります。1に設定すると、Contrast serviceのスタートアップの種類が「手動」に設定されます。デフォルトは、0で「自動(遅延開始)」です。

SERVICE_STARTUP_TYPE_MANUAL=1

SUPPRESS_SERVICE_START

このオプションは、エージェントのインストール、更新、修復時に指定する必要があります。1に設定すると、サービスが自動で起動されなくなります。デフォルトは、0です。

SUPPRESS_SERVICE_START=1

USE_VIRTUAL_SERVICE_ACCOUNT

制限された仮想サービスアカウントで、エージェントサービスを実行します。SYSTEMのの代わりに、仮想アカウントNT Service\DotnetAgentSvcとしてサービスを実行するように構成します。

USE_VIRTUAL_SERVICE_ACCOUNT=0

INSECURE_YAML_FILE

昇格していないユーザのcontrast_security.yamlファイルへの編集を制限します。

INSECURE_YAML_FILE=0

INSTALL_UPGRADE_SERVICE

エージェントアップグレードサービスをインストールしない場合は、0に設定します。 デフォルトの値は、1です。

INSTALL_UPGRADE_SERVICE=1

UPGRADE_SERVICE_INSTALLFOLDER

インストーラが、アップデートサービスのファイルを配置する場所を指定します。

UPGRADE_SERVICE_INSTALLFOLDER="C:\Program Files (x86)\Contrast\upgrade-service"

ヒント

例えば、スクリプトを使用して.NETエージェントをインストールするには、以下のコマンドを使用します。

ContrastSetup.exe -s -norestart StartTray=0 PathToYaml=C:\Temp\custom.yaml

このコマンドは、.NETエージェントのインストールを無人/サイレントモードで行い、トレイアプリケーションの起動を止め、YAML設定ファイルのカスタムパスを使用するものです。

重要

エージェントをインストールすると、Contrastは自動的にIISを再起動します。