summarizer/集約

summarizerコマンドは、bounceHammer 2.4.0から利用可能な、データベースのバウンス記録または生成された解析結果のログファイルの記録を集約するコマンドです。発信者アドレス(Addresser)、発信者ドメイン(Sender Domain)、宛先ドメイン(Destination)、差戻理由(Reason)、宛先分類(Host Group)、宛先所属(Provider)毎にバウンスの記録を集約します。

また、bounceHammer 2.5.0から日々のバウンス数を記録した数値を参照する機能(Daily Updates)が追加されました。 このコマンドはインストールしたディレクトリ/bin/summarizerにあります。

• コマンドの使用例
• 利用可能なオプション
• コマンド実行結果のスクリーンショットでの説明

使用例

summarizerは、mailboxparserやloggerが作った解析済みログファイルを引数にとり、それらの内容を集約します。またデータベースの記録を集約するオプション(-D, --database)を指定するとDBにあるバウンス記録を集約します。summarizerコマンドとほぼ同等の操作が管理画面(WebUI)でも可能です。

集約オプション

-A, --aggregate-all

このオプションをつけてsummarizerを起動すると、発信者アドレス(Addresser)、発信者ドメイン(Sender Domain)、宛先ドメイン(Destination)、差戻理由(Reason)、宛先分類(Host Group)、宛先所属(Provider)の全ての項目で集約した結果を表示します。

-a, --aggregate 集約する項目

引数に指定した項目で集約をします。指定できる項目は、a = 発信者アドレス(Addresser)、s = 発信者ドメイン(Sender Domain)、d = 宛先ドメイン(Destination)、w または r = 差戻理由(Reason)、h = 宛先分類(Host Group)、p = 宛先所属(Provider)です。

-D, --database

summarizerにデータベース内の記録を集約させます。データベース内の記録を集約して表示させるときは必ずこのオプションが必要です。

日々のバウンス記録数参照用オプション

-U, --dailyupdates (Ver. 2.5.0以降)

日々のバウンス記録数を参照するオプションです。summarizerコマンドを使う場合、このオプションか集約オプション(-A,-a)のいずれかを指定する必要があります。

-p, --period 開始:終了 (Ver. 2.5.0以降)

日々のバウンス記録数を日付(期間)を指定して参照するオプションです。有効な日付の形式は2009/04/29 または2009-04-29 で、例えば夏休みの間のバウンス記録数を参照するには、--period 2010/07/21:2010/08/31 のように指定します。

--totalsby 文字列 (Ver. 2.5.0以降)

日々のバウンス記録数を指定した文字が表す単位で集計して表示します。指定可能な文字はday: 日, week: 週(デフォルト), month: 月, year: 年 です。

集約とバウンス記録数参照の共通オプション

-b, --before 日数

summarizerに解析済みファイル内の記録を集約させます。設定ファイル(etc/bouncehammer.cf)のdirectory->logディレクトリで定義したディレクトリの中にあるログファイルのうち、今日以外のログファイル内の記録を集約したい場合はこの--beforeオプションで遡る日数を指定します。

--before 2 で一昨日、--before 10 で10日前のログファイル内の記録を集約します。--before 1は後述の--yesterdayと等価です。

-d, --date 日付文字列 (Ver. 2.5.0以降)

集約対象、バウンス数記録の参照を指定した日付に限定します。有効な日付の形式は2009/04/29 または2009-04-29 です。-b(--before)で遡る日数が計算しにくい場合などに有効なオプションです。

-y, --yesterday

summarizerに昨日の解析済みファイル内の記録を集約させます。設定ファイル(etc/bouncehammer.cf)のdirectory->logで定義される集積用ディレクトリにある、昨日(summarizer実行日からみて)のログファイル内の記録を集約対象とします。このオプションは--before 1と等価です。

-t, --today

summarizerに今日の解析済みファイル内の記録を集約させます。設定ファイル(etc/bouncehammer.cf)のdirectory->logで定義される集積用ディレクトリにある、今日(summarizer実行日)のログファイル内の記録を集約対象とします。このオプションは--before 0と等価です。

-s, --summary

指定項目の集約結果の下に、基本統計量(最小値・平均値・最大値・標準偏差)を表示します。

その他のオプション

-C, --conf 設定ファイル

読み込む設定ファイルを指定します。このオプションを使用しない場合、インストール先/etc/bouncehammer.cfが使用されます。複数の設定ファイルを処理毎に使い分ける場合などでは有用でしょう。

-T, --test

テストモードで動作します。通常は動作に必要な設定値をインストール先/etc/bouncehammer.cfから読出しますが、このオプションを指定するとbouncehammer.cfが無くても動作します。-C test-run.cf と等価です。

-F, --fotmat 文字

検索結果を指定したフォーマットで出力します。このオプションを指定しない場合は、アスキーテーブル形式で出力されます。利用可能なフォーマットは次の通りです。yaml: YAML形式, asciitable: アスキーテーブル形式, csv: CSV形式(Ver. 2.5.0以降)

--silent

このオプションを付けると、次の-v, --verboseオプションの有無にかかわらず冗長なメッセージおよびエラーの出力がなくなります。また、コマンドをsendmail等のデーモンが実行した場合、エラーが起きてもexit(0)=成功で終了します。--silentオプションを付けずにsendmail等MTAがコマンドを起動し、エラーが発生した場合はexit(75)=EX_TEMPFAILで終了します。

-v, --verbose

処理過程が冗長に表示されます。

--help

コマンドのヘルプが表示されます。

--version

バージョン番号が表示されます。

summarizer -a hostgroup -vvvv --database -s -p 2010/01/01:2010/12/31

下記のスクリーンショットは、データベースに保存されているバウンス記録を宛先分類(Host Group)で集約した結果と基本統計量を表示するコマンドと出力内容の説明です。

summarizer -a destination -vvvv --yesterday -s

下記のスクリーンショットは、昨日(コマンド実行日の前日)バウンスした記録を解析済みログファイルから読み出し、宛先ドメイン(Destination)で集約した結果と基本統計量を表示するコマンドと出力内容の説明です。