EPAgent のデフォルト プラグイン

内容
apmdevops98jp
内容
CA APM Environment Performance Agent は、デフォルトのプラグインを提供し、オプションのコマンド ライン引数を備えています。
solaris/diskStats.pl
このプラグインは、システムのハード ディスクに関する情報を含むメトリックを返します。
生成されるメトリック
/solaris/diskStats.pl プラグインによって作成されるメトリックの詳細については、「Solaris カーネル統計情報(Kstat)メトリック」を参照してください。
コマンド ライン引数
このプラグインでは、コマンド ライン引数としてディスク名を指定します。 ディスク名が指定されていない場合、すべてのディスクに関する情報がレポートされます。
  • たとえば、以下のコマンドは、すべてのローカル ディスクについてのメトリックをレポートします。
    perl diskStats.pl
  • 以下のコマンドは、ディスクの「/」および「/usr」のみについてのメトリックをレポートします。
    perl diskStats.pl / /usr
注:
この引数を使用して結果の範囲を限定することをお勧めします。
windows/processAvailability.pl、および solaris/processAvailability.pl
このプラグインは、引数の値で渡されたものと一致するプロセス名の数と同じ値のメトリックを返します。 返されるメトリックのタイプは、「IntCounter」です。
生成されるメトリック
/windows/processAvailability.pl、および solaris/processAvailability.pl プラグインによって作成されるメトリックの詳細ついては、「プロセスの可用性メトリック」を参照してください。
コマンド ライン引数
これらのプラグインには、以下の 5 つのオプションのコマンド ライン引数が必要です。
match
検索に使用する Perl の正規表現
resource
メトリック名のリソース部
subResource
メトリック名のサブリソース部
metric
メトリック名の主要部
distinctMatch
これは値を持たず、各正規表現のそれぞれに一致するカウントを保持し、レポートするかどうかを決定します。 このオプションは、指定されていれば、subResource 引数の値に優先します。
以下の例では、「sh」文字で始まるプロセスの数をレポートします。
perl processAvailability.pl -match ^sh
windows/diskStats.pl
このプラグインは、Windows パフォーマンス モニタによる統計情報に基づいたディスクの使用率/容量の統計をレポートします。
このプラグインがすべての統計情報を適切にレポートするには、「diskperf -y」コマンドを発行する必要があります。 その後で、新しい設定をアクティブ化するためにマシンを再起動する必要があります。
生成されるメトリック
/windows/diskStats.pl プラグインによって作成されるメトリックの詳細については、「ディスク統計情報(Windows)メトリック」を参照してください。
コマンド ライン引数
このプラグインでは、コマンド ライン引数としてディスク名を指定します。 ディスク名が指定されていない場合、すべてのディスクに関する情報がレポートされます。
  • たとえば、以下のコマンドは、すべてのローカル ディスクについてのメトリックをレポートします。
    perl diskStats.pl
  • 以下のコマンドは、ディスク c: および d: のみについてのメトリックをレポートします。
    perl diskStats.pl c: d:
注:
この引数を使用して結果の範囲を限定することをお勧めします。
apacheLogReader.pl、weblogicLogReader.pl、および websphereLogReader.pl
これらのプラグインは、<
webserver
>LogReader.cfg ファイル内のメトリック構成に基づいてメトリックをレポートします。
それぞれの Web サーバのアプリケーション ログファイル パーサには、それぞれ、スリープ遅延、サブリソース名、リソース名、ログファイル ディレクトリ、およびログファイル名パターンのデフォルトの値を設定した独自の環境設定ファイルがあります。
注:
これらのログ リーダー プラグインのいずれかを使用すると、新しいエントリがログファイルに追加されるまで、EPAgent は Enterprise Manager へのレポートを開始しません。
生成されるメトリック
これらのプラグインによって作成されるメトリックの詳細については、以下で説明します。
  • Apache ログ メトリック
  • WebSphere ログ メトリック
  • WebLogic ログ メトリック
コマンド ライン引数
これらのプラグインには、以下の 4 つのオプションのコマンド ライン引数が必要です。
logfileDir
ログファイルが格納されるディレクトリ
sleepTime
新しいメッセージをログファイルにログするかをチェックする間の(遅延)秒数
logfile
生成されるログファイルの名前に対応する正規表現
subResource
メトリック名のサブリソース部
例:
perl apacheLogReader.pl -sleepTime 30 -logfileDir "c:/Apache/logs"
httpSvcAvailability.pl
このプラグインは、指定した URL での HTTP サービスの可用性およびパフォーマンスに基づくメトリックをレポートします。
生成されるメトリック
httpSvcAvailability.pl プラグインによって作成されるメトリックの詳細については、「HTTP/HTTPS サービス可用性メトリック」を参照してください。
コマンド ライン引数
このプラグインには、以下の 3 つのオプションのコマンドライン引数が必要です。
url
オプションでポート番号の指定のあるカンマ区切りの URL セット。 URL はポート番号(デフォルトとは異なる場合)と、HTTP と HTTPS を識別するために http: または https: を含めることができます。
get
サーバに対して発行する、HTTP 要求のカンマ区切りリスト(スペースなし)が必要です。
Web サイトによっては HEAD 要求を受け入れないことがあり、またアプリケーション サーバによっては GET がサポートされないことがあります。
GET、HEAD のうち少なくとも 1 つを指定する必要があります。
GET と HEAD の両方が指定されると、HEAD が
まず実行され、続いて GET が実行されます。
デフォルト:
-request HEAD
metric
返されるメトリックのカンマ区切りリスト
  • av = 使用可能/接続可能(0= 不可、1= 可)
  • rt = 往復応答時間(接続の場合)
  • tp = スループット(KB。 返された/往復応答の KB 数)
  • all = すべての統計情報
デフォルト:
all
例:
perl epaplugins/solaris/httpSvcAvailability.pl -url https://secure.server.com,http:8080//IIS.server.com
Perl サポートの問題
httpSvcAvailability.pl プラグイン(HTTP)の場合:
httpSvcAvailability.pl プラグイン(HTTP)では、基本的な http サービスの確認用に Perl ライブラリ libwww-per(v5.65 以降)のインストールが必要です。 www.activestate.com では、libwww-perl をインストールの一部として含んだ Perl v5.6.1 を提供しています。
httpSvcAvailability.pl プラグイン(HTTPS)の場合:
Windows で https サービスを確認するには、Crypt-SSLeay(v0.17.1 以降)をインストールする必要があります。
  • Solaris で https サービスを確認するには、Net-SSLeay (v1.05 以降)をインストールする必要があります。 このどちらの場合でも、ActiveState Perl に含まれる PPM パッケージ マネージャ ツールを使用すると、最も容易にインストールできます。
kstat.pl
このプラグインは、Solaris の kstat ユーティリティによるカーネル統計情報に基づいたメトリックをレポートします。
生成されるメトリック
kstat.pl プラグインによって作成されるメトリックの詳細については、「Solaris カーネル統計情報(Kstat)メトリック」を参照してください。
コマンド ライン引数
このプラグインには、以下の 4 つのオプションのコマンドライン引数が必要です。
class
kstat クラスを照合する正規表現
module
kstat モジュールを照合する正規表現
name
kstat 名を照合する正規表現
statistic
kstat 統計情報を照合する正規表現
注:
これらの引数を使用して結果の範囲を限定することをお勧めします。 コマンド ライン スイッチが指定されていない場合、プラグインは、クラス、モジュール、名前、および統計情報のすべての Solaris カーネルの情報を返します。
例:
perl epaplugins/solaris/kstat.pl -class vm -module unix -name segmap -statistic '^free'
Introscope メトリックは、ノード VMを作成し、次にリソース UNIX を、次に segmap を作成してから、「free」を表示し、次に値を表示します。
注:
kstat によりリソース名に対して null 値がレポートされた場合、メトリックは生成されません。
Perl サポートの問題
パフォーマンスを向上させるには、kstat.pl プラグインを Solaris 提供の Perl (通常、/usr/bin/perl にあり、Perl ライブラリは /usr/perl5 にインストールされています)で実行することをお勧めします。これは、内蔵されている Perl ライブラリが Solaris カーネル サブシステムへの直接のインタフェースをサポートしているためです。 kstat.pl プラグインを別の Perl インストールで実行する場合は、kstat.pl コマンド ライン ユーティリティを使用します。これにより、余分なオーバーヘッドが多少生じます。
iisLogReader.pl
このプラグインは、iisLogReader.cfg ファイルの設定に基づいたメトリックをレポートします。
注:
このログ リーダー プラグインを使用する場合、新しいエントリがログファイルに追加されるまで、EPAgent は Enterprise Manager へのレポートを開始しません。
生成されるメトリック
iisLogReader.pl プラグインによって作成されるメトリックの詳細については、「IIS ログ リーダー メトリック」を参照してください。
コマンド ライン引数
このプラグインには、以下の 4 つのオプションのコマンドライン引数が必要です。
logfileDir
ログファイルが格納されるディレクトリ
sleepTime
新しいメッセージをログファイルにログするかをチェックする間の(遅延)秒数
logfile
生成されるログファイルの名前に対応する正規表現
subResource
メトリック名のサブリソース部
例:
perl iisLogReader.pl -sleepTime 30 -logfileDir "c:/Program Files/iis/logs"
iisLogReader.cfg 環境設定ファイル
iisLogReader.cfg ファイルには、iisLogReader.pl ファイル内のコマンド ライン引数の値が含まれています。
それぞれの Web サーバのアプリケーション ログファイル パーサには、それぞれ、スリープ遅延、サブリソース名、リソース名、ログファイル ディレクトリ、およびログファイル名パターンのデフォルトの値を設定した独自の環境設定ファイルがあります。 環境設定ファイルには、一致を照合し、レポートする、メトリックのリストも含まれています。 各メトリックの設定では、match(正規表現)、metricType、metricName、および metricValue を指定できます。
LOGFILEDIR
関連付けられた Web サーバのログファイルを含むディレクトリの完全パス名。
注:
Windows のパスでもスラッシュは有効なパス区切り文字です(円記号も使用できます)。
デフォルト
C:/WINNT/system32/LogFiles/W3SVC1
LOGFILE
読み取るログファイルの名前。 これは、時間の経過に伴って変化する正規表現(たとえば、ログファイルの循環利用)である必要があります。 この照合では、大文字と小文字が区別されません。
注:
これは、ファイルの名前全体(パスを除く)が一致している必要があります。
注:
IIS が W3C 拡張ログ ファイル形式に設定されている場合、デフォルトはログファイル名と一致するように設定されます。これは、iisLogReader.pl プラグインによってのみサポートされる形式です。
デフォルト
ex(tend)?\d+\.log
SLEEPTIME
新しいメッセージをログファイルにログするかをチェックする間の(遅延)秒数。
カウンタ メトリックは、「間隔ごと」(メトリックの表を参照)として定義され、通常、SLEEPTIME は、Enterprise Manager のタイム スライス(15 秒)以上に設定する必要があります。それ以外の場合は、カウンタ メトリックが不正確になります。
デフォルト
15
RESOURCE
Introscope メトリック名のリソース部 Investigator Workstation のエージェント ノードの下の最初のノードに対応しています。
デフォルト
IISWebServer
SUBRESOURCE
Introscope メトリック名のサブリソース部です。 これは、上記で指定した Resource ノードの下のサブノードに対応しています。
デフォルト
<空>
LINE_FORMAT
IIS Web サーバがログに記録する行の正確な形式を定義します。
行の形式のサブプロパティを、LINE_FORMAT サブプロパティの表で説明します。
デフォルト
該当なし
LINE_FORMAT サブプロパティ
以下の表では、プロパティ LINE_FORMAT、およびそのすべてのサブプロパティについて説明します。
以下の LINE_FORMAT のプロパティは、IIS Web サーバによってログ ファイルに記録されたフィールドと正確に一致する必要があります。 一致しない場合、iisLogReader.pl プラグインは一部またはすべてのメトリックをレポートできなくなります。
IIS Web サーバの正確なフィールドは、IIS 管理ツール(または古いバージョンの IIS ではWeb ページ)内で設定されます。 IIS4.0 および IIS5.0 で IIS Web サーバ ログのログ記録フィールドを設定できます。
デフォルトでは、IIS Web サーバは以下のフィールドにのみログを記録します。
  • 時間
  • クライアント IP アドレス
  • メソッド
  • URI ステム
  • プロトコルの状態
一致させるには、デフォルトの iisLogReader.cfg ファイルでもこれら 5 つの LINE_FORMAT サブプロパティのみを有効にします。
初期状態の iisLogReader.pl プラグインでは、IIS Web サーバ ログ設定のデフォルト値を前提としています。 このプラグインは、Bytes Transferred を除くすべてのメトリックをレポートできます。 Bytes Transferred については、IIS Web サーバによって BytesSent データ フィールドにログが記録され、iisLogReader.cfg サブプロパティ BytesSent のコメント化が解除(有効化)される必要があります。 IIS Web サーバおよび iisLogReader.cfg の BytesSent の有効化に失敗した場合、Bytes Transferred メトリックは CA Introscope にレポートされません。
サブプロパティ行がコメント化解除されている場合、iisLogReader.pl プラグインは、IIS Web サーバ ログファイル(LOGFILEDIR および LOGFILE プロパティによって指定された)に該当のフィールドがあると想定します。 反対に、このサブプロパティ行がコメント化されている場合、iisLogReader.pl プラグインは、ログファイルでこのフィールドを検索しません。 このサブプロパティ行の順序が左から右の順で一致済みのときは、IIS Web サーバはデータをログに記録します(フィールドが IIS Web サーバで有効化された場合)。 順序は変更しないでください。
DELIMITER
空白(スペース、タブ)の連続
デフォルト
\s+
FIELDS
該当なし
デフォルト
該当なし
FIELDS->Date
アクティビティが発生した日付。 YYYY-MM-DD。
デフォルト
\d\d\d\d-\d\d-\d\d
FIELDS->Time
デフォルトで有効です。
アクティビティが発生した時間。 グリニッジ標準時での24時間制の HH:MM:SS。
デフォルト
\d\d\d\d-\d\d-\d\d
FIELDS->ClientIPAddress
デフォルトで有効です。
使用するサーバにアクセスしたクライアントの IP アドレス。 ピリオドで区切られた 4 つの数字。
デフォルト
\d+\.\d+\.\d+\.\d+
FIELDS->UserName
使用するサーバにアクセスしたユーザの名前。 円記号、および英数字の任意の組み合わせ。
デフォルト
[-\\\w]+
FIELDS->ServiceName
クライアント コンピュータ上で実行中だったインターネット サービス。 英数字の任意の組み合わせ。
デフォルト
\w+
FIELDS->ServerName
ログ エントリが生成されたサーバの名前。 ピリオド、ハイフン、英数字の任意の組み合わせ。
デフォルト
[.-\w]+
FIELDS->ServerIPAddress
ログ エントリが生成されたサーバの IP アドレス。 ピリオドで区切られた 4 つの数字。
デフォルト
\d+\.\d+\.\d+\.\d+
FIELDS->ServerPort
クライアントが接続するポート番号。 1 桁以上の数字。
デフォルト
\d+
FIELDS->Method
デフォルトで有効です。
クライアントが実行を試行したアクション(たとえば、GET コマンド)。
デフォルト
GET|HEAD|PUT|POST|DELETE
FIELDS->URIStem
デフォルトで有効です。
HTML ページ、CGI プログラム、またはスクリプトなどにアクセスしたリソース。 スペース無しのシーケンス。
デフォルト
\S+
FIELDS->URIQuery
クライアントが実行を試行したクエリ、つまり、クライアントが一致を検索した1 つ以上の検索文字列(ある場合)。 スペース無しのシーケンス。
デフォルト
\S+
FIELDS->ProtocolStatus
デフォルトで有効です。
HTTP を使用したアクションのステータス。
デフォルト
\d+
FIELDS->Win32Status
Windows で使用されるアクションのステータス。 1 桁以上の数字。
デフォルト
\d+
FIELDS->BytesSent
サーバが送信したバイト数の合計。 1 桁以上の数字。
注:
IIS では、このフィールドはデフォルトで有効ではありません。 「転送バイト数」メトリックを収集するにはオンになっている必要があります。
デフォルト
\d+
FIELDS->BytesReceived
サーバが受信したバイト数の合計。 1 桁以上の数字。
デフォルト
\d+
FIELDS->TimeTaken
アクションにかかった時間の長さ(ミリ秒単位)。 1 桁以上の数字。
デフォルト
\d+
FIELDS->ProtocolVersion
クライアントが使用するプロトコル(HTTP、FTP)のバージョン。 HTTP の場合、これは、HTTP 1.0 か HTTP 1.1 のいずれかです。 英数字、スラッシュ、およびピリオドのシーケンスです。
デフォルト
[\w/.]+
FIELDS->Host
クライアントのホストです。 英数字、ピリオド、コロンのシーケンスです。
デフォルト
[\w.:]+
FIELDS->UserAgent
クライアント上で使用されるブラウザ。 スペース無しのシーケンス。
デフォルト
\S+
FIELDS->Cookie
送信または受信したクッキーの内容(ある場合)。 スペース無しのシーケンス。
デフォルト
\S+
FIELDS->Referer
ユーザを現在のサイトに移動させたサイト。 スペース無しのシーケンス。
デフォルト
\S+
IIS4.0 および IIS5.0 での IIS Web サーバ ログ記録の設定
インターネット インフォメーション サービス マネージャを起動します。
左側で、使用するコンピュータのツリー ノードを展開します。
以下の 3 つのノードが表示されます。
  • FTP サイト
  • Web サイト
  • SMTP 仮想サーバ
[Web サイト]ノードを右クリックし、[プロパティ]を選択します。
[プロパティ]ダイアログ ボックスが表示されます。
This image of the properties window shows the necessary options selected to configure the IIS Web Server for logging.
[Web サイト]タブを選択し、以下の設定を確認します。
  • [ログ記録を有効にする]チェックボックスがオン。
  • [アクティブ ログ形式]ドロップダウン リストで[W3C 拡張ログ ファイル形式]がオン。
[プロパティ]をクリックします。
[拡張ログのプロパティ]ダイアログ ボックスが表示されます。
This image shows the Extended Logging Options window with the options necessary for the plug-in to report metrics.
[全般プロパティ]タブで、ログ ファイル ディレクトリを指定します。iisLogReader.cfg ファイ ル内の LOGFILEDIR プロパティと一致している必要があります。
[拡張プロパティ]タブの以下のフィールドは、iisLogReader.pl プラグインがそのメトリック のすべてをレポートするのに必要/必須なものです。
  • 時間
  • クライアント IP アドレス
  • メソッド
  • URI ステム
  • プロトコルの状態
  • 送信バイト数(転送バイト数を表示するために必要です)
有効になっているすべてのフィールドは、LINE_FORMAT->FIELDS セクションの下の iisLogReader.cfg ファイルで有効化(コメント化解除)されたフィールドに一致する必要があります。 iisLogReader.cfg ファイルのこの部分は、iisLogReader.pl プラグインに、このログファイルで前提となる正しい行の形式を知らせます。 不一致がある場合、iisLogReader.pl プラグインはメトリックをレポートできないか、または正しくないメトリックをレポートします。