読み込み中...

5つのステップでマスター! Rubyにおけるログ出力の詳細ガイド

Rubyのログ出力を学ぶ人がコードを書いているイメージ Ruby
2023.06.19
この記事は約12分で読めます。

【サイト内のコードはご自由に個人利用・商用利用いただけます】

この記事では、プログラムの基礎知識を前提に話を進めています。

説明のためのコードや、サンプルコードもありますので、もちろん初心者でも理解できるように表現してあります。

本記事のサンプルコードを活用して機能追加、目的を達成できるように作ってありますので、是非ご活用ください。

※この記事は、一般的にプロフェッショナルの指標とされる『実務経験10,000時間以上』を満たす現役のプログラマチームによって監修されています。

※Japanシーモアは、常に解説内容のわかりやすさや記事の品質に注力しております。不具合、分かりにくい説明や不適切な表現、動かないコードなど気になることがございましたら、記事の品質向上の為にお問い合わせフォームにてご共有いただけますと幸いです。
(送信された情報は、プライバシーポリシーのもと、厳正に取扱い、処分させていただきます。)

はじめに

この記事を読めば、プログラミング言語Rubyにおけるログ出力の基本から詳細な使い方までを学ぶことができるようになります。

Rubyを使った開発を進めていく中で、ログ出力は重要な知識となります。

それはなぜかと言うと、ログ出力を通じてアプリケーションの動作状況を詳細に把握し、エラーや不具合の原因を特定することが可能となるからです。

●Rubyとログ出力とは

Rubyは高い生産性と優れた可読性を備えたスクリプト言語です。

一方、ログ出力とは、プログラムがどのような処理を行ったのかを時間や内容とともに記録し、後からそれを確認できるようにすることを指します。

Rubyにはログ出力を簡単に行うための標準ライブラリ「Logger」が提供されています。

●ログ出力の基本

○Rubyの標準ライブラリ「Logger」

Rubyの標準ライブラリの一つである「Logger」を使うと、ログ出力を手軽に行うことができます。

次のようにrequireメソッドで読み込むだけで利用可能です。

require 'logger'

○「Logger」の基本的な使用方法

Loggerクラスを使ってログ出力を行う基本的な手順は次の通りです。

  1. Loggerクラスのインスタンスを作成
  2. Loggerクラスのメソッドを使ってログを出力

下記のコードは、上記の手順に基づいたサンプルコードです。

○サンプルコード1：基本的なログ出力

require 'logger'

# Loggerクラスのインスタンスを作成
logger = Logger.new(STDOUT)

# ログを出力
logger.info("情報ログ")
logger.warn("警告ログ")
logger.error("エラーログ")

このコードではLoggerクラスのインスタンスを作成しています。

Logger.newの引数にSTDOUTを指定することで、ログの出力先を標準出力に設定しています。

また、infoメソッド、warnメソッド、errorメソッドを使って、それぞれ情報ログ、警告ログ、エラーログを出力しています。

これらのログはそれぞれ異なる重要度を持っており、アプリケーションの状態に応じて適切に使い分けることが求められます。

このコードを実行すると、次のような出力結果となります。

I, [YYYY-MM-DD HH:MM:SS #XXXXX]  INFO -- : 情報ログ
W, [YYYY-MM-DD HH:MM:SS #XXXXX]  WARN -- : 警告ログ
E, [YYYY-MM-DD HH:MM:SS #XXXXX] ERROR -- : エラーログ

出力されるログは、ログレベル（INFO、WARN、ERROR）、タイムスタンプ、プロセスID、メッセージから構成されます。

これにより、いつ何が起きたのかを詳細に把握することができます。

●ログ出力の詳細な使い方

○ログレベルについて

ログレベルとは、ログの重要度を示すもので、RubyのLoggerクラスでは以下の5つのログレベルが定義されています。

  • DEBUG：デバッグ情報。最も低いログレベルです。
  • INFO：通常動作の情報。
  • WARN：警告。何か問題が発生するかもしれない状況。
  • ERROR：エラー。何か問題が発生した状況。
  • FATAL：致命的なエラー。プログラムが動作を続けられない状況。

これらのログレベルは、Loggerクラスのメソッド（debug、info、warn、error、fatal）として提供されており、これらを使うことでログレベルごとのログ出力が可能となります。

また、ログレベルを設定することで、そのレベル以上のログだけを出力するように制御することも可能です。ログレベルはLoggerクラスのlevel属性を使って設定できます。

これにより、必要な情報だけを抽出して見ることが可能となります。

○サンプルコード2：ログレベルを設定する

require 'logger'

logger = Logger.new(STDOUT)

# ログレベルをWARNに設定
logger.level = Logger::WARN

logger.debug("デバッグ情報") # 出力されない
logger.info("情報") # 出力されない
logger.warn("警告") # これからは出力される
logger.error("エラー") 
logger.fatal("致命的なエラー")

このコードでは、ログレベルをWARNに設定しています。

これにより、WARN、ERROR、FATALのログレベルのメッセージだけが出力され、DEBUG、INFOのログレベルのメッセージは出力されません。

出力を制限することで、重要な情報に集中しやすくなるのがログレベルの利点です。

コードを実行すると、次のような結果が得られます。

W, [YYYY-MM-DD HH:MM:SS #XXXXX]  WARN -- : 警告
E, [YYYY-MM-DD HH:MM:SS #XXXXX] ERROR -- : エラー
F, [YYYY-MM-DD HH:MM:SS #XXXXX] FATAL -- : 致命的なエラー

○サンプルコード3：例外情報をログに記録する

エラーが発生したとき、その原因を特定するためにはエラーメッセージだけでなく、エラーが発生した場所や状況も把握することが重要です。

RubyのLoggerクラスは、例外情報をログに記録する機能も提供しています。

require 'logger'

logger = Logger.new(STDOUT)

begin
  # エラーを発生させる
  1 / 0
rescue => e
  logger.error("エラーが発生しました: #{e.class} #{e.message}")
  logger.error("バックトレース: #{e.backtrace.join(" ")}")
end

このコードでは、0で除算してエラーを発生させ、rescue節で例外を捕捉しています。

捕捉した例外のクラス名、メッセージ、バックトレースをログに記録しています。

このコードを実行すると、次のような結果が得られます。

E, [YYYY-MM-DD HH:MM:SS #XXXXX] ERROR -- : エラーが発生しました: ZeroDivisionError divided by 0
E, [YYYY-MM-DD HH:MM:SS #XXXXX] ERROR -- : バックトレース: (irb):3:in `/'

これにより、エラーが発生した場所や状況を把握し、原因の特定や再発防止に役立てることができます。

●ログ出力の応用例

RubyのLoggerクラスを使って、条件に応じたログ出力や、外部ファイルへのログ出力といった応用的な使い方も可能です。

○サンプルコード4：条件に応じたログ出力

require 'logger'

logger = Logger.new(STDOUT)

data = [1, 2, "三", 4, "五"]

data.each do |item|
  if item.is_a?(Numeric)
    logger.info("#{item}は数値です")
  else
    logger.error("#{item}は数値ではありません")
  end
end

このコードでは、配列の各要素が数値かどうかを判断し、数値であればINFOレベルで、数値でなければERRORレベルでログを出力しています。

このように、条件に応じたログ出力を行うことで、問題が発生した場所を特定しやすくなります。

このコードを実行すると、次のような結果が得られます。

I, [YYYY-MM-DD HH:MM:SS #XXXXX]  INFO -- : 1は数値です
I, [YYYY-MM-DD HH:MM:SS #XXXXX]  INFO -- : 2は数値です
E, [YYYY-MM-DD HH:MM:SS #XXXXX] ERROR -- : 三は数値ではありません
I, [YYYY-MM-DD HH:MM:SS #XXXXX]  INFO -- : 4は数値です
E, [YYYY-MM-DD HH:MM:SS #XXXXX] ERROR -- : 五は数値ではありません

○サンプルコード5：外部ファイルへのログ出力

ログは通常、標準出力や標準エラー出力に出力されますが、ログを外部ファイルに出力することも可能です。

ファイルにログを出力すると、後からログを確認したり、ログの解析を行うことが容易になります。

require 'logger'

logger = Logger.new('logfile.log')

logger.info("情報")
logger.warn("警告")
logger.error("エラー")

このコードでは、’logfile.log’という名前のファイルにログを出力しています。

logger.info、logger.warn、logger.errorといったメソッドで出力したログは、指定したファイルに記録されます。

このコードを実行した後、’logfile.log’を開いて確認すると、次のような結果が得られます。

I, [YYYY-MM-DD HH:MM:SS #XXXXX]  INFO -- : 情報
W, [YYYY-MM-DD HH:MM:SS #XXXXX]  WARN -- : 警告
E, [YYYY-MM-DD HH:MM:SS #XXXXX] ERROR -- : エラー

●ログ出力の注意点と対処法

ログ出力は非常に便利な機能ですが、適切に扱わないと意図しない結果を招く可能性があります。

ここでは、そのような注意点と、それに対する対処法をいくつか紹介します。

まず、ログ出力量が多すぎると、その分のディスク容量を消費します。

また、ログが膨大になると、特定の情報を見つけるのが困難になります。

これに対する対処法として、適切なログレベルを設定し、重要な情報のみをログとして出力することが挙げられます。

次に、ログに敏感な情報が記録されてしまう問題があります。

パスワードやAPIキーなどの情報がログに含まれてしまうと、そのログが漏洩した場合に情報漏洩のリスクが生じます。

この問題を避けるためには、敏感な情報はログ出力時にマスキングする、あるいはログ出力を避ける必要があります。

また、ログのタイムスタンプは、そのログがいつ出力されたのかを示す重要な情報です。

しかし、システムの時刻設定が誤っていると、ログのタイムスタンプも誤った時間を示すことになります。

時刻設定の誤りは、NTP（Network Time Protocol）などを使用してシステムの時刻を正確に同期することで防げます。

●ログ出力のカスタマイズ方法

RubyのLoggerクラスは、ログ出力のフォーマットをカスタマイズする機能を提供しています。

これを利用することで、ログ出力の見やすさや理解しやすさを向上させることが可能です。

○フォーマットのカスタマイズ

ログのフォーマットは、Loggerクラスのformatterメソッドを使ってカスタマイズできます。

formatterメソッドには、ログのフォーマットを定義したProcオブジェクトを渡します。

ログのフォーマットをカスタマイズするサンプルコードを紹介します。

require 'logger'

logger = Logger.new(STDOUT)

logger.formatter = proc do |severity, datetime, progname, msg|
  "#{datetime}: [#{severity}] #{msg}\n"
end

logger.info("情報")
logger.warn("警告")
logger.error("エラー")

このコードでは、ログのフォーマットを"#{datetime}: [#{severity}] #{msg}\n"と定義しています。これ

により、ログの出力は次のような形式で出力されます。

2023-06-19 10:30:00 +0900: [INFO] 情報
2023-06-19 10:30:00 +0900: [WARN] 警告
2023-06-19 10:30:00 +0900: [ERROR] エラー

ここでは、日時（datetime）、ログレベル（severity）、メッセージ（msg）をそれぞれ[]で囲んで表示しています。

このように、ログのフォーマットをカスタマイズすることで、ログの見やすさや理解しやすさを向上させることができます。

○サンプルコード6：カスタムフォーマットのログ出力

次に、ログのフォーマットをカスタマイズした例を紹介します。

このコードでは、ログメッセージの前に「ログ出力: 」を付け、ログレベルと日時を角括弧で囲むカスタムフォーマットを作成しています。

require 'logger'

logger = Logger.new(STDOUT)

logger.formatter = proc do |severity, datetime, progname, msg|
  "ログ出力: [#{datetime}][#{severity}] #{msg}\n"
end

logger.info("情報")
logger.warn("警告")
logger.error("エラー")

このコードを実行すると、次のようなログが出力されます。

ログ出力: [2023-06-19 10:30:00 +0900][INFO] 情報
ログ出力: [2023-06-19 10:30:00 +0900][WARN] 警告
ログ出力: [2023-06-19 10:30:00 +0900][ERROR] エラー

ここでは、日時とログレベルを角括弧で囲んで表示し、その前に「ログ出力: 」を付けることで、どの部分がログ出力であるかを明示しています。

このように、ログのフォーマットを自由にカスタマイズすることで、より読みやすく理解しやすいログ出力を実現できます。

まとめ

今回はRubyにおけるログ出力の詳細ガイドについて学びました。

ログ出力はシステムの動作を理解し、問題を診断するための重要な手段です。

しかし、適切に扱わないと、ディスク容量の浪費、重要な情報の見落とし、敏感な情報の漏洩といった問題を引き起こす可能性があります。

それを防ぐためには、ログの量を適切に制御し、重要な情報だけを出力するようにすること、敏感な情報をログに含めないようにすること、システムの時刻設定を正確に行うことが重要です。

また、RubyのLoggerクラスでは、ログ出力のフォーマットを自由にカスタマイズすることが可能です。

ログのフォーマットを自分の見やすい形にカスタマイズすることで、ログの可読性を向上させ、問題解析をより効率的に行うことができます。

この記事を通じて、あなたのRubyにおけるログ出力のスキルが一段階上がったことを願っています。