SHOEISHA iD

※旧SEメンバーシップ会員の方は、同じ登録情報(メールアドレス&パスワード)でログインいただけます

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

特集記事

log4netでデバッグや障害解析に役立つログを出力する

.NET環境における効果的なログ出力


  • X ポスト
  • このエントリーをはてなブックマークに追加

環境設定

 log4netを使用するには、ソリューションエクスプローラの[参照設定]を右クリックして[参照の追加]から「log4net.dll」の追加を行います。そして、Visual Studioによって自動的に作成されるファイル「AssemblyInfo.cs」の最後に下記の一文を追加します。

「AssemblyInfo.cs」
[assembly: log4net.Config.DOMConfigurator(Watch=true)]

 この記述によって「App.config(今回の例では「Log4netSample.exe.config」)」がlog4netの設定ファイルとなります。もし、他のファイルを設定ファイルにしたい場合には「DOMConfigurator(ConfigFile="../../log4net.xml",Watch=true)」と記述するとそのXMLファイルを読み込むようになります。

使用方法(プログラム部)

 アプリケーションの基本的な構成は以下のようになります。

  1. (プログラム)loggerと呼ばれるログ出力用のインスタンスを取得する。
  2. (プログラム)loggerのメソッドを用いてログを出力する。
  3. (XMLファイル)出力に使用するアペンダを設定する。
  4. (XMLファイル)出力したいlogger階層とアペンダをひもづける。

 出力するメッセージはプログラムに記述し、出力に関する設定(出力先やレイアウト等)は構成ファイル「App.config」に記述します。

ログ出力用インスタンス(logger)の取得

 ログを出力するためには、loggerと呼ばれるログ出力用のインスタンスを取得する必要があります。そのため、ログ出力を行いたいクラスでは下記の1文を宣言します。

「frmLog4netSample.cs」 抜粋
private static readonly log4net.ILog logger
    = log4net.LogManager.GetLogger(System.Reflection
    .MethodBase.GetCurrentMethod().DeclaringType);

 GetLoggerメソッドの引数にはログ出力対象を判定する際に使用するloggerの階層を指定します。今回のサンプルではクラスの完全修飾クラス名を引数に設定していますが、基本的にこの書き方で問題ありません。

ログを出力するメソッド

 loggerが正しく取得できていれば、loggerのメソッドからログの出力ができます。

「frmLog4netSample.cs」 抜粋
logger.Fatal("log4netによるログ出力例~Fatal(致命的障害)");
logger.Error("log4netによるログ出力例~Error(障害)");
logger.Warn("log4netによるログ出力例~Warn(警告)");
logger.Info("log4netによるログ出力例~Info(情報)");
logger.Debug("log4netによるログ出力例~Degug(デバッグ・トレース用)");

 log4netではレベルと呼ばれる重要度に応じてログ出力メソッドが複数用意されています。Fatalが最も重い障害メッセージで、Debugが一番軽い開発用のメッセージになります。レベルの使い分け方は下表1のようになりますので覚えておいてください。

表1 ログレベル
レベル標準的な使い分け
Fatalシステム停止するような致命的な障害
Errorシステム停止はしないが、問題となる障害
Warn障害ではない注意警告
Info操作ログなどの情報
Debug開発用のデバッグメッセージ

 なお、ログレベルやメッセージを統一することで効率の良いロギングが可能になるため、チーム内にてログ出力のポリシーを共有しておくと良いでしょう。

次のページ
使用方法(設定ファイル)

この記事は参考になりましたか?

  • X ポスト
  • このエントリーをはてなブックマークに追加
特集記事連載記事一覧

もっと読む

この記事の著者

WINGSプロジェクト 青木 淳夫(アオキ アツオ)

WINGSプロジェクトについて>有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表 山田祥寛)。主にWeb開発分野の書籍/記事執筆、翻訳、講演等を幅広く手がける。2018年11月時点での登録メンバは55名で、現在も執筆メンバを募集中。興味のある方は、どしどし応募頂きたい。著書記事多数。 RSS X: @WingsPro_info(公式)、@WingsPro_info/wings(メンバーリスト) Facebook

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

山田 祥寛(ヤマダ ヨシヒロ)

静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for Visual Studio and Development Technologies。執筆コミュニティ「WINGSプロジェクト」代表。主な著書に「独習シリーズ(Java・C#・Python・PHP・Ruby・JSP&サーブレットなど)」「速習シリーズ(ASP.NET Core・Vue.js・React・TypeScript・ECMAScript、Laravelなど)」「改訂3版JavaScript本格入門」「これからはじめるReact実践入門」「はじめてのAndroidアプリ開発 Kotlin編 」他、著書多数

※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です

この記事は参考になりましたか?

この記事をシェア

  • X ポスト
  • このエントリーをはてなブックマークに追加
CodeZine(コードジン)
https://codezine.jp/article/detail/71 2007/11/14 14:33

おすすめ

アクセスランキング

アクセスランキング

イベント

CodeZine編集部では、現場で活躍するデベロッパーをスターにするためのカンファレンス「Developers Summit」や、エンジニアの生きざまをブーストするためのイベント「Developers Boost」など、さまざまなカンファレンスを企画・運営しています。

新規会員登録無料のご案内

  • ・全ての過去記事が閲覧できます
  • ・会員限定メルマガを受信できます

メールバックナンバー

アクセスランキング

アクセスランキング