今日の開発Tips
Tips

今日の開発Tips（2025-06-22）

デバッグを効率化する上で、効果的なログ出力は不可欠です。しかし、過剰なログ出力はデバッグの妨げになることもあります。本Tipsでは、状況に応じたログ出力のレベルと内容を調整し、デバッグ効率を向上させる方法を紹介します。適切なログレベルを選択し、重要な情報のみを記録することで、デバッグ時間を短縮し、問題解決を迅速に進めることができます。

状況に応じたログレベルの選択と詳細なログメッセージ

デバッグ時には、DEBUGレベルで詳細な情報をログに出力することで、問題の原因を特定しやすくなります。一方、本番環境では、INFOレベル以上の重要な情報のみを出力することで、ログファイルの肥大化を防ぎます。 ログメッセージには、エラー発生時の状況や変数の値などを含めることで、問題解決の助けとなります。

import logging

# ロガーの設定
logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)  # DEBUGレベルを設定

# ハンドラーの設定 (ファイル出力)
fh = logging.FileHandler('debug.log')
fh.setLevel(logging.DEBUG)
formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
fh.setFormatter(formatter)
logger.addHandler(fh)

# ログ出力
try:
    # 何か処理
    result = 10 / 0
except ZeroDivisionError:
    logger.exception("ゼロ除算が発生しました。") # 例外を含む詳細なログを出力
    logger.error("処理に失敗しました。", exc_info=True) # 同様に例外を含むログを出力
else:
    logger.info(f"処理が成功しました。結果は{result}です。")

logger.debug("デバッグ情報: 変数xの値は10です。")
logger.warning("警告: リソース消費が多いです。")

注意点:

  • ログレベルの設定は、開発環境と本番環境で適切に切り替える必要があります。
  • 過剰なログ出力はパフォーマンスに影響を与える可能性があります。重要な情報のみを出力するようにしましょう。
  • 個人情報や機密情報はログに出力しないように注意してください。
  • ログファイルのローテーションを設定し、ファイルサイズを管理しましょう。

おすすめポイント:

  • loggingモジュールのexceptionメソッドは、例外発生時のスタックトレースを含めてログ出力できるので便利です。
  • ログメッセージにタイムスタンプを含めることで、問題発生のタイミングを特定しやすくなります。
  • ログレベルを使い分けることで、状況に合わせた情報を得ることができます。
Tips一覧へ戻る