4.1.5 抽出エントリ定義ファイル

抽出エントリ定義ファイルは,EDMRptAclogコマンド,EDMRptTraceコマンドのエントリ抽出機能で,-xオプションを指定してエントリを抽出する場合に,抽出するエントリのメソッド名,引数および処理の種別を指定しておくファイルです。EDMRptAclogコマンド,EDMRptTraceコマンドの-xオプションで,抽出エントリ定義ファイルのファイル名を指定します。

抽出エントリ定義ファイルは,ユーザが作成する必要があります。

なお,集計キー定義ファイルの内容と抽出エントリ定義ファイルの内容を,一つのファイルにまとめて記述してもかまいません。一つのファイルにまとめて記述する場合の記述規則については,「4.1.5(4) 集計キー定義ファイルと抽出エントリ定義ファイルを一つのファイルに記述する場合の記述規則」を参照してください。

<この項の構成>
(1) 記述規則
(2) 記述形式
(3) 抽出エントリ定義ファイルの記述例
(4) 集計キー定義ファイルと抽出エントリ定義ファイルを一つのファイルに記述する場合の記述規則

(1) 記述規則

抽出エントリ定義ファイルの記述規則は次のとおりです。

(2) 記述形式

抽出エントリ定義ファイルの記述形式を次に示します。

# Extract Entry Definition File                    ‥‥コメント

[Extract Aclog]                                    ‥‥セクション
<メソッド名 引数>                                  ‥‥エントリ
<メソッド名 引数>                                  ‥‥エントリ

[Extract Trace]                                    ‥‥セクション
<処理の種別>                                       ‥‥エントリ
<処理の種別>                                       ‥‥エントリ

抽出エントリ定義ファイルは,[Extract Aclog]セクション,[Extract Trace]セクションと,各セクションに指定するエントリで構成されます。

各セクションとエントリの記述について説明します。

(a) セクション

[Extract Aclog]セクション,[Extract Trace]セクションの記述について説明します。

[Extract Aclog]セクション
[Extract Aclog]セクションには,EDMRptAclogコマンドのエントリ抽出機能で抽出するエントリのメソッド名と引数を指定します。[Extract Aclog]セクションは,次に示す形式で記述してください。

 [Extract Aclog]

[Extract Trace]セクション
[Extract Trace]セクションには,EDMRptTraceコマンドのエントリ抽出機能で抽出するエントリの処理の種別を指定します。[Extract Trace]セクションは,次に示す形式で記述してください。

 [Extract Trace]

各セクションは,次に示す文法に従って記述してください。

(b) エントリ

[Extract Aclog]セクションに指定するメソッド名と引数,[Extract Trace]セクションに指定する処理の種別の記述について説明します。

メソッド名と引数
EDMRptAclogコマンドのエントリ抽出機能で抽出するエントリのメソッド名と引数を,次に示す形式で記述してください。

 [Extract Aclog]
 <メソッド名 引数>
 <メソッド名 引数>

指定できるメソッド名と引数については,「表4-1 集計機能で分類されるアクセスの内容と集計項目(アクセス種別)の関係」を参照してください。不正なメソッド名と引数を指定した場合,コマンドの実行時に標準エラー出力(stderr)にメッセージが出力されて,処理が中止されます。
メソッド名と引数は,次に示す文法に従って記述してください。
  • メソッド名と引数の間は,半角空白で区切ります。
  • 複数のメソッド名と引数を指定する場合,改行で区切って指定します。
  • 同じメソッド名と引数を重複して指定した場合,最初のメソッド名と引数が有効になり,2回目以降のメソッド名と引数は不正データとして扱われて無視されます。
処理の種別
EDMRptTraceコマンドのエントリ抽出機能で抽出するエントリの処理の種別を,次に示す形式で記述してください。

 [Extract Trace]
 <処理の種別>
 <処理の種別>

指定できる処理の種別を次に示します。
  • enter
  • arg
  • call
  • return
  • error
  • warn
  • mark
  • msg
  • exit
処理の種別は,次に示す文法に従って記述してください。
  • 複数の処理の種別を指定する場合,改行で区切って指定します。
  • 同じ処理の種別を重複して指定した場合,最初の処理の種別が有効になり,2回目以降の処理の種別は不正データとして扱われて無視されます。

(3) 抽出エントリ定義ファイルの記述例

抽出エントリ定義ファイルの記述例を次に示します。

# Extract Entry Definition File

[Extract Aclog]
CREATE OBJECT
GET RESULT

[Extract Trace]
enter
msg

この例では,EDMRptAclogコマンドのエントリ抽出機能で,「CREATE OBJECT」と「GET RESULT」のエントリが抽出されます。また,EDMRptTraceコマンドのエントリ抽出機能で,「enter」と「msg」のエントリが抽出されます。

(4) 集計キー定義ファイルと抽出エントリ定義ファイルを一つのファイルに記述する場合の記述規則

集計キー定義ファイルと抽出エントリ定義ファイルを一つのファイルに記述する場合,集計キー定義ファイルおよび抽出エントリ定義ファイルの記述規則に加えて,次に示す記述規則に従ってください。