監視追加API―カスタム監視

このページでは、AddMonitor APIで、カテゴリ タイプ「カスタム監視」の監視を追加する方法を説明します。製品では次の監視をサポートします。

Windowsパフォーマンス カウンター

構文
http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&username=[USER_NAME]&password=[PASS_WORD]&pollInterval=[POLL_INTERVAL]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。

フィールド 説明        
type 追加する監視のタイプです。Windows Performance Countersを指定してください。
host Windowsパフォーマンス カウンターを実行しているホストの名前を指します。
username Windowsパフォーマンス カウンターを実行しているホストのユーザー名です。
password Windowsパフォーマンス カウンターを実行しているホストのパスワードです。
pollinterval ポーリング発生に指定する間隔を指します。

リクエスト サンプル

http://app-xp4:9090/AppManager/xml/AddMonitor?apikey=ee8d8e237bd5e1a0d8aed16a381c3b73&type=Windows Performance Counters&host=app-xpmll&displayname=hhhh&username=asasaa&password=admin123

データベース クエリ監視

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[TYPE]&displayname=[DISPLAY_NAME]&host=[HOST]&port=[PORT]&username=[USER_NAME]&password=[PASS_WORD]&databasetype=[DATABASETYPE]&databasename=[DATABASENAME]&sslenabled=[true/false]&showqueryoutput=[SHOWQUERYOUTPUT]&queries=[QUERIES]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。

フィールド 説明
type 追加する監視のタイプです。値はQueryMonitorにしてください。
host データベース サーバーを実行しているホストの名前を指します。
port データベースが動作するポート番号です。
username データベース サーバーのユーザー名です。
password データベース サーバーのパスワードです。
databasetype クエリ実行先のデータベースのタイプを指定します。
databasename データベース サーバーの名前です。
SSLEnabled SSLを有効にするオプションです。値はtrueかfalseにしてください。
showqueryoutput クエリ出力を希望するか指定します。値はyesかnoにします。
queries データベース クエリを記載してくださ。最大5つです。

リクエスト サンプル

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=bbab7f01458e96595b06d5c27efcc3af&type=QueryMonitor&displayname=qury&host=app-xp2&port=1433&username=sa&password=Advent1&databasetype=MsSQL&databasename=AMDB&SSLEnabled=true&showqueryoutput=yes&queries=select * from user

ファイル/ディレクトリ監視

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=File Monitor&displayname=[DISPLAY_NAME]&filepath=[FILEPATH]&serversite=[SERVERSITE]&pollInterval=[POLL_INTERVAL]&timeout=[TIME_OUT]

リクエスト パラメーター

APIリクエストにかかわるパラメーターを下に記します。あわせて、共通リクエスト パラメーターのリストも参照ください。

フィールド 説明        
type 追加する監視のタイプです。値はFile MonitorかDirectory Monitorにしてください。
host ファイル監視を実行しているホストの名前です。
serversite 監視するファイル/ディレクトリがローカル サーバーにあるかリモート サーバーにあるかを指定します（localかremoteを指定）。
filepath 監視するファイルのパスを指定します。
contentChk コンテンツ チェックを実行するか指定します。実行には、onを指定してください。
monitoringmode 監視のモードを示します。WindowsにはWMI、LinuxにはTelnetかSSHを指定してください。
choosehost
 監視するファイルやディレクトリがリモート サーバーにある場合、ホスト名を指定するか、値を「-1」にして新規ホストの追加を行います。
username ホスト接続時のユーザー名です。
password ホスト接続時のパスワードです。
timeVal ファイル/ディレクトリ未更新期間をチェックする時間の長さを指定します。
monitoringmode

監視のモード：

  • WMI：Windows
  • TelnetかSSH：Linux
prompt TelnetやSSHでつなぐ際のコマンド プロンプトを指定します。プロンプト最後の文字を入力してください。
port ファイル/ディレクトリ監視が動作するポート番号です。
fileCheckType

コンテンツ チェック実行時のファイル確認オプションを指定します。次から選んでください。

  • 0：追加コンテンツのみをチェックします。
  • 1、Whole：ファイル全体をチェックします。
selectStatusType

コンテンツや正規表現にマッチした場合、監視ステータスをアップかダウンにセットできます。次からステータスを選んでください。

  • up
  • down
selectRuleType

コンテンツや正規表現にマッチした場合、監視ステータスをアップかダウンにセットできます。次からルールを選んでください。

  • any：マッチするコンテンツや正規表現がある場合に、ステータスのセットをします。
  • all：指定コンテンツや正規表現がすべてマッチした場合に、ステータスのセットをします。
countval
fileDirAge ファイルやディレクトリの未更新期間をチェックするか指定します（onかoff）。
selectMonStatus

指定期間に、ファイルやディレクトリの変更があったかに応じて、監視ステータスをアップかダウンにセットできます。ステータスを次から選んでください。

  • up
  • down
selectChangeType

指定期間に、ファイルやディレクトリの変更があったかに応じて、監視ステータスをアップかダウンにセットできます。変更タイプを次から選んでください

  • MODIFIED
  • NOT MODIFIED
timeUnit selectMonStatusとselectChangeTypeを設定する際に使う、時間の単位を指定します。
sshkey SSH認証用のSSH鍵です。
passphrase SSHで鍵ベース認証を行う際のパスワードを指定します。
ccontent コンテンツ マッチでの確認に使う文字列を指定してください。
regexChk コンテンツ チェックで正規表現を使うには、onを指定してください。
subDirCntChk サブディレクトリ数を取得するには、onを指定します。

リクエスト サンプル

ローカル ファイルの場合

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=bbab7f01458e96595b80f042db3eff62f0&type=File Monitor&displayname=test1&filepath=F:\LATEST\AppManager\logs\stdout.txt&serversite=local&pollinterval=5&timeout=60

リモート ファイルの場合

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=1bbab7f01458e96595bb3eff62f0&type=File Monitor&displayname=test7&filepath=F:\LATEST\AppManager\logs\stdout.txt&serversite=remote&pollinterval=5&timeout=60&
choosehost=-1&monitoringmode=WMI&host=app-support-w7&username=administrator&password=Apmsupport1

ローカル ファイルでコンテンツ チェックが有効の場合

http://prod-server8:9090/AppManager/AppManager/xml/AddMonitor?apikey=945bbab7f01458e96595b795cd7&type=File Monitor&displayname=test2&filepath=d:\stdout.txt&serversite=local&pollinterval=5&timeout=60&contentChk=on®exChk=on&
ccontent=a*b&fileCheckType=whole&selectStatusType=down&selectRuleType=all

リモート ファイルでコンテンツ チェックが有効の場合

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=6a3803a905cbbab7f01458e96595b856&type=File Monitor&displayname=test12&filepath=C:\Test\Grep.txt&serversite=remote&pollinterval=5&timeout=60&contentChk=on&
ccontent=Exception&fileCheckType=whole&selectStatusType=down&selectRuleType=all&choosehost=-1&monitoringmode=WMI&host=app-xp2&username=asasaa&password=001

ファイル/ディレクトリ未更新期間確認とコンテンツ チェックを、双方とも有効にする場合

http://prod-server8:9090/AppManager//AppManager/xml/AddMonitor?apikey=1561056503f5164180f042db3eff62f0&type=File Monitor&displayname=test6&filepath=F:\LATEST\AppManager\logs\stdout.txt&serversite=local&pollinterval=5&timeout=60&
fileDirAge=yes&selectMonStatus=down&selectChangeType=notmodified&timeval=50&timeUnit=Minutes&contentChk=on&
ccontent=test&fileCheckType=whole&selectStatusType=down&selectRuleType=any&countval=3

スクリプト監視

構文

http://[Host]:[Port]/AppManager/xml/AddMonitor?apikey=[API_KEY]&type=[Script Monitor]&displayname=[DISPLAY_NAME]&serverpath=[SERVER_PATH]&workingdirectory=[FILEPATH]&serversite=[LOCAL/REMOTE]&pollInterval=[POLL_INTERVAL]&timeout=[TIME_OUT]

リクエスト パラメーター

APIリクエストに必須のパラメーターを下に記します。共通リクエスト パラメーターのリストも参照ください。

必須パラメーター 値 説明        
type Script Monitor 追加する監視のタイプです。値はScript Monitorにしてください。
displayname 監視の表示名を表します。
serverpath サーバーにあるスクリプト ファイルのパスを指定します。
workingdirectory スクリプトを実行するディレクトリです。
serversite localかremote 監視するスクリプトがローカル サーバーにあるかリモート サーバーにあるかを示します。
pollinterval ポーリング間隔を指定します。デフォルトでは、5分です。
timeout タイムアウトを指定します（秒）。スクリプト実行の最長時間を指し、これを超えるとタイムアウトします。
isCommand スクリプトのある場所をコマンドとして選択するのに使います。API呼び出しで「true」を指定してください。

スクリプトがリモート サーバーにある場合、パラメーターは次の通りです。

フィールド 値 説明        
host スクリプト監視を実行しているホストの名前かIPアドレスを表します。
monitoringmode Telnet、SSH、Powershell 監視のモードを指定します。LinuxではTelnetかSSH、WindowsではPowershellです。
choosehost -1かhostid 新規ホストには「-1」を利用します。既存ホストの場合は、「SELECT * FROM AM_SCRIPTHOSTDETAILS」で取得してください。
port 23か22
username 新規ホスト追加に使うユーザー名です。
password 新規ホスト追加に使うパスワードです。
sshkey onかoff SSH認証用のSSH鍵です。公開鍵認証に使います（SSH 2のみ）。デフォルトではoffです。
passphrase SSHで鍵ベース認証を行う際のパスワードを指定します。
prompt TelnetやSSHでつなぐ際のコマンド プロンプトを指定します。プロンプト最後の文字を入力してください。デフォルトでは$です。
mode sh モードを入力してください。デフォルトでは「sh」です。
説明 秘密鍵

出力設定を有効にした場合のパラメーターを記します。

フィールド 値 説明        
opfile trueかfalse ファイルから出力内容を取得するかを指定します。
outputfile 出力ファイルのパスを指定します。
string_att 文字列型属性を入力してください。
numeric_att 数値型属性を入力してください。
delimiter 出力ファイルで使う区切り記号を入力してください。デフォルトでは「=」となっています。区切り記号を指定しない場合は、空白を区切りと見なします。

出力ファイルでテーブルを有効にした場合の、パラメーターを示します。

フィールド 値 説明        
tablepresent onかoff 出力設定を行います。デフォルトではoffとなっています。
table_row テーブルにある行の数です。
table<index> テーブル名を指定します。
numericatt<index> 数値型属性を指します。
stringatt<index> 文字列型属性を指します。
pcatt<index> 一意のカラムです。
cdl1<index> カラムの区切り文字です。
message 引数です。
pollinterval ポーリング間隔を指定します。
timeout タイムアウトを表します。
manageTableRow retain、delete、unmanage テーブル行管理の選択肢です。

リクエスト サンプル

ローカル サーバーの場合

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=1561056503f5164180f2db3eff62f0&type=Script Monitor&displayname=test1&serverpath=F:\AppManager\bin\CkServerConnection.bat&workingdirectory=
F:\Managed\AppManager\bin\&serversite=local&pollinterval=5&timeout=30

リモート サーバーの場合

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=151056503f5164180f2db3b3eff62f0&type=Script Monitor&displayname=test2&serverpath=/home/likewise-open/ZOHOCORP/prodserver-9091/test.sh&workingdirectory=/home/ZOHOCORP/prodserver-9091&serversite=remote&pollinterval=5&timeout=60&choosehost=-1&monitoringmode=SSH&host=prodserver-9091&username=prodserver-9091&password=Zoho123&prompt=$port=22

コマンド タイプ スクリプトの場合

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=a0c6b6d593637f737f34dab03132faca&type=Script Monitor&displayname=testAPI222&serverpath= echo helo&workingdirectory=/home/test&serversite=remote&pollinterval=5&timeout=60&choosehost=5&isCommand=true

出力設定を有効にした場合（複数指定はLF区切り［%0A］）

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=1561003f5164180f280f042db3eff62f0&type=Script Monitor&displayname=test3&serverpath=F:\AppManager\bin\ChkServerConnection.bat&workingdirectory=
F:\AppManager\bin\&serversite=local&pollinterval=5&timeout=60&opfile=true&outputfile=F:\AppManager\bin\result.txt&
string_att=Name1,Name2&numeric_att=Age1,Age2&delimiter==

出力ファイルでテーブルを有効にする場合

http://prod-server8:9090/AppManager/xml/AddMonitor?apikey=1561056503f5164180f042db3eff62f0&type=Script Monitor&displayname=test3&serverpath=F:\AppManager\bin\ChkServerConnection.bat&workingdirectory=F:\AppManager\bin\
&serversite=local&pollinterval=5&timeout=60&opfile=true&outputfile=F:\AppManager\bin\result.txt&
string_att=Name1,Name2&numeric_att=Age1,Age2&delimiter==&tablespresent=on&table_row=1&
table1=Test1&numericatt1=Num1&stringatt1=Str1&pcatt1=Num1&cdl1=|&manageTableRow=delete