5.4. Web監視(外形監視)監視設定手順と使い方¶

外形監視設定を行う際には、以下の設定が必要になります。

Senju DevOperation Conductor Extension Packの入手と適用
運用管理サーバーおよび、外形監視を行う管理対象ノードに、同一バージョンの Senju DevOperation Conductor Extension Pack の適用が必要です
運用管理サーバー（千手マネージャ）への適用（監視項目の更新）

管理対象ノード（千手エージェント(プローブノード)）への適用（情報取得コマンドの更新）

警告

適用可能な Senju DevOperation Conductor のバージョンやパッチ状況に制限がある場合があります。詳しくは、Senju DevOperation Conductor Extension Pack の README をご参照下さい。

参考

Senju DevOperation Conductor Extension Packの適用手順につきましては、Senju DevOperation Conductor Extension Pack の README をご参照下さい。

注釈

Senju DevOperation Conductor Extension Packの適用に際しては、千手システムの停止は不要ですが、関連する監視タスクの停止が必要です。

5.4.1. 設定¶

説明
モニタリングサブシステムを用いて外形監視項目を使用するための設定を行います。
設定手順
外形監視を設定をするには以下の手順が必要です。
- Playwrightの導入
- 外形監視用千手設定ファイル(sj_synthetics_conf.json)の作成

5.4.1.1. Playwrightの導入¶

以下の手順はNode.jsがインストールされた環境で実施して下さい。Playwrightの稼働にはNode.js 14以降が必要です。

5.4.1.1.1. インストール¶

ログイン

外形監視の設定を行うノードに、千手稼働アカウントでログインします。
Playwrightインストール
Playwrightをインストールする任意のディレクトリに移動し、Playwrightをインストールします。

以下は D:\path\to\playwright にPlaywrightをインストールする場合の例です。
cd D:\path\to\playwright npm install @playwright/test@X.XX.X
注釈

X.XX.Xには千手がサポートするPlaywrightのバージョンを指定して下さい。 Playwrightのサポートバージョンについては、リリースノートに記載されている外形監視の稼働環境をご確認下さい。

Webブラウザインストール

以下コマンドにより、Playwrightで利用するWebブラウザをインストールします。
# chromium・firefox・webkitの3つをインストールする場合
npx playwright install

# chromiumのみをインストールする場合
npx playwright install chromium

依存モジュールのインストール

以下コマンドにより、Playwrightの依存モジュールをインストールします。

# chromium・firefox・webkitの3つの依存モジュールをインストールする場合
npx playwright install-deps

# chromiumのみの依存モジュールをインストールする場合
npx playwright install-deps chromium

5.4.1.1.2. Playwright設定ファイル(playwright.config)の作成¶

Playwrightのテストランナー実行時にデフォルトで参照される設定ファイルを作成します。Playwrightの公式ドキュメントを参考に、設定ファイルを作成して下さい。

以下に、基本的な設定ファイル例(TypeScript)を記載します。

import { defineConfig, devices } from '@playwright/test';

export default defineConfig({
  // テストスクリプトの格納先ディレクトリ
  testDir: 'tests',

  // 全テストのパラレル実行
  fullyParallel: true,

  // Webブラウザごとのプロジェクト
  projects: [
    {
      name: 'chromium',
      use: { ...devices['Desktop Chrome'] },
    },
    {
      name: 'firefox',
      use: {
        ...devices['Desktop Firefox'],
      },
    },
    {
      name: 'webkit',
      use: {
        ...devices['Desktop Safari'],
      },
    },
  ],
});

注釈

projects は必ず設定して下さい。監視タスクで指定するプロジェクト情報として参照されます。
作成した設定ファイルは、利用するテストスクリプトのスクリプトの種類に応じて、 playwright.config.ts / playwright.config.js / playwright.config.mjs のいずれかのファイル名でPlaywrightをインストールしたプロジェクトディレクトリ下に格納して下さい。

参考

Playwright公式ドキュメント URL：https://playwright.dev/docs/test-configuration

5.4.1.1.3. テストスクリプトの準備¶

外形監視では、ユーザーが作成したテストスクリプトを実行することで監視を行います。

そのため、事前にテストスクリプトを手動で作成する必要があります。

Playwrightの公式ドキュメントを参考に、テストスクリプトを準備して下さい。

注釈

テストスクリプトの作成には、Playwrightのコードジェネレータを利用することも可能です。
作成したテストスクリプトは、Playwright設定ファイル(playwright.config)の作成で指定したテストディレクトリに格納して下さい。

参考

Playwright公式ドキュメント URL：https://playwright.dev/docs/writing-tests
Playwright CodeGen URL：https://playwright.dev/docs/codegen-intro

5.4.1.2. 外形監視用千手設定ファイル(sj_synthetics_conf.json)の作成¶

sj_synthetics_conf.jsonファイルは、千手での外形監視のための情報を設定するファイルです。外形監視の利用前に 必ず作成 して下さい。

sj_synthetics_conf.jsonは「千手ホームディレクトリ/dat/opt/sj_synthetics_conf.json」に作成します。

表 5.2 sj_synthetics_conf.jsonの記述内容¶
項目	省略	デフォルト	暗号化対象	説明
projectDir	不可	―	×	Playwrightをインストールしたプロジェクトディレクトリパス
trace.successGeneration	可	3	×	シナリオ実行成功時のtraceファイル保存世代数
trace.failedGeneration	可	10	×	シナリオ実行失敗時のtraceファイル保存世代数

sj_synthetics_conf.json の記載例

{
  "projectDir": "D:\\path\\to\\playwright",
  "trace": {
    "successGeneration": 3,
    "failedGeneration": 10
  }
}

5.4.2. 使い方¶

5.4.2.1. 外形監視機能¶

Playwrightを利用したテストスクリプトの実行結果から、各ステップ・テストのレスポンスタイムやステータスを取得し、Senju DevOperation Conductorのモニタリング機能を使って、監視することができます。

監視定義を千手ブラウザより登録し、監視を実施します。監視結果は、各種モニタ画面（グローバルノードモニタ／ノードモニタ）にてその監視状況を表示できます。予め設定したしきい値により障害を検知した場合は、メッセージモニタにメッセージが通知されます。
（モニタリング機能については、ユーザーズガイド「 ４．モニタリング 」を参照して下さい。）

5.4.2.1.1. トレースファイル¶

Playwrightにより作成されたトレースファイルは次の場所に保存されます。

保存世代数については、設定で変更可能です。詳細については外形監視用千手設定ファイル(sj_synthetics_conf.json)の作成を参照して下さい。

項目	内容
ディレクトリ名	`~/log/extension.d/synthetics/taskID_{監視タスクID}/`
ファイル名(テスト実行成功時)	`~/log/extension.d/synthetics/taskID_{監視タスクID}/success/YYYYMMDD-hhmmss/{テストスクリプト名}-{テスト名}-{プロジェクト名}/trace.zip`
ファイル名(テスト実行失敗時)	`~/log/extension.d/synthetics/taskID_{監視タスクID}/fail/YYYYMMDD-hhmmss/{テストスクリプト名}-{テスト名}-{プロジェクト名}/trace.zip`

5.4.2.2. 使用上の制限事項¶

Windowsでの監視の場合、プロキシサーバーを経由した監視を行うにはchromiumブラウザを利用する必要があります。
以下の動作は非対応です。
- playwright.configでのテストのリトライ設定
- 複数Webブラウザでの同時テスト
- 実行対象テストスクリプトの複数指定
LinuxノードでWebブラウザにwebkitを指定して監視を行う場合、Webブラウザのcoreファイルが作成されることがあります。
サポート対象となるWebブラウザのバージョンについては、Playwrightのリリースノートを参照してください。
- URL: https://playwright.dev/docs/release-notes

目次

前のトピックへ

次のトピックへ