インストール後の設定
インストール後、DAI サーバーの構成を調整して、組織内で使用できるように準備できます。
DAIを使用すると、Windows上のオンプレミスDAIサーバーを、設定ファイルconfig.yml を使用してカスタマイズできます。このファイルは C:\ProgramData\Eggplant\Digital Automation Intelligence フォルダにあります。DAIを初めてインストールした時点では、config.yml の内容は最小限で、DAIの動作に必要な基本設定のみが提供されています。
DAIをアップグレードすると、Windows DAIサーバー設定ファイル(config.yml)に以前のリリースの設定(環境変数)が含まれている可能性があります。これらの設定は、DAI 25.2以降のリリースでは参照されなくなります。不要な環境変数の削除方法については、アップグレードに関する注意事項をご覧ください。
DAIはコンテナデプロイメント用の設定ファイル dai.yaml ル用の config.yml ファイルとは異なります。dai.yml ファイルの詳細については、コンテナへのEggplantのデプロイをご覧ください。
設定ファイルに設定を追加する方法については、以下および DAI ドキュメント全体の関連トピックで説明します。
Windows での DAI サーバー構成ファイルの編集
Windows DAI サーバー構成ファイル (config.yml) を編集するには、以下の手順に従います。
C:\ProgramData\Eggplant\Digital Automation Intelligence\config.ymlに移動し、テキスト編集ツールでconfig.ymlファイルを開きます。- 更新する設定(環境変数)を追加または変更します。
- 変更を保存します。
- 更新された
config.ymlファイルで実行するには、DAI サーバー サービスを再起動します。
DAI を使用したシングル サインオンの構成
DAI でシングル サインオン (SSO) を有効にするには、DAI でシングル サインオン (SSO) 認証を有効にする を参照してください。
自己署名SSL証明書の設定を追加する
DAI 7.0 で非推奨。自己署名 SSL 証明書では不要になりました。
詳細インストールを完了し、独自の証明機関を使用して SSL 証明書に署名した場合は、インストール後に構成を更新する必要があります。
-
Windowsのサービスマネージャーを通じてDigital Automation Intelligence Serviceを停止します。
-
C:\ProgramData\Eggplant\Digital Automation Intelligence\config.ymlに移動し、テキスト編集ツールでconfig.ymlファイルを開きます。 -
以下のエントリを
envキーの下に追加し、ファイルを保存します:config.ymlenv:REQUESTS_CA_BUNDLE: <ルート証明機関証明書へのパス> -
Digital Automation Intelligence Windowsサービスを再起動します。
RabbitMQ 通信を暗号化する
DAI は、内部のプロセス間通信用のメッセージ ブローカーとして RabbitMQ サーバーを組み込みます。DAI サーバーで HTTPS を有効にすると、すべての Advanced Message Queuing Protocol (AMQP) 通信にトランスポート層セキュリティ (TLS) を使用するように DAI を構成することで、RabbitMQ サーバーへのすべてのトラフィックを暗号化するオプションが提供されます。
RabbitMQ通信を暗号化するオプションは、DAI 7.4以降、DAIサーバーでHTTPSを有効にすると利用できます。HTTPSの有効化については、高度なインストールの実行をご覧ください。
デフォルトでは、RabbitMQ は暗号化されていない AMQP を使用します。すべての AMQP トラフィックを証明書を使用して暗号化するように RabbitMQ を構成するには、以下のように DAI 構成ファイル (config.yml) を変更する必要があります。
-
Windowsのサービスマネージャーを通じてDigital Automation Intelligence Serviceを停止します。
-
C:\ProgramData\Eggplant\Digital Automation Intelligence\に移動し、テキスト編集ツールでconfig.ymlファイルを開きます。 -
envキーの下に次のエントリを追加してファイルを保存します。config.ymlenv:INTERNAL_CERT_PATH: <the file path of the certificate, defaults to null>INTERNAL_KEY_PATH: <the file path of the certificate key, defaults to null>INTERNAL_KEY_PASSWORD: <the password of the certificate key (if required), defaults to null>INTERNAL_LISTEN_ADDRESS: <the address that RabbitMQ will listen on, defaults to 127.0.0.1> -
Digital Automation Intelligence Windowsサービスを再起動します。
:::注意点
デフォルトでは、すべての RabbitMQ トラフィックは DAI サーバーの内部で行われるため、ローカル マシン (localhost) から出ることはありません。INTERNAL_CERT_PATH を https に使用される外部証明書 (https_cert_path) と同じ値に設定することもできますが、その場合、AMQP トラフィックは証明書で指定されたホストにルーティングされる必要があり、トラフィックはサーバーから出てしまいます。これを行う場合は、INTERNAL_LISTEN_ADDRESS を 0.0.0.0 に設定して、RabbitMQ が外部ソースからのトラフィックを受け入れるようにする必要もあります。また、AMQP トラフィックがファイアウォール (ポート 5673) を通過するように許可する必要もあります。
:::
WindowsでEggplant DAIのポートを変更する
Eggplant DAIはインストール時にデフォルトでポート8000を割り当てますが、後から別のポートを指定することも可能です:
- Windowsのサービスマネージャーを通じてDigital Automation Intelligence Serviceを停止します。
- 詳細インストールを繰り返し、手順 3 または 4 で、構成に応じて新しいポート値を入力します。
- インストールが完了したら、Digital Automation Intelligence Windowsサービスを再起動します。
Eggplant DAIアプリケーションサーバーログのローテーションを設定する
Eggplant DAIアプリケーションサーバーはデフォルトで60日間のログローテーションがありますが、設定ファイルの下でローテーション設定を変更することが可能です:
- Windows サービス マネージャーを使用して Digital Automation Intelligence Service を停止します。
C:\ProgramData\Eggplant\Digital Automation Intelligence\config.ymlに移動し、テキスト編集ツールでconfig.ymlファイルを開きます。DAI_SERVER_MAX_ROTATED_LOG_COUNTenvキーを探します。- ログローテーションカウント番号を変更します。
- Digital Automation Intelligence Windows サービスを再起動します。
ログローテーションの挙動
- Eggplant DAIでトランザクションログがある場合、ログファイルは毎日生成されます。
- ローテーションは、新しいログファイルが受信され、ログフォルダに設定された値と同じ数のログファイルが含まれている場合に実行されます。例:
DAI_SERVER_MAX_ROTATED_LOG_COUNT: 3を設定します- DAIサービスログフォルダは生成されたログファイルを含む、例えば:
- log.txt.2023-01-01, log.txt.2023-01-03, log.txt.2023-01-04
- 1月6日に新しいログファイルが作成された場合、このログファイルは最古のログファイルlog.txt.2023-01-01を置き換えます。その結果、次のログファイルが利用可能になります:
- log.txt.2023-01-03, log.txt.2023-01-04, log.txt.2023-01-06
- そして新しいログファイルが入ってきたときに再びローテートします。例えば:
- log.txt.2023-01-04, log.txt.2023-01-06, log.txt.2023-01-07
- このログローテーション機能は、DAI 6.5で作成されたログファイルのみをローテートします。DAI 6.5以前に作成されたログファイルは手動で管理する必要があります。
- DAI 6.5のログファイルの名前形式は、DAIの早期バージョンとは異なります。新しいログファイルの名前形式は
log.txt.<タイムスタンプ>です。 - ログローテーションでは、PostgreSQL、Nginx、RabbitMQ、Keycloakのログは除外されます。これらのログは手動で管理する必要があります。
Eggplant DAI Bug Huntingを設定する
DAIには、バグを見つけるのに役立つ「バグハンティング」機能が搭載されています。詳しくはバグハンティングをご覧ください。バグハンターは2つのモードで実行できます。
- Bug Hunter Classic (デフォルト) はスタンドアロン プロセスであり実行可能ファイルです。
- Bug Hunter Lite。ai-api (DAI API) サービスの下で実行されます。
Bug Hunter Lite は、Bug Hunter Classic に比べてパフォーマンスが大幅に向上しています。ただし、使用するには有効にする必要があります。オプションでDAI_LOG_FACTORSを追加して Bug Hunter に関する情報を取得することもできます。
Bug Hunter Lite を有効にするには:
-
Windows サービス マネージャーを使用して Digital Automation Intelligence Service を停止します。
-
C:\ProgramData\Eggplant\Digital Automation Intelligenceに移動し、テキスト編集ツールでconfig.ymlファイルを開きます。 -
次のエントリを追加してファイルを保存します。
config.ymlenv:BUG_HUNTER_LITE_ENABLED: 1 <enabled to use Bug Hunter Lite>BUG_HUNTER_LITE_ENABLED を 0 に設定すると無効にできます。
注記この設定を以下で説明する DAI_LOG_FACTORS 設定とともに使用して、Bug Hunter に関する情報を取得できます。
-
Digital Automation Intelligence Windows サービスを再起動します。
DAI モデルのAction優先度を決定する要素のログを有効にする
DAI は、探索的テストを実行するときに、いくつかの要素を使用してActionが実行される確率を決定します。デフォルトでは、DAI 実行ログにはこれらの要素に関する情報は含まれません。 DAI_LOG_FACTORS 設定を有効にすることで、この情報を取得できます。
DAI_LOG_FACTORS 設定は、DAI 6.5 以降で使用できます。
-
Windows サービス マネージャーを使用して Digital Automation Intelligence Service を停止します。
-
C:\ProgramData\Eggplant\Digital Automation Intelligenceに移動し、テキスト編集ツールでconfig.ymlファイルを開きます。 -
次のエントリを追加してファイルを保存します。
config.ymlenv:DAI_LOG_FACTORS: 1 <enabled to capture information about the Bug Hunter>DAI_LOG_FACTORS を 0 に設定すると無効にできます。
-
Digital Automation Intelligence Windows サービスを再起動します。
スケジュールされたテスト成果物の削除を有効にする (保持期間)
デフォルトでは、DAI はテスト成果物を無期限、または手動で削除されるまで保存します。デフォルトの保存期間はありません。ただし、DAI サーバー構成ファイルで次の表に示す 2 つの環境変数を設定することで、スケジュールに従って自動的に削除するように DAI を設定できます。この機能を有効にすると、テスト結果、ログ、スクリーンショット成果物は指定した日数保存され、指定した日数経過後の指定した時刻(または夜)に削除されます。
DAI サーバー設定ファイルには、デフォルトではこれらの変数は含まれていません。この機能を使用するには、手動でファイルに追加する必要があります。変更するファイルの名前は、実行しているDAIサーバー(オンプレミスまたはコンテナデプロイメント)のタイプによって異なります。各 DAI サーバー・インストール・タイプの構成ファイルを変更する手順については、表の後ろに説明します。
- この機能は DAI 7.3 で実装されました。
- スケジュール削除を有効にするには、次の両方の環境変数を DAI サーバー設定ファイルに追加する必要があります。
- 環境変数は大文字と小文字が区別されるため、以下の表に示すように入力する必要があります。
- 'DELETE_RESULTS_TRIGGER_TIME' 値は一重引用符で囲む必要があります。 一重引用符を使用しない場合、DAI Server サービスは再起動されません。
| 環境変数 | 値 | 説明 |
|---|---|---|
DELETE_RESULTS_AFTER_DAYS | 0 | 'デフォルト値 : 0 (無効)' テストアーティファクトを削除する前に保存するための日数を指定します。この値は、0,1,10,20,60,120 などの整数である必要があります。この環境変数を DAI サーバー設定ファイルに追加しない場合、または追加してゼロ (0) に設定した場合、スケジュールされた削除が無効になります。この場合、DAI は結果を無期限に保存するか、手動で削除するまで保存します。これら 2 つの変数が設定ファイルに追加されていても、DELETE_RESULTS_AFTER_DAYSが無効になっている場合、DELETE_RESULTS_TRIGGER_TIME変数も無効になります。 |
DELETE_RESULTS_TRIGGER_TIME | '03:00' | Default Value : '03:00' (3 am) ローカルサーバーの時刻に基づいてDAIが削除を実行する時刻。この変数は 24 時間形式を使用します。これは、デフォルトの午前 3 時や深夜 ('00:00') など、誰もサーバーを使用していない時間に設定することをお勧めします。時間の値は一重引用符で囲んで指定する必要があることに注意してください。DAI Server サービスは、一重引用符を含めない場合、再起動されません。 |
オンプレミス DAI の Windows インストールの場合
-
C:\ProgramData\Eggplant\Digital Automation Intelligence\に移動し、テキスト編集ツールでconfig.ymlファイルを開きます。 -
次のエントリを
config.ymlファイルに追加します。config.ymlenv:DELETE_RESULTS_AFTER_DAYS: 30 <an arbitrary integer specifying the number of days you want to keep your test artifacts before deleting them; set this to 0 to disable scheduled deletions>DELETE_RESULTS_TRIGGER_TIME: '03:00' <the time in single quotes at which you want DAI perform the deletion based on the local server time> -
変更を保存します。
-
DAI Server サービスを再起動して、
config.ymlファイルの変更で実行します。 -
スケジュールの変更を確認します。スケジュールの変更を確認するために、ai-apiフォルダのログを参照する必要がある場合があります。
Helm コンテナのデプロイメントの場合
-
Ai-api Helm フォルダーに移動して、
values.yamlファイル内の次の変数値を変更します。 -
次のエントリを追加します。
values.yamlenv:DELETE_RESULTS_AFTER_DAYS: 30 <an arbitrary integer specifying the number of days you want to keep your test artifacts before deleting them; set this to 0 to disable scheduled deletions>DELETE_RESULTS_TRIGGER_TIME: '03:00' <the time at which you want DAI perform the deletion in single quotes> -
変更を保存します。
-
values.yamlファイルに次の変更を加えて Helm コンテナをデプロイします。 -
Helm インスタンスでログを見つけるのにサポートが必要な場合は、カスタマーサクセスマネージャーまたは当社の カスタマー Support にお問い合わせください。
SUT および実行環境接続の再試行設定
テスト ランナーが SUT または実行環境への失敗した接続を自動的に再試行するように構成するには、DAI が再度接続を試行する前に待機する (スリープする) 間隔を指定する必要があります。また、DAI が接続の試行を停止し、テストの実行を停止し、エラーを報告するまでのタイムアウト期間も指定する必要があります。
| 環境変数 | 値 | 説明 |
|---|---|---|
RETRY_SLEEP_INTERVAL_SECONDS | Minimum: 1, Maximum: 100, Default: 10 | テスト ランナーが SUT または実行環境への接続を再試行するまで待機する間隔 (秒単位)。たとえば、RETRY_SLEEP_INTERVAL_SECONDS 変数に 10 秒を指定し、接続が失敗した場合、ランナーは 10 秒待機してから再度接続を試行します。 |
RETRY_TIMEOUT_SECONDS | Minimum: 0, Maximum: 18000, Default: 3600 | ランナーが接続試行を停止(タイムアウト)し、テスト実行を停止してエラーを報告するまでの秒数です。この変数をゼロ(0)に設定すると、接続再試行オプションが無効になります。 |
オンプレミス DAI Windows インストール (SUT and Execution Environments) の場合
-
C:\ProgramData\Eggplant\Digital Automation Intelligence\に移動し、テキスト編集ツールでconfig.ymlファイルを開きます。 -
config.ymlファイルに次のエントリを追加します。config.ymlenv:RETRY_TIMEOUT_SECONDS: 3600 <an arbitrary integer specifying the timeout after which a test runner stops trying to connect to a SUT or Execution Environment, stops the test run, and reports an error; set this variable to 0 to disable connection retries.>RETRY_SLEEP_INTERVAL_SECONDS: 10 <the interval in seconds you want your test runner to retry connections to a SUT or Execution Environment when the connections fail.> -
変更を保存します。
-
DAI Server サービスを再起動して、
config.ymlファイルの変更で実行します。 -
スケジュールの変更を確認します。スケジュールの変更を確認するために、ai-apiフォルダのログを参照する必要がある場合があります。