syslog の活用と Perl からのログ書き込み

2003-08-13 で書いた、syslog の使い方について調査。

運用ツール、夜間バッチなどでエラーや作業結果をログに書くとき、
アプリケーション独自のログに書くよりも、syslog に書いた方が汎用的だし、管理もしやすい。

- 事前準備とテスト

syslog.conf を設定。
/etc/syslog.conf に、テスト用のログのファシリティと出力先をセット。

# syslog test
local6.*                                                /var/log/syslog_test.log

コマンドラインから syslog にメッセージを送ってみる。

$ logger -p local6.debug -i -t "sample" "sample log"
$ tail -f /var/log/syslog_test.log

Aug 20 15:14:20 pro sample[4826]: sample log

書けたようだ。

- perl から syslogd にメッセージを送る

ツールは シェルスクリプトや perl スクリプトで書く場合が多い。
そんな時にどうすれば楽かを調べた。perl から syslog に書くためのモジュールがあるようだ。

- perl から syslod に書くためのサンプルスクリプト

perl-lesson ML の過去ログに良さそうなものがあった。
Sys::Syslog モジュールを使う時の設定
http://www.egroups.co.jp/message/perl-lesson/722

冗長だと思われる部分を削り、テスト環境固有の情報を追加したのが以下のコード。

#!/usr/bin/perl
use Sys::Syslog; # all except setlogsock, or:
print "Syslog test\n";
openlog(__FILE__, 'cons,pid', 'local6');
syslog('debug', 'this is another test');
closelog();

これだけ。

- 環境

[hiroaki@sonic hiroaki]$ cat /etc/turbolinux-release
Turbolinux Server 6.5 (Jupiter)

[hiroaki@sonic hiroaki]$ perl -v
This is perl, version 5.005_03 built for i386-linux

- ライブラリが足りない。

上記スクリプトを動かす前に -wc のチェックをかけたところ、エラーが発生した。

$ perl -wc syslog.pl
Constant subroutine __stub_lgammal redefined at /usr/lib/perl5/5.00503/i386-linux/gnu/stubs.ph line 58.
Constant subroutine __stub_lgammal_r redefined at /usr/lib/perl5/5.00503/i386-linux/gnu/stubs.ph line 64.
Can't locate stdarg.ph in @INC (did you run h2ph?) (@INC contains: /usr/lib/perl5/5.00503/i386-linux /usr/lib/perl5/5.00503 /usr/lib/perl5/site_perl/5.005/i386-linux /usr/lib/perl5/site_perl/5.005 .) at /usr/lib/perl5/5.00503/i386-linux/sys/syslog.ph line 7.
BEGIN failed--compilation aborted at syslog.pl line 3.

- did you run h2ph?

did you run h2ph? というエラーメッセージにあるとおり、h2ph という作業が必要なようだ。h2ph はシステムにあるヘッダを perl から扱えるようにする perl スクリプト。作者は Larry Wall だ。Google で h2ph perl syslog を検索すると、qm-pop3d-pw というツールの readme.txt がヒット。そこの最後の行に記述があった。

おまけ
  perlでSys::Syslogモジュールを使うのはちょっと面倒です。
  うまく設定できていないと、-lオプションを付けると認証できなくなります。
    # cd /usr/include
    # h2ph *
    # cd /usr/include/sys
    # h2ph *
  を行って、syslog.phを作成しておいてください。
  また、Syslog.pmの一部のバージョンではうまく動かないことがありますが、
  そのような場合、connect関数内にある、my $syslog = &_PATH_LOGをmy $syslog = &_PATH_LOG()とすると動くことがあります。

なるほど、システムのインクルードファイルを変換する必要があるのだな。
ということで作業。しかし、上記作業をしても、stdarg.ph がない、というエラーが出てしまう。
Google で syslog stdarg.ph を検索したら、見事にヒット。Nomail というツールの FAQ に、stdarg.ph のことが書いてあった。

http://www.ku3g.org/negi/nomail/FAQ

Q. stdarg.ph が無いというエラーが出るんですけど

A. Linux の glibc-2.1.x では syslog.h から stdarg.h が include
  されています。stdarg.h は

  /usr/lib/gcc-lib/i586-redhat-linux/2.95.3/include/

  とか非常にわかりにくいところにあり，Perl をインストールする時
  に見落していることが多いようです。

  # cd /usr/lib/gcc-lib/i586-redhat-linux/2.95.3/include/
  # h2ph stdarg.h

  として生成してください。

これを参考にして h2ph を実行したらうまくいった。それでも、-w スイッチを付けてスクリプトを実行すると以下のような警告が表示されてしまう。まあ致命的ではないので問題はないだろう。

$ perl -wc /home/hiroaki/test/syslog.pl
Constant subroutine __stub_lgammal redefined at /usr/lib/perl5/5.00503/i386-linux/gnu/stubs.ph line 58.
Constant subroutine __stub_lgammal_r redefined at /usr/lib/perl5/5.00503/i386-linux/gnu/stubs.ph line 64.
Constant subroutine __need___va_list undefined at /usr/lib/perl5/site_perl/5.005/i386-linux/stdarg.ph line 9.
/home/hiroaki/test/syslog.pl syntax OK

- まだ書けない。

実行してみたが、全然書かれない。tail -f /var/log/syslog_test.log しているが、一行も書き込まれないのだ。Google で perl Sys::Syslog を検索すると、再び perl-lesson ML がヒット。

Re: [perl-lesson] Sys::Syslog モジュールを使う時の設 定
http://www.egroups.co.jp/message/perl-lesson/728

> Syslog.pmを覗いてみたところ、UDPでsyslogに書き込んでるみたいですが、
> 僕のRed Hat 6.2に入ってるsysklogd-1.3.31-17は、
> デフォルトではUDP経由での書き込みを受け付けません。
> ＃man syslogdでrオプションのところに書いてありました。

perldoc Sys::Syslogしてみると、

      setlogsock $sock_type (added in 5.004_02)
          Sets the socket type to be used for the next call to
          openlog() or syslog() and returns TRUE on success,
          undef on failure.

          A value of 'unix' will connect to the UNIX domain
          socket returned by the _PATH_LOG macro…

と書かれているので、「setlogsock 'unix';」とopenlogの前に書いたら
syslogdのオプションを変えなくてもうまく行きそうです。
(「use Sys::Syslog qw(:DEFAULT setlogsock);」とされてますし」

- 書けた。

setlogsock を呼ぶようにしたら書けた。最終的なコードは以下のようになった。

#!/usr/bin/perl

# use Sys::Syslog; # all except setlogsock, or:
use Sys::Syslog qw(:DEFAULT setlogsock);    # default set, plus setlogsock
print "Syslog test\n";

setlogsock 'unix';
openlog(__FILE__, 'cons,pid', 'local6');
syslog('debug', 'this is another test');
closelog();