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

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

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

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

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

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

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

    • 環境変数を使用してエージェントのプロファイラコンポーネントをIISに登録し、IISを再起動し、エージェントを組み込むための環境を準備します。これにより、CLRはエージェントのプロファイラをロードし、解析対象のアプリケーションにエージェントが組み込まれます。

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

注記

Contrastを使用して.NET Frameworkエージェントをインストールするには:

  1. Contrast UI(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インストーラで利用できるその他のオプションがあります。

オプション

説明

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

ヒント

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

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

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

.NET Frameworkエージェントの開始と停止

エージェントを起動して、Contrastの解析を有効にするには、以下のいずれかの方法を使用します。

  1. Windowsのメニューよりサービスを表示し、Contrast.NET Main Serviceを右クリックして開始を選択します。

  2. 管理者のコマンドプロンプトで、以下を実行します。

    net start DotnetAgentSvc

注記

デフォルトでは、Contrast .NET Main Serviceはスタートアップの種類:自動(遅延開始)に設定されます。そのため、インストール中またはWindowsの起動時にサービスは自動的に開始します。

エージェントを停止して、その結果Contrastの計測と解析を無効にするには、以下のいずれかの方法を使用します。

  1. Windowsメニューよりサービスを表示し、Contrast.NET Main Serviceを右クリックして停止を選択します。

  2. 管理者のコマンドプロンプトで、以下を実行します。

    net stop DotnetAgentSvc

重要

Contrastは、.NETエージェントのインストール時だけでなく、.NETエージェントの停止時や起動時にも、自動的にIISを再起動します。

.NETプロファイルAPIでは、プロファイルするプロセスをプロファイラで起動する必要があります。そのため、.NETエージェントはContrastプロファイラをロードするためにIIS(および全てのIISワーカープロセス)を再起動する必要があります。この処理は、他のプロファイル製品(メモリやパフォーマンスプロファイラなど)の動作と同様です。

必要があれば、IISの再起動時に警告を発するようWebサーバ監視ツールの設定を変更してください。

.NETエージェントは、Windows プロセス アクティブ化サービス(WAS)を停止してIISを再起動します。その後に、World Wide Web発行サービス(W3SVC)など、WASに依存して実行されていたサービスを開始します。場合によって、WASに依存するサービス(MSMQリスナーアダプターなど)がIISと一緒に再起動するように、ユーザはサービスの依存関係を手動で構成する必要があります。