Webサーバー/サービス
Applications Managerは、次のWebサービスの監視とステータス確認をサポートしています。
この機能では、可用性チェックの結果をグラフで表示します。可用性タブでは、過去24時間か30日の可用性履歴がわかります。パフォーマンス タブでは、過去24時間か30日のステータスとイベントがわかります。リスト ビューでは、一括管理設定が可能です。リストにあるそれぞれの監視をクリックすると、次の情報が提示されます。
Apacheサーバー
Apache監視を作成するには、次の手順に従ってください。Apache監視の要件もご確認ください。
-
新規監視をクリックして、Apacheサーバーを選択します。
-
監視が稼働しているホストのIPアドレスか名前を入力してください。
-
ネットワークのサブネット マスクを入力してください。
-
監視を実行しているポート番号を入力してください。
-
ApacheサーバーでSSLを有効にする場合、SSLオプションを選びます。
-
ポーリング間隔を入力してください(分)。
-
Enterprise EditionのAdminサーバーから新規監視を追加するには、Managedサーバーを選択します。
-
Apacheサーバーで認証を要する場合は、Apacheユーザー名とパスワードを入力してください。
-
必要に応じて、ApacheサーバーのステータスURLを変更します。データ転送やアクセスの情報収集に使うステータスURLは、デフォルトで、http://<host-name:portNumber>server-status?autoです。URLが異なる場合は、こちらで修正できます。
-
Apache監視を関連付ける監視グループを、コンボボックスで選択します(任意項目)。監視は複数グループに関連付け可能です。
-
監視の追加をクリックしてください。これにより、ネットワークからApacheを検出し、監視が始まります。
サービス タイプ |
チェック |
|||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Apacheサーバー |
1:Apacheのhttpd.confファイルで、<Location /server-status>タグを見つけます。タグが見つからない場合は、こちらの解説を参考に対応ください。
1:httpd.confファイルで「ExtendedStatus」属性を見つけます。
|
IISサーバー
IIS監視を作成するには、次の手順に従ってください。
-
新規監視をクリックして、IISサーバーを選択します。
-
監視が稼働しているホストのIPアドレスか名前を入力してください。
-
ネットワークのサブネット マスクを入力してください。
-
監視を実行しているポート番号を入力してください。
-
IISサーバーでSSLを有効にする場合、SSLオプションを選びます。
-
ポーリング間隔を入力してください(分)。
-
Enterprise EditionのAdminサーバーから新規監視を追加するには、Managedサーバーを選択します。
-
IIS監視を関連付ける監視グループを、コンボボックスで選択します(任意項目)。監視は複数グループに関連付け可能です。
-
監視の追加をクリックしてください。これにより、ネットワークからIISサーバーを検出し、監視が始まります。
IISサーバー |
|
nginxサーバー
nginx監視を作成するには、次の手順に従ってください。
-
新規監視をクリックして、nginxサーバーを選択します。
-
サーバーの表示名を入力してください。
-
監視が稼働しているホストのIPアドレスか名前を入力してください。
-
監視を実行しているポート番号を入力してください。
-
nginxサーバーでSSLを有効にする場合、SSLオプションを選びます。
-
nginxサーバーで認証を必要とする場合は、ユーザー名とパスワードを入力してください。
-
必要に応じて、nginxサーバー ステータスURIを変更します。サーバー ステータス取得に必須です。ステータスURIはデフォルトで、nginx_statusとなっています。別のURIを利用する場合は、こちらで変更ください。
-
ポーリング間隔を入力してください(分)。
-
Enterprise EditionのAdminサーバーから新規監視を追加するには、Managedサーバーを選択します。
-
nginx監視を関連付ける監視グループを、コンボボックスで選択します(任意項目)。監視は複数グループに関連付け可能です。
-
監視の追加をクリックしてください。これにより、ネットワークからnginxサーバーを検出し、監視が始まります。
サーバー ステータスを有効にするには、次の手順に従ってください。
-
「server_status」を有効にするには、nginx.confファイルで「Location /server_status」ディレクティブを編集します。
-
「stub_status」属性の値を「on」にします。
-
属性を「deny al」から「allow all」にしてください。
-
設定を保存し、nginxサーバーを再起動してください。
nginxサーバー |
|
PHP
PHP監視を作成するには、次の手順に従ってください。
- Applications Managerにバンドルされたphpstats.phpファイルを、AppManager_Home\Working\resourcesフォルダーで見つけます。
- ファイルを、Webサーバーのドキュメントrootに貼り付けると監視が始まります。Applications Managerはサーバーに接続し、PHPの可用性を確認します。
-
新規監視をクリックして、PHP監視を選択します。
-
監視が稼働しているホストのIPアドレスか名前を入力してください。
-
ネットワークのサブネット マスクを入力してください。
-
監視を実行しているポート番号を入力してください。
-
PHPでSSLを有効にする場合、SSLオプションを選びます。
-
接続先のパスを入力してください。デフォルトでは、「/phpstats.php」が表示されます。接続には、「http://hostname:portNo/<path>」をご利用ください。
-
ポーリング間隔を入力してください(分)。
-
Enterprise EditionのAdminサーバーから新規監視を追加するには、Managedサーバーを選択します。
-
PHP監視を関連付ける監視グループを、コンボボックスで選択します(任意項目)。監視は複数グループに関連付け可能です。
-
監視の追加をクリックしてください。これにより、ネットワークからPHPサービスを検出し、監視が始まります。
PHP監視 |
|
SSL証明書監視
SSL証明書監視を作成するには、次の手順に従ってください。
-
新規監視をクリックして、SSL証明書監視を選択します。
- SSL証明書監視の表示名を適宜指定してください。
-
SSL証明書監視を行うドメイン名を入力してください。
-
サーバーを実行するポートを指定します(デフォルトで443)。
-
サーバーにプロキシ経由で接続する場合は、ドメイン接続にプロキシを利用を選択します。管理タブの「プロキシの設定」からの設定作業も必要です。
-
タイムアウト値を入力してください(秒)
-
ポーリング間隔を入力します(分)。
-
Enterprise EditionのAdminサーバーから新規監視を追加するには、Managedサーバーを選択します。
-
SSL証明書監視を関連付ける監視グループを、コンボボックスで選択します(任意項目)。監視は複数グループに関連付け可能です。
-
監視の追加をクリックしてください。これによって、サーバーからSSL証明書が検出され、監視が始まります。
SSL証明書監視 |
|
Webサーバー
Webサーバー監視を作成するには、次の手順に従ってください。
-
新規監視をクリックして、Webサーバーを選択します。
-
監視が稼働しているホストのIPアドレスか名前を入力してください。
-
ネットワークのサブネット マスクを入力してください。
-
監視を実行しているポート番号を入力してください。
-
ポーリング間隔を入力してください(分)。
-
Enterprise EditionのAdminサーバーから新規監視を追加するには、Managedサーバーを選択します。
-
Webサーバー監視を関連付ける監視グループを、コンボボックスで選択します(任意項目)。監視は複数グループに関連付け可能です。
-
監視の追加をクリックしてください。これにより、ネットワークからWebサーバーを検出し、監視が始まります。
追加済みの監視が監視グループに関連付いていない場合、いつでも手動で関連付けできます。監視を監視グループに関連付けるには、監視グループへの監視の関連付けの解説を参照ください。
Webサーバー |
|
Webサービス
Webサービス監視
Webサービスは、XMLベースの技術で、アプリケーション間の通信を可能とします。環境を問わず機能し、標準的なXML形式のメッセージを、Webインターフェースで交換できます(SOAP、WSDL API)。
ManageEngine Applications Managerは、SOAP Webサービスを用いたサービス志向アーキテクチャに柔軟に対応できます(SOA:Service Oriented Architecture)。WebサービスのSLAを設定して、可用性を高度に保つのに役立ちます。Appllcations ManagerではWebサービスが発行する「操作」を実行するよう設定し、サービスのパフォーマンスを監視可能です。シンプルなウィザードでWSDL(Web Services Description Language)を指定し、操作の実行や引数の設定も行えます。くわえて、それぞれの操作の実行時間とユーザー定義のXSLTパラメーターに、標準機能でしきい値設定ができます。
Webサービス監視を作成するには、次の手順に従ってください。
メモ:Webサービスをプロキシ経由で利用する場合は、管理 > プロキシの設定と移動し、プロキシ設定を確認するか、新規に設定を行ってください。プロキシ不要のホストは、プロキシなしに加えます。
-
新規監視のリンクをクリックして、Webサービスを選びます。
-
WSDL URLを入力してください。
-
WSDL URLへの接続にプロキシが必要か、チェック ボックスで選択してください。
-
ポーリング間隔を入力してください(分)。
-
Enterprise EditionのAdminサーバーから新規監視を追加するには、Managedサーバーを選択します。
-
タイムアウトを入力してください。
-
Webサービス操作実行に必要な場合は、ユーザー名とパスワードを指定します。
-
ヘッダーの追加:操作の実行の際は、当社の標準ヘッダーも、お客さまカスタム ヘッダーも利用できます。複数ヘッダーは「#」で区切ります。キーと値の間は「:」で区切って下さい(「Content-Type:text/application+xop;charset=UTF-9#Pragma:no-cache」など)。
-
監視を作成する際、順次実行へのSOAPレスポンスから特定値を取り出すのに必要なトークンを指定してください。トークンは、「_SEP_」区切りで<OperationName$gt;_SEP_<TagToBeExtracted>形式にしてください。
-
Webサービス監視を関連付ける監視グループを、コンボボックスで選択します(任意項目)。監視は複数グループに関連付け可能です。
-
監視の追加をクリックしてください。
追加済みの監視が監視グループに関連付いていない場合、いつでも手動で関連付けできます。このテーマの解説も参照ください。
Webサービス監視の作成ののち、操作の追加と、しきい値とアラート設定が可能となります。
操作を追加する
Webサービスへの操作を、監視に追加できます。操作とは、サービスがサポートするアクションの叙述を抜粋したものです。
操作の追加には、次の手順に従ってください。
-
Webサービス監視画面の右側から操作の追加をクリックしてください。操作の追加画面が表示されます。
-
Webサービスに設定した操作は、操作の選択ドロップダウンに表示されます。これら操作からの選択も、カスタム操作の選択もできます。
-
事前定義の操作を選択する場合、操作に対するSOAPアクションとSOAPリクエストの値が自動的に表示されます。SOAPリクエストの「?」に値を入力してください。操作の名前は、事前定義の操作の場合も指定してください。
-
カスタム操作を選択する場合は、操作の名前、SOAPアクション、SOAPリクエスト値の指定が必要です。XSLTセグメントの追加方法の解説を参照ください。
-
実際に操作を監視に加える前に、操作のテストで出力を確認することもできます。
-
保存ボタンのクリックで、操作を追加してください。保存して他を設定するの場合は、操作の保存後に、次の操作設定を続けることができます。
追加した操作は、操作統計セクションの詳細ページに表示されます。操作の名前、SOAPリクエスト、SOAPレスポンス、ステータス、実行時間など、詳細情報を確認可能です。送信するSOAPアクション関係のアラート メールにはリンクが記載されており、そちらで、操作へのSOAPレスポンスを確認できます。しきい値とアラートは、すべての操作に設定できます。
Webサービス関数では、SOAPリクエストごとに動的な入力内容を引き渡せます。入力値は下記の関数に置き換えてください。
関数 | 説明 | 使い方 |
${random(MinValue,MaxValue)} | 入力値として、乱数を発生させます。 | ${random(100,1000)} この例では、100から1,000までの間で乱数を生成します。数例:446 |
${time(TimeFormat)} | このメソッドは、入力値として、現在の日時を渡します。日時の形式は、自身で指定可能です。 | ${time(yyyy-MM-dd(HH:mm:SSS))} この例では、日時を2015-09-21(16:49:717)形式で提供します。 |
${time(TimeFormat)#(1d,-1y)} | このメソッドは、入力値として、日時をカスタマイズして渡します。日時の形式は、自身で指定可能です。 | ${time(yyyy-MM-dd(HH:mm:SSS))#(5d,2m,-1y)} この例では、日時を2015-09-21(16:49:717)形式で提供します。 |
${passAuthToken(authtoken)} | このメソッドは、「認証トークン」で言及のあるSOAPレスポンスに由来の、トークンやアクセス キーを置き換えます。 | ${passAuthToken(authtoken)} この例では、トークンのノードを、<LogOnToken>${passAuthToken(authtoken)}</LogOnToken>形式で作成します。タグ名 <LogOnToken>は一例であり、他のものでも問題ありません。 |
${nonce()} | このメソッドは、Base64でエンコードした16バイトのnonce値を発生させます。 | ${nonce()} この例では、Base64でエンコードした16バイトのnonce値を生成し、重複を回避しています。例:NGMzb05BeHF6V1dHNTNuNQ== |
XSLT入力を追加する
SOAP操作でXSLTを使うには、どうすればよいですか?
操作を追加するには、「XSL変換の追加」ボタンをクリックして入力にフォーマット情報を指定します。返し値が複数ある場合は、次のようにします。
-
出力形式はtextにセットしてください。outputタグを利用してXSLTコードを追加します。例:<xsl:output method="text"/>
-
出力はキー・バリューのペアになります。たとえば、気温を確認する属性を追加する場合は、XSLT出力は、「Temperature:100」形式です。
-
キー・バリューのペアは、1行ごとに区切って入力ください。
Key1 : Value1
Key2 : Value2
Key3 : Value3
SOAP操作1回につき、それぞれのキーは一意としてください。ただし、他の操作との間で、キーの重複があっても問題ありません。
既存の操作にXSLT入力を加えるには、どうしたらよいでしょうか?
-
操作の管理をクリック、編集の選択ののち、変更を行ってください。最後に更新をクリックしてください。
-
操作の詳細を組陸します。SOAPリクエスト タブを選択、変更を行ったのち、更新をクリックします。
XSLTを利用して作成した属性は、どこで確認できますか?
操作統計テーブルで、XSLTデータの表示を要する操作を選択してください。SOAPレスポンス タブが開き、そちらで属性が表示されるほか、しきい値の追加やレポート作成もできます。数値型のデータは、テーブルにくわえグラフでも表示します。
属性のレポートを有効にするには、どうすればよいですか?
-
レポート タブへ移動し、レポートの有効化を選択ください。
-
Webサービス タイプを選択します。
-
レポート作成が必要な属性を選択してください。
-
更新をクリックします。レポート表示まで、データのアーカイブ作業をお待ちください。
引数を編集するには
「操作の統計」セクションで操作の管理をクリックし、「操作の管理」へ移動してください。こちらで、アイコンをクリックすると、SOAPアクションとSOAPリクエスト値を含め、操作の表示名や引数を編集できます。
既存の操作にXSLT入力を加えるには、どうしたらよいでしょうか?
-
操作の管理をクリックして編集を選択し、必要な変更を加えてから、更新をクリックしてください。
-
操作の詳細をクリックします。SOAPリクエスト タブを選択して変更を加え、add changes and更新をクリックしてください。
XSLTを利用して作成した属性は、どこで確認できますか?
-
操作統計テーブルで、XSLTデータの表示を要する操作を選択してください。SOAPレスポンス タブが開き、そちらで属性が表示されるほか、しきい値の追加やレポート作成もできます。数値型のデータは、テーブルにくわえグラフでも表示します。
属性のレポートを有効にするには、どうすればよいですか?
属性のレポートは、2通りの有効化手順があります。
SOAPレスポンス ページから
-
SOAPレスポンス ページでは、全XSLT属性の詳細がテーブルで表示されています。
-
テーブルにあるチェック ボックスで、操作レベルでの属性レポートを有効・無効にできます。
-
テーブルから属性を選び、レポートの有効化かレポートの無効化を選択して実行してください。
レポート タブから
-
レポート タブへ移動し、レポートの有効化を選択します。
-
Webサービス タイプを選択します。
-
レポート作成が必要な属性を選択してください。
-
更新をクリック
-
レポート表示まで、データのアーカイブ作業をお待ちください。
Webサービス |
|
メモ:
監視の作成後は、操作を追加してください。他の操作のレスポンスから取得した値を入力に使うには、passAuthToken関数を実行します。構文:${passAuthToken(authtoken)} |
REST API――概要
REST(REpresentational State Transfer)はステータス管理のデザイン コンセプトで、HTTP/HTTPSでのデータ通信を定義しています。API呼び出しはREST定義に準拠したものが大多数で、これをREST APIと呼びます。
REST API監視――当社が提供すること
- REST APIエンド ポイントの可用性と応答時間を監視します。
- お客さまAPIを利用するモバイル アプリやWebアプリの応答時間がわかります。
- APIから正しいデータが戻っているか、レスポンス詳細タブで確認可能です。
- APIトランザクションに失敗すれば、通知します。
- 障害を検知し、訪問者に影響が及ぶ前の予兆の段階で、問題を解決できます。
REST API監視――新規監視を追加するには
API監視を設定するには、下記の手順に従ってください。
- 新規監視をクリックして、REST APIを選択します。
- 監視の表示名を入力します。
- REST API URLすなわち、監視するAPI呼び出しを入力します。
- タイムアウト値を入力してください(秒)。Applications ManagerからAPIサービスのホスト サーバーへ、接続を確立するまで待期できる時間を指定します。
- APIに使うフォーム送信メソッドを選択します。
- ユーザー名とパスワードなど認証情報を入力するか、認証情報マネージャーのリストから選択してください。認証不要の場合、このフィールドは空欄のままにしてください。
- APIサーバーとの接続に使う HTTP/HTTPSヘッダーを設定します。ヘッダー名と値は、「#」で区切ってください。複数ヘッダーを指定するには、「_sep_」を区切りにします。例:User-AgentMozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.61/537.36_sep_Accept-Charset#utf-8
- 期待するレスポンスのタイプを指定します。XML・JSONレスポンスのサンプルには、監視詳細ページのレスポンス詳細タブで、特定応答タイプを定義できます。
- プロキシ設定が、Applications Managerとブラウザーで一致するか確認ください。監視するAPI呼び出しによっては、ローカル アドレスとサブネット マスクのバイパスが必要な例があります。
- マッチさせる文字列が、APIレスポンスに存在することを確認ください。
- 認証情報のテスト ボタンをクリックすると、Applications Managerインストール先のマシンから、APIサービスにアクセス可能か、確認できます。
- REST API監視を関連付ける監視グループを、コンボボックスで選択します(任意項目)。監視は複数グループに関連付け可能です。
- 監視の追加をクリックしてください。これにより、ネットワークからAPIサービスを検出し、監視が始まります。
AddMonitor APIでREST API監視を追加する
構文
パラメーター |
説明 |
---|---|
type | 追加する監視のタイプです。RESTAPIMonitorを指定してください。 |
displayname | 監視の表示名を指します。 |
API | 監視するAPI呼び出しを指定ください。 |
Timeout | Applications ManagerからAPIサービスのホスト サーバーへ、接続確立まで待てる時間の上限を指定します(秒)。 |
Method | APIに使うフォーム送信メソッドを指定します(GET/POST/PUT/DELETE)。 |
RespType | 期待するレスポンスのタイプを指定します(Text/XML/JSON)。 |
payLoadType |
リクエスト データ送信フォーマットを指定します(POST、PUTのみ)。FORM、Text、XML、JSONから選択します。 |
payLoad | リクエスト データです。フォーマットは指定のペイロード タイプに合わせてください。 |
customHeaders | APIサーバーとの接続に使うヘッダーを指定します。ヘッダー名と値は、_sep_で区切って下さい。複数ヘッダーを指定するには、区切り記号に「#」を利用します。GETでのパラメーター送信時は、エンコードを施す必要があります。 |
例
監視対象のパラメーター
監視タブをクリックし、監視カテゴリ ビューへ移動してください。Webサーバー/サービス テーブルで、 REST API をクリックしてください。REST API一括設定ビューが3つのタブに分類・表示されます。
-
可用性タブでは、過去24時間か30日の可用性履歴がわかります。
-
パフォーマンスタブでは、過去24時間か30日のステータスとイベントがわかります。
-
リスト ビューでは、一括管理設定が必要です。
パラメーター |
説明 |
---|---|
応答時間 |
APIレスポンスの取得にかかる時間の全体を表します。DNS参照、接続、JSON・テキスト・XMLでのレスポンス応答にかかる時間の合計です。
|
レスポンス コンテンツ詳細 |
レスポンスのサイズ(バイト)と、連続ポーリングの間のサイズの変化率(%)を示します。
|
カスタム属性の定義
取得するレスポンスに応じて、APIレスポンスに含まれる値を独自属性で監視できます。
-
XMLでレスポンスを受けるには監視する値の定義には、XSLT変換を利用できます。MDN Web Docs(Mozilla Developer Network)やw3schools.comに詳細説明があります。次の基準を満たすようにしてください。
-
出力method属性はtextにします。構文:<xsl:output method="text"/>
-
最終出力は、属性名から属性値を取り出すようにします。たとえば、「Days:<xsl:value-of select="days"/>」を指定すると、属性名「Days」でXMLの<days>タグが作成され、その値がAPIレスポンスからタグで取得できます。
-
-
JSONでレスポンスを受けるには:ユーザー定義属性の設定には、JSONスキームを利用できます。次の基準を満たすようにしてください。
-
最終出力は、属性名から属性値を取り出すようにします。たとえば、「Temperature::response.weather.temperature」を指定すると、属性名「Temperature」でJSONの「temperature」キーが作成され、このキーに対応する値が取得できます。
-
複数JSONスキームを定義する際は、改行区切りにしてください。
-
JSONキー自体でドット(.)が利用されている場合、「_sep_」に置き換えてください。この処理は、すべてのキーで実行してください。新規キーを「temperature」ではなく「temperature.celsius」という名前にするには、「response.weather.temperature_sep_celsius」と記載する必要があります。
-