Manual

目次

ここでは、初めての方にWebシナリオ監視サービスの利用方法を説明します。

はじめに

Webシナリオ監視は、Webブラウザに対する一連の操作を機械的に再現することで、Web 上に構築されたサービスが期待通りに動作するかを定期的にテストするためのサービスです。ここでは、Webサービスに対する一連の操作をまとめたものを Webシナリオ(もしくは単にシナリオ)と呼びます。

Webシナリオ監視を利用することで、必要な機能が期待通りに動作していることを継続的に監視できます。
例えば、ECサイトであれば、次のようなシナリオが動作することを常時確認したいかもしれません。

  1. サイトのトップページにアクセス
  2. IDとパスワードを入力してサインイン
  3. カテゴリをとキーワードで商品検索
  4. 商品を選んでカートに入れる
  5. 合計金額を確認
  6. 送り先情報を入力し、郵便番号から住所が自動補完されることを確認
  7. 購入をキャンセル
  8. サインアウト

Webシナリオ監視は、このような動作確認を自動で行うためのサービスです。導入のご相談については、クラウド型監視サービス – Webシナリオ監視をご参照ください。

サービス提供の仕組み

Webシナリオ監視は、Webサイトが意図通りの表示がされているかどうかを監視するサービスです。操作手順(=シナリオ)を設定しておき、実際のブラウザを制御してその手順を再現し、意図通りの挙動をしているかどうかをもって正常性を判定します。

Webシナリオ監視のシステムは、ユーザの操作コンソールである「サービスコンソール」とシナリオ実行環境である「サービス提供基盤」から成ります。

Webシナリオ監視サービスの中核をなすのは「サービス提供基盤」です。「サービス提供基盤」は、複数のOSとブラウザを含むシナリオ実行環境を持ち、シナリオの管理・実行と実行結果の保持を担います。ブラウザの制御は、OSS(オープンソースソフトウェア)の Webテストツールである Selenium を使って実現しています。

すべての操作は、「サービスコンソール」上で行います。「サービスコンソール」は、「サービス提供基盤」に対するユーザーインタフェースを提供するだけでなく、基本的な監視機能(定期実行、アラート通知、現状・過去のステータス確認)も担っています。その実装には、Pandora FMS を利用しています。

サービスコンソールの画面例を提示します。

オンラインマニュアルの利用方法

このオンラインマニュアルは「導入準備」「チュートリアル」「利用マニュアル」の 3つのパートで構成されています。

導入準備

本サービスを利用する方法について説明しています。導入される際にご一読ください。

0-1. はじめに (このページ)

Webシナリオ監視サービスの利用方法と、このマニュアルサイトの利用方法について説明しています。マニュアルの目次も兼ねています。

チュートリアル

サービスコンソールを使って Webシナリオ監視サービスを利用するための3部構成のチュートリアルです。
簡単な例題を通して、シナリオ(テストケース)の作成からアップロードから通知設定を行うところまでを説明しています。

1-1. 簡単なシナリオ作成

Firefoxとそのアドオンである Selenium IDE を利用して、シナリオ(テストケース)を作成するチュートリアルです。

1-2. クイックスタート No.1 シナリオの登録から、最初のシナリオ実行まで

クイックスタート(前編)。シナリオ(テストケース)をサービスに登録して定期的に実行させるところまでのチュートリアルです。

1-3. クイックスタートNo.2 アラート設定、ステップセットの追加

クイックスタート(後編)。定期実行されるシナリオで NG を検知した場合のアラート通知を行うためのチュートリアルです。

利用マニュアル

サービスコンソールを使った Webシナリオ監視の利用方法について説明しています。

2-1. シナリオを登録する

テストケースをアップロードして、シナリオを登録する方法を説明します。アップロードされたシナリオはすぐに実行されるので、すぐに結果が確認できます。その結果、対処が必要なケースについても説明しています。

2-2. シナリオを変更する

実行中のステップセットを変更する方法、シナリオのタイトルや説明を更新する方法、ステップセットの名前や説明を更新する方法について説明しています。

2-3. シナリオを削除する

シナリオを削除する方法について説明しています。

2-4. シナリオの実行結果を確認する

実行結果の詳細を閲覧する方法について説明しています。シナリオの実行状況を一覧表示する方法から、ステップごとの実行状況の確認方法までを説明しています。

2-5. 実行中のシナリオの内容を確認する

実行中のステップセットの内容を確認する方法について説明しています。

2-6. シナリオを実行するブラウザを変更する

Webシナリオを実行するブラウザの変更方法について説明しています。指定可能な Webブラウザはサービスの契約内容で決まっています。

2-7. シナリオの実行結果をエクスポートする

実行結果をファイルにエクスポートする方法について説明しています。エクスポートデータのフォーマットについてもここで説明しています。

2-8. シナリオの実行を停止・再開する

シナリオを無効化して、実行を停止する方法について説明しています。スケジュールに従って停止・再開する方法についても説明しています。

2-9. アラート通知を追加する

アラート通知の設定方法について説明しています。

2-10. アラート通知を止める

設定済みのアラート通知を停止する方法について説明しています。シナリオ実行と同様に、アラート通知もスケジュールに従って停止・再開できます。

2-11. シナリオの登録上限を確認・変更する

シナリオ登録の上限数の確認方法と、それを変更する方法について説明しています。

2-12. 月次の画面遷移数を確認する

画面遷移の総数を月次で確認する方法について説明しています。

用語集

Webシナリオ監視に関連する基本的な用語について説明します。Pandora FMS および Pandora FMS Enterprise SaaS に関連する用語については、必要最小限の説明のみとしています。詳細は、こちらをご参照ください。

Webシナリオ監視システムに関する用語

サービスコンソール

Webシナリオ監視サービスを利用者向けの操作コンソール。
「サービス提供基盤」に対するユーザーインタフェースを提供するだけでなく、基本的な監視機能(定期実行、アラート通知、現状・過去のステータス確認)も担っています。実体は、Pandora FMS に拡張パッケージを追加実装したものです。
現時点では Pandora FMS Enterprise SaaS でのみ利用可能ですが、後述の通り拡張パッケージは公開予定です。

サービス提供基盤

シナリオ実行環境。複数のOS上で動作するブラウザ実行環境を持ち、シナリオの管理・実行と実行結果の保持を担います。ブラウザの制御には、OSS(オープンソースソフトウェア)の Webテストツールである Selenium を使っています。

シナリオに関する用語

シナリオ

シナリオは、Webサイトに対するブラウザ上の一連の操作手順をまとめたものを概念的にそう呼んでいます。監視項目としての情報(名前やURL等)や「意図通りの挙動」を示す操作手順等もすべて含みます。特に区別する必要がない場合は、後述の「テストケース」や「ステップセット」を便宜的にシナリオと呼ぶこともあります。

テストケース

テストケースは、シナリオ監視用の一連の操作を Selenium IDE の入出力形式で記述したものを指します。構文(syntax)は HTML です。Webシナリオ監視サービスにアップロードしたものは「ステップセット」と呼びます。

ステップセット

上述の「テストケース」をアップロードして、Webシナリオ監視サービスの管理対象となったものを「ステップセット」と呼びます。1つのシナリオに対して複数のステップセットを登録(アップロード)することは可能ですが、実行対象は常にそのうちの 1つです。

ステップ

操作手順に含まれる操作一つ一つをステップと呼んでいます。(引数を伴った) 1つの Selenium コマンドに相当します。Selenium コマンドとその引数については、『Seleniumの日本語ドキュメント』『Seleniumのコマンド』などのページを参照してください。あわせて1-1. 簡単なシナリオ作成 も参照してください。

Pandora FMS に関する用語

エージェント

Pandora FMS では、監視対象として登録したノードのことをエージェントと呼び、後述のモジュールを束ねる役割を持ちます。Webシナリオ監視では、1シナリオが1エージェントに相当します。

モジュール

Pandora FMS では、監視項目もしくは情報収集項目のことをモジュールと呼びます。Webシナリオ監視では、各エージェントに「シナリオ実行」というモジュールを 1つ作成します。このモジュールがシナリオ実行を担い、実行の成否がこのモジュールの値として記録されます。

アラートアクション

通知方法と通知先を合わせて登録したものをアラートアクションと呼びます。Pandora FMS Enterprise SaaS 環境でWebシナリオ監視サービスのみご利用のお客様は、定義済みのアラートアクションのみ利用可能です。通知先や通知方法の追加・変更したい場合はお問い合わせください。
現時点でご利用頂ける通知手段は下記のとおりです。

  • メール
  • 電話
  • Slack
  • ChatWork
  • LINE

メール、電話ともに複数の宛先を設定可能です。それぞれ設定可能なパラメータに関しては Pandora FMS Enterprise SaaS のオンラインマニュアル「閾値・障害通知設定」をご参照ください。

アラートテンプレート

アラートの通知要件を定義したもので、アラートアクションと組み合わせてモジュールに関連付けると、アラートが通知出来るようになります。Pandora FMS Enterprise SaaS 環境でWebシナリオ監視サービスのみご利用のお客様は、定義済みのアラートテンプレートのみ利用可能です。利用したい通知条件が見つからない場合はご相談ください。

Pandora FMS Enterprise SaaS 以外からの利用

ここに公開している一連のマニュアルは、Pandora FMS Enterprise SaaS環境からの利用を前提として書かれてますが、本サービスを利用する方法はそれ以外にもあります。

「サービスコンソール」と「サービス提供基盤」との間は、すべて Web API (REST 形式) でやり取りを行います。「サービス提供基盤」の機能はすべて API 経由で提供されるので、この API を利用すれば、独自の UI フロントエンドを構築することも可能です。
(※ 現在、この API は一般には公開しておりません。ご利用については弊社までご相談ください)

Pandora FMS Enterprise SaaS サービス上の サービスコンソール実装も単独パッケージとして公開予定です。このパッケージを使えば、独自の Pandora FMS サーバ上に サービスコンソールを構築して Webシナリオ監視サービスを利用することも可能です。

以上から、このサービスを利用する方法は下記の 3つです。

  • Pandora FMS Enterprise SaaS 環境から利用する
  • 独自に構築した サービスコンソールから利用する
  • サービス提供基盤の Web API を直接利用する

後者 2つについては、弊社までお問い合わせください。


Contactお問い合わせ

お見積もり・ご相談など、お気軽にお問い合わせください。