【Python】loggingの使い方入門｜基本設定から実務レベルまで

import logging

# basicConfigで最低限の設定を行う
logging.basicConfig(
    level=logging.INFO,  # INFO以上を出力する
)

# ログ出力の例
logging.debug("これはDEBUGレベルなので表示されません")
logging.info("アプリケーションを開始します")
logging.warning("設定ファイルが見つかりません。デフォルト設定を使用します")
logging.error("データベース接続に失敗しました")
logging.critical("致命的なエラーが発生したため、アプリケーションを終了します")

import logging

logging.basicConfig(
    level=logging.DEBUG,  # DEBUG以上すべて出力
    format="%(asctime)s [%(levelname)s] %(name)s - %(message)s",
    datefmt="%Y-%m-%d %H:%M:%S",  # 日付の形式を指定
)

logging.debug("デバッグ情報です")
logging.info("一般的な情報ログです")
logging.warning("警告レベルのログです")

import logging
import sys

logger = logging.getLogger(__name__)
logger.setLevel(logging.DEBUG)

# コンソール出力用ハンドラを作成(標準出力を指定)
console_handler = logging.StreamHandler(stream=sys.stdout)
console_handler.setLevel(logging.INFO)  # コンソールにはINFO以上だけ表示

# フォーマッタを設定
formatter = logging.Formatter(
    "%(asctime)s [%(levelname)s] %(name)s - %(message)s"
)
console_handler.setFormatter(formatter)

# ロガーにハンドラを追加
logger.addHandler(console_handler)

logger.debug("これはコンソールには出ません(DEBUGレベル)")
logger.info("これはコンソールに出力されます(INFOレベル)")

import logging
from logging import FileHandler, Formatter

logger = logging.getLogger("simple_file_logger")
logger.setLevel(logging.DEBUG)

# ファイル出力用ハンドラを作成
file_handler = FileHandler("app.log", encoding="utf-8")
file_handler.setLevel(logging.DEBUG)

# フォーマッタを設定
formatter = Formatter(
    "%(asctime)s [%(levelname)s] %(name)s - %(message)s"
)
file_handler.setFormatter(formatter)

# ロガーにハンドラを追加
logger.addHandler(file_handler)

logger.info("ファイルにINFOログを書き込みます")
logger.error("ファイルにERRORログを書き込みます")

import logging
from logging.handlers import RotatingFileHandler

logger = logging.getLogger("rotating_logger")
logger.setLevel(logging.DEBUG)

# ローテーションするファイルハンドラを作成
rotating_handler = RotatingFileHandler(
    "rotating_app.log",
    maxBytes=1024 * 10,   # 10KBを超えたらローテーション
    backupCount=3,        # 過去3世代分を保持
    encoding="utf-8",
)
rotating_handler.setLevel(logging.INFO)

formatter = logging.Formatter(
    "%(asctime)s [%(levelname)s] %(name)s - %(message)s"
)
rotating_handler.setFormatter(formatter)

logger.addHandler(rotating_handler)

for i in range(100):
    logger.info("ローテーションテストログ %d", i)

import logging

# ルートロガー配下の名前付きロガーを作成
app_logger = logging.getLogger("myapp")
db_logger = logging.getLogger("myapp.database")
web_logger = logging.getLogger("myapp.web")

print(app_logger.name)  # myapp
print(db_logger.name)   # myapp.database
print(web_logger.name)  # myapp.web

# myapp/database.py

import logging

logger = logging.getLogger(__name__)  # logger名は "myapp.database"

def fetch_user(user_id: int):
    logger.debug("ユーザー情報を取得します: user_id=%d", user_id)
    # DBアクセス処理...
    logger.info("ユーザー情報の取得に成功しました: user_id=%d", user_id)

# myapp/web.py

import logging

logger = logging.getLogger(__name__)  # logger名は "myapp.web"

def handle_request(path: str):
    logger.info("リクエストを受信しました: path=%s", path)
    # ルーティング・処理...
    logger.warning("未認証アクセスです: path=%s", path)

import logging
from logging import StreamHandler, FileHandler, Formatter
import sys

logger = logging.getLogger("myapp")
logger.setLevel(logging.DEBUG)  # ベースはDEBUGにしておく

# コンソール(標準出力)用ハンドラ
console_handler = StreamHandler(stream=sys.stdout)
console_handler.setLevel(logging.INFO)  # INFO以上を表示
console_handler.setFormatter(Formatter(
    "%(asctime)s [%(levelname)s] %(name)s - %(message)s"
))

# ファイル用ハンドラ
file_handler = FileHandler("myapp_debug.log", encoding="utf-8")
file_handler.setLevel(logging.DEBUG)  # DEBUG以上すべてを記録
file_handler.setFormatter(Formatter(
    "%(asctime)s [%(levelname)s] %(name)s - %(filename)s:%(lineno)d - %(message)s"
))

# ロガーに両方のハンドラを追加
logger.addHandler(console_handler)
logger.addHandler(file_handler)

logger.debug("デバッグ用の詳細ログです")
logger.info("通常の情報ログです")
logger.error("エラーログです")

import logging
import os
from logging import StreamHandler, FileHandler, Formatter

ENV = os.getenv("APP_ENV", "dev")  # dev or prod など

logger = logging.getLogger("myapp")

if ENV == "dev":
    logger.setLevel(logging.DEBUG)
    handler = StreamHandler()
    handler.setLevel(logging.DEBUG)
    handler.setFormatter(Formatter(
        "%(asctime)s [%(levelname)s] %(name)s - %(message)s"
    ))
    logger.addHandler(handler)

else:  # prod想定
    logger.setLevel(logging.INFO)
    file_handler = FileHandler("myapp.log", encoding="utf-8")
    file_handler.setLevel(logging.INFO)
    file_handler.setFormatter(Formatter(
        "%(asctime)s [%(levelname)s] %(name)s - %(message)s"
    ))
    logger.addHandler(file_handler)

# logging_config.py
import logging.config

LOGGING = {
    "version": 1,
    "disable_existing_loggers": False,

    "formatters": {
        "simple": {
            "format": "%(asctime)s [%(levelname)s] %(name)s - %(message)s"
        },
        "detailed": {
            "format": "%(asctime)s [%(levelname)s] %(name)s "
                      "%(filename)s:%(lineno)d - %(message)s"
        },
    },

    "handlers": {
        "console": {
            "class": "logging.StreamHandler",
            "level": "INFO",
            "formatter": "simple",
            "stream": "ext://sys.stdout",
        },
        "file": {
            "class": "logging.handlers.RotatingFileHandler",
            "level": "DEBUG",
            "formatter": "detailed",
            "filename": "myapp.log",
            "maxBytes": 1024 * 1024,
            "backupCount": 5,
            "encoding": "utf-8",
        },
    },

    "loggers": {
        "myapp": {
            "level": "DEBUG",
            "handlers": ["console", "file"],
            "propagate": False,
        },
        "myapp.database": {
            "level": "INFO",
            "handlers": ["file"],  # DBはファイルにだけ出す例
            "propagate": False,
        },
    },

    "root": {
        "level": "WARNING",
        "handlers": ["console"],
    },
}

# main.py
import logging
import logging.config
from logging_config import LOGGING

# dictConfigで一括設定
logging.config.dictConfig(LOGGING)

logger = logging.getLogger("myapp")

logger.debug("デバッグログ")
logger.info("情報ログ")
logger.warning("警告ログ")

import logging

logging.basicConfig(
    level=logging.ERROR,
    format="%(asctime)s [%(levelname)s] %(name)s - %(message)s"
)
logger = logging.getLogger(__name__)

def divide(a: int, b: int) -> float:
    return a / b

try:
    divide(10, 0)
except Exception:
    # exception()は現在の例外情報を自動的にログに含める
    logger.exception("ゼロ除算エラーが発生しました")

import logging

logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s [%(levelname)s] %(name)s - %(message)s"
)
logger = logging.getLogger(__name__)

user_id = 123
logger.info("ユーザーID=%sの処理を開始します", user_id)

import logging

logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s [%(levelname)s] %(name)s "
           "user_id=%(user_id)s request_id=%(request_id)s - %(message)s"
)
logger = logging.getLogger(__name__)

extra = {"user_id": 123, "request_id": "req-abc-001"}

logger.info("コンテキスト付きログの例です", extra=extra)

import logging

class RequestAdapter(logging.LoggerAdapter):
    """リクエスト単位でuser_idやrequest_idを付与するアダプタ"""

    def process(self, msg, kwargs):
        # extraにuser_idやrequest_idを自動付加する
        extra = self.extra.copy()
        extra.update(kwargs.get("extra", {}))
        kwargs["extra"] = extra
        return msg, kwargs

logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s [%(levelname)s] %(name)s "
           "user_id=%(user_id)s request_id=%(request_id)s - %(message)s"
)

base_logger = logging.getLogger("myapp")
req_logger = RequestAdapter(base_logger, {
    "user_id": 123,
    "request_id": "req-abc-001",
})

req_logger.info("処理ステップ1開始")
req_logger.info("処理ステップ2完了")

import logging
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

value = 42

# 悪い例: f文字列で毎回整形される
logger.debug(f"値は {value} です")  # DEBUGは出力されないが、整形は行われる

# 良い例: プレースホルダ + 引数
logger.debug("値は %d です", value)  # DEBUGが無効なら整形も行われない

import logging
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

def heavy_to_string(obj):
    # 重い変換処理を想定
    return str(obj) * 1000

obj = {"key": "value"}

# 直接呼んでしまうと、DEBUGが無効でもheavy_to_stringは実行される
logger.debug("詳細デバッグ: %s", heavy_to_string(obj))

# 良い例: ログが有効なときだけ重い処理を実行
if logger.isEnabledFor(logging.DEBUG):
    logger.debug("詳細デバッグ: %s", heavy_to_string(obj))

import logging

logging.basicConfig(
    level=logging.INFO,
    format="%(asctime)s [%(levelname)s] %(name)s - %(message)s"
)

# requestsライブラリのログレベルを制御
requests_logger = logging.getLogger("requests")
requests_logger.setLevel(logging.WARNING)  # WARNING以上だけを出力

# SQLAlchemyのエンジンログをDEBUGに
sqlalchemy_logger = logging.getLogger("sqlalchemy.engine")
sqlalchemy_logger.setLevel(logging.DEBUG)

# settings.py (抜粋)

LOGGING = {
    "version": 1,
    "disable_existing_loggers": False,

    "formatters": {
        "simple": {
            "format": "%(asctime)s [%(levelname)s] %(name)s - %(message)s"
        },
    },

    "handlers": {
        "console": {
            "class": "logging.StreamHandler",
            "level": "INFO",
            "formatter": "simple",
        },
        "file": {
            "class": "logging.FileHandler",
            "level": "INFO",
            "formatter": "simple",
            "filename": "django_app.log",
        },
    },

    "loggers": {
        "django": {
            "handlers": ["console"],
            "level": "INFO",
            "propagate": True,
        },
        "myapp": {
            "handlers": ["console", "file"],
            "level": "DEBUG",
            "propagate": False,
        },
    },
}

from flask import Flask
import logging
from logging import StreamHandler, Formatter

app = Flask(__name__)

# Flaskのapp.loggerを取得
logger = app.logger
logger.setLevel(logging.INFO)

# コンソール出力ハンドラを追加
handler = StreamHandler()
handler.setFormatter(Formatter(
    "%(asctime)s [%(levelname)s] %(name)s - %(message)s"
))
logger.addHandler(handler)

@app.route("/")
def index():
    logger.info("インデックスページへアクセスがありました")
    return "Hello, Flask logging!"