名前¶

Log::Common - httpdのアクセスログ形式とエラーログ形式でログを出力します

概要¶

  use Log::Common;

  $l = new Log::Common(access => "/var/log/search-hits",
                       error  => "/usr/local/log/error_log",
                       no_stderr => 1,
                       class => "debug");

  $l->error(message => "Uh-oh... :-(", fatal => 1);
  $l->access(user => "martin", message => "$query_string",
               code => 200);

説明¶

このクラスは、ApacheやNCSA WWWサーバーによって維持されている httpd共通ログファイル形式のアクセス・ログファイルと エラー・ログファイルに出力するために使うことができる2つのメソッドを 定義しています。そのログ・ファイルは書き込まれる間、複数のプロセスが 同じファイルに同時に書き込もうとすることを避けるため、ロックされます。 便宜上、両方のメソッドは、指定されるとプログラムをふっとばすために "exit"を呼び出すパラメータをサポートしています。

環境変数GATEWAY_INTERFACEが設定されていなければ、エラーメッセージは STDERRにも送られます - 望ましくなければ、この動きを上書きすることも できますが。そのため、このクラスを使っているPerlプログラムは 極普通に彼らのエンドユーザとシステム・ログファイルの両方に同時に メッセージを出力することができます。

エラー・ログファイル・エントリは共通のHTTPサーバの利用通り、前に UTCタイムスタンプが付けられて出力されます。

メソッド¶

access( [ OPTIONS ] );

error( [ OPTIONS ] );

パラメータ¶

Log::Commonオブジェクトを生成するとき:

access => アクセス･ログ･ファイル名

accessメソッドを通してログ出力するときに使われるファイル名。

error => エラー･ログ･ファイル名

errorメソッドを通してログ出力するときに使われるファイル名。

class => クラス名

エラー・ログメッセージでのデフォルトのクラス。デバッグ情報、 セキュリティ関連情報、WWWサーバからのメッセージ、メールシステムからの メッセージなどと区別するために使うことができます。このデフォルト値は 個々のerrorログ出力メソッドの呼び出しで上書きすることできます。

no_stderr => 0 or 1

もし1に設定されると、STDERRへのメッセージｓの出力を抑止します。 デフォルトは0です。これはerrorメソッドを呼び出すときに上書きする ことができます。

両方のメッセージに共通:

fatal => 終了コード

これは何か致命的なエラーが発生したことを示し、ログ・ファイルの エントリが出力された後、プログラムはcroakさせられます。 与えられた値はプログラムの終了コードとして使われます。 （訳者注:croakは標準モジュール Carpで定義されている関数。 dieと動きが似ていますが出力される情報が異なります)

message => メッセージ文字列

ログファイルに出力される実際のメッセージ。

accessメソッド専用:

count => 数値

通常は転送されたバイト数 - 与えられなければ0。

code => 応答コード

通常は転送されたバイト数 - 与えられなければ0。 (訳者注：上記のcountの説明と同じになってしまっている。 おそらくは、「通常は応答コード - 与えられなければ0。」）

host => ホスト名

呼び出し/クライアント・ホストのドメイン名あるいはIPアドレス。もし 与えられなければ、プロセス環境変数でのREMOTE_HOSTとREMOTE_ADDR (CGIによって設定されているように)が順番にチェックされます。 これらのどちらもなければ、ログ・ファイルでのこのフィールドは 0.0.0.0に設定されます。

ident => ident検索の値

通常は呼び出しホストとポートについてのIDENT(AUTH)検索の結果の値。 与えられなければ、プロセス環境でのREMOTE_IDENTの値が使われるか、 "-"です。

user => 認証されたユーザ名

通常は、例えば基本HTTP認証を使って認証されたユーザ名。与えられなければ、 代わりにプロセス環境でのREMOTE_USERの値が使われるか、"-"です。

errorメソッド専用:

class => クラス名

この呼び出しためにデフォルト設定を上書きします - 上記をご覧ください。

info => 情報文字列

追加の情報 - これはログファイルのこの行の最後に丸括弧で囲まれて 書かれます。

no_stderr => 0 or 1

この呼び出しためにデフォルト設定を上書きします - 上記をご覧ください。

ファイル・フォーマット¶

これらは共通のフィールド利用法であることに注意してください - 同じフィールドに 対して同じものをいれなけれならないということはありません。しかしこれらの ログファイルを既存のHTTPサーバー・ログファイル解析ツールを使って処理する つもりであれば、そうしたほうが簡単でしょう。

エラー・ログファイルは以下のような構造になります :-

日付

これはgmtime関数を使ってGMT(UTC)で整えられて出力され、角括弧で 囲まれています。これは常にあなたに代って生成されます。

メッセージのクラス

この後ろにはコロン文字':'がつきます。classパラメータから取得 されます。これは全体としてオブジェクトに設定されたデフォルト値を 上書きします。

付属の情報

infoから取得されます。これは丸括弧によって囲まれます。

アクセス･ログファイルは以下のような構造になります :-

クライアント・ホスト名/IPアドレス

hostパラメータから取得されます。

リモート・ユーザ名

identパラメータから取得されます。これは通常、 AUTH/IDENTプロトコル - RFC 1413, RFC 931を通して見つけられます。

リモート・ユーザ名

userパラメータから取得されます。これは通常、HTTP認証からのものです。

タイムスタンプ

localtimeを使い、GMT (UTC)オフセットがついて生成されます。これは 角括弧によって囲まれ、常にあなたに代わって自動的に生成されます。

メッセージそのもの

messageパラメータから取得されます。

応答ステータス・コード

codeパラメータから取得されます。通常は数値です。

転送されたバイト・カウント

countパラメータから取得されます。通常は数値です。

バグ¶

ありますか ? :-)

TODO¶

ログファイル・フォーマット(変数Xをログファイル・エントリでのフィールドY としてダンプ)を拡張すると便利かもしれません。

著作権(=COPYRIGHT)¶

Copyright (c) 1998 Martin Hamilton <[email protected]> and Jon Knight <[email protected]>. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

It was developed by the Department of Computer Studies at Loughborough University of Technology, as part of the ROADS project. This work was funded by the Joint Information Systems Committee (JISC) of the Higher Education Funding Councils under the UK Electronic Libraries Programme (eLib), the European Commission DESIRE project, and the TERENA development programme.

作者(=AUTHORS)¶

  Jon Knight <[email protected]>
  Martin Hamilton <[email protected]>

翻訳者¶

川合孝典([email protected])