Djangoはロギングのために、Pythonビルトインの logging モジュールを使用しています。このモジュールの使い方はPythonのドキュメントに記述されています。しかし、もしあなたがPythonのロギングフレームワークを使ったことがない場合(もしくはある場合も)、これは素早い入門になるでしょう。
Pythonのロギングは4つの部分で構成されます。
\n\nロガーはロギングシステムのエントリーポイントです。各ロガーは処理が記述されたメッセージの名前付けされたバケツです。
\nロガーには ログレベル が設定されています。このログレベルはハンドリングされたログメッセージの深刻さを表しています。Pythonは下記のログレベルを定義しています。
\nDEBUG: デバッグのための低レベルシステム情報
INFO: 一般的なシステム情報
WARNING: 重要度の小さい問題が発生したことを示す情報
ERROR: 大きな問題が発生したことを示す情報
CRITICAL: 重大な問題が発生したことを示す情報
ロガーに記載された各メッセージは ログレコード です。各ログレコードは、特定のメッセージの重要性を表す ログレベル を持ちます。ログレコードには、記録されたイベントを説明するメタデータを含むことができます。これには、スタックトレースやエラーコードと言った詳細を含めることができます。
\nロガーにメッセージが渡されたとき、メッセージのログレベルはロガーのログレベルと比較されます。メッセージのログレベルがロガー自体のログレベルと同等以上の場合、メッセージは次の処理に進みます。それ以外の場合、メッセージは無視されます。
\nロガーによってメッセージの処理が必要だと判断された場合、メッセージは ハンドラ に渡されます。
\nハンドラは、ロガー上で書くメッセージに何をするかを決定するための原動力です。ここで、メッセージを表示する、ファイルに書き込む、ネットワークソケットに送信する、といった特定のロギング動作を記述します。
\nロガーと同様に、ハンドラもログレベルを持ちます。ログレコードのログレベルがハンドラのレベルに満たない場合、ハンドラはメッセージを無視します。
\nロガーには複数のハンドラを設定でき、また各ハンドラは異なるログレベルを持つことができます。この方法により、メッセージの重要性に応じて通知方法を変えることができます。たとえば、ERROR と CRITICAL メッセージを呼び出しサービスに転送するハンドラを設定する一方で、後で分析するために (ERROR や``CRITICAL`` も含む) すべてのメッセージをファイルに記録する 2 つめのハンドラをセットすることができます。
フィルターは、どのログレコードがロガーからハンドラへ渡されるかについて、追加的なコントロールを提供します。
\nデフォルトでは、ログレベル要件を満たしたすべてのログメッセージが処理されます。しかし、フィルタを使用することで、ロギングのプロセスに追加的な要件を設定できます。たとえば、特定のソースからの ERROR のみを処理するようにフィルタを設定することができます。
フィルタは、処理前にログレコードを修正するためにも使えます。たとえば、特定の条件を満たした場合に ERROR ログレコードを WARNING レコードに格下げさせるようなフィルタを設定できます。
フィルタは、ロガーもしくはハンドラに対して設定できます; 複数のフィルタを使って複数のフィルタ動作を連鎖させることも可能です。
\n最終的には、ログレコードはテキストとして表現される必要があります。フォーマッタはこのテキストの書式を定義します。フォーマッタは、通常は Python の文字列フォーマットで、LogRecord 属性 を含みます; しかし、特定の書式設定を行うような独自のフォーマッタを記述することもできます。
\nロガー、ハンドラ、フィルタ、フォーマッタを設定し終えたら、コード内にロギングの呼び出しを設置する必要があります。ロギングのフレームワークの使用は非常にシンプルです。例をご覧ください:
\n# import the logging library\nimport logging\n\n# Get an instance of a logger\nlogger = logging.getLogger(__name__)\n\ndef my_view(request, arg1, arg):\n ...\n if bad_mojo:\n # Log an error message\n logger.error('Something went wrong!')\nそう、これだけです! bad_mojo の状態がアクティブなときは、毎回エラーログが記述されます。
logging.getLogger() を呼ぶと、（必要であればロガーを作成したうえで）ロガーのインスタンスを取得します。このロガーのインスタンスは名前によって区別されます。名前は、ロガーの設定を、目的に応じて区別するために利用します。
慣習として、logger の名前は通常 __name__ とし、logger が含まれている Python モジュールの名前となるようにします。これにより、ロギングの呼び出しをモジュールごとにフィルタ・ハンドリングできるようになります。しかし、ロギングメッセージを他の方法で組織したい場合は、ドット区切りの名前を logger に与えることもできます。
# Get an instance of a specific named logger\nlogger = logging.getLogger('project.interesting.stuff')\nロガーの名前がドットで区切られているのは、階層関係を表しています。project.interesting という名前のロガーは、project.interesting.stuff という名前のロガーの親になります。project という名前のロガーは、project.interesting の親になります。
この階層関係は重要です。ログの呼び出しは、親のロガーに伝播します。ルートのロガーにのみハンドラをセットして、子のロガーの呼び出しを全てこのハンドラでキャッチするということができます。project という名前のロガーは project.interesting や project.interesting.stuff ロガーのログも全てキャッチできます。
伝播の設定はロガーごとに設定できます。親のロガーに伝播させたくない場合は、伝播しないように設定することもできます。
\nロガーのインスタンスは、デフォルトの各ログレベルに対する入力方法を含んでいます:
\nlogger.debug()
logger.info()
logger.warning()
logger.error()
logger.critical()
さらに 2 つのロギング呼び出しが可能です:
\nlogger.log(): 手動で、特定のログレベルでロギングメッセージを吐き出します。
logger.exception(): 例外のスタックトレースをラップした、ERRORレベルのログメッセージを生成します。
もちろん、コード内にロギング呼び出しを設置するだけでは不十分です。ロガー、ハンドラ、フィルタおよびフォーマッタが、役立つ形でロギング出力をするように設定する必要があります。
\nPython のロギングライブラリは、実用的なインターフェースから設定ファイルまで、ロギング設定のテクニックを提供しています。デフォルトでは、Django は dictConfig フォーマット を使用します。
\nIn order to configure logging, you use LOGGING to define a\ndictionary of logging settings. These settings describe the loggers,\nhandlers, filters and formatters that you want in your logging setup,\nand the log levels and other properties that you want those components\nto have.
デフォルトでは、LOGGING 設定は、以下のスキームを使って Django のデフォルトロギング設定 に統合されています。
LOGGING の disable_existing_loggers キーの値を True にすると、全てのデフォルトの設定が無効になります（キーが存在しない場合は dictConfig のデフォルトになります）。このため、 'disable_existing_loggers': True を使う場合は注意してください。 True を設定する必要は殆どないでしょう。 disable_existing_loggers を False に設定して、デフォルトのロガーの一部、または全てを定義しなおすこともできます。あるいは、 LOGGING_CONFIG を None に設定して、 ロギングの設定を自分で行うこと も出来ます。
ロギングは、一般的な Django の setup() 関数の一部として設定されます。したがって、ロガーが常にプロジェクトコード内で使用準備ができていることが保証されています。
dictConfig フォーマット に関する完全なドキュメントが、ロギング設定ディクショナリの最高の教材です。とはいえ、どんなことが可能なのか知ってもらうため、以下にいくつかの例を示します。
\n最初に、全てのログメッセージをコンソールに出力するための最低限の設定がこちらです。
\nsettings.pyimport os\n\nLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'handlers': {\n 'console': {\n 'class': 'logging.StreamHandler',\n },\n },\n 'root': {\n 'handlers': ['console'],\n 'level': 'WARNING',\n },\n}\nこの設定では、 root という名前の親のロガーがあり、 WARNING レベル以上のメッセージを受け取ったら、 console ハンドラに送るようになっています。 level を INFO または DEBUG にすると、より詳細なメッセージも表示されるようになります。この設定は開発中に役に立ちます。
Next we can add more fine-grained logging. Here's an example of how to make the\nlogging system print more messages from just the django named\nlogger:
\nsettings.pyimport os\n\nLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'handlers': {\n 'console': {\n 'class': 'logging.StreamHandler',\n },\n },\n 'root': {\n 'handlers': ['console'],\n 'level': 'WARNING',\n },\n 'loggers': {\n 'django': {\n 'handlers': ['console'],\n 'level': os.getenv('DJANGO_LOG_LEVEL', 'INFO'),\n 'propagate': False,\n },\n },\n}\nBy default, this config sends messages from the django logger of level\nINFO or higher to the console. This is the same level as Django's default\nlogging config, except that the default config only displays log records when\nDEBUG=True. Django does not log many such INFO level messages. With\nthis config, however, you can also set the environment variable\nDJANGO_LOG_LEVEL=DEBUG to see all of Django's debug logging which is very\nverbose as it includes all database queries.
必ずしもコンソールに出力する必要はありません。 django という名前のロガーをファイルに書き込むにはこのように設定します。
\nsettings.pyLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'handlers': {\n 'file': {\n 'level': 'DEBUG',\n 'class': 'logging.FileHandler',\n 'filename': '/path/to/django/debug.log',\n },\n },\n 'loggers': {\n 'django': {\n 'handlers': ['file'],\n 'level': 'DEBUG',\n 'propagate': True,\n },\n },\n}\nこの例を使用するときは、'filename' のパスを Django アプリケーションを実行しているユーザーが書き込み可能な場所に変更してください。
最後に、かなり複雑なロギングの設定の例です。
\nsettings.pyLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'formatters': {\n 'verbose': {\n 'format': '{levelname} {asctime} {module} {process:d} {thread:d} {message}',\n 'style': '{',\n },\n 'simple': {\n 'format': '{levelname} {message}',\n 'style': '{',\n },\n },\n 'filters': {\n 'special': {\n '()': 'project.logging.SpecialFilter',\n 'foo': 'bar',\n },\n 'require_debug_true': {\n '()': 'django.utils.log.RequireDebugTrue',\n },\n },\n 'handlers': {\n 'console': {\n 'level': 'INFO',\n 'filters': ['require_debug_true'],\n 'class': 'logging.StreamHandler',\n 'formatter': 'simple'\n },\n 'mail_admins': {\n 'level': 'ERROR',\n 'class': 'django.utils.log.AdminEmailHandler',\n 'filters': ['special']\n }\n },\n 'loggers': {\n 'django': {\n 'handlers': ['console'],\n 'propagate': True,\n },\n 'django.request': {\n 'handlers': ['mail_admins'],\n 'level': 'ERROR',\n 'propagate': False,\n },\n 'myproject.custom': {\n 'handlers': ['console', 'mail_admins'],\n 'level': 'INFO',\n 'filters': ['special']\n }\n }\n}\nこのロギング設定は、以下のことを行います:
\n設定が「dictConfig バージョン 1」形式であることを明示します。 現在、これが唯一の dictConfig 形式のバージョンです。
2 つのフォーマッタを定義します:
\nsimple, that outputs the log level name (e.g., DEBUG) and the log\nmessage.
この format 文字列は標準の Python 文字列フォーマットで、各ログ行で出力される詳細を定義します。出力可能な詳細の全リストは Formatter Objects に記載されています。
verbose は、ログレベルの名称とログメッセージに加えて、時刻、プロセス、スレッド、ログメッセージを生成したモジュールを出力します。
2 つのフィルタを定義します:
\nproject.logging.SpecialFilter, using the alias special. If this\nfilter required additional arguments, they can be provided as additional\nkeys in the filter configuration dictionary. In this case, the argument\nfoo will be given a value of bar when instantiating\nSpecialFilter.
django.utils.log.RequireDebugTrue は、DEBUG が True のときにレコードの処理を進めます。
2 つのハンドラを定義します:
\nconsole は、すべての INFO 以上のメッセージを sys.stderr に表示 (print) する StreamHandler クラスです。このハンドラは simple 出力フォーマットを使用します。
mail_admins` は、すべての ``ERROR 以上のメッセージを ADMINS に E メール送信する AdminEmailHandler です。このハンドラは special フィルタを使用します。
3 つのロガーを設定します:
\ndjango は、すべてのメッセージを console ハンドラに渡します。
django.request は、すべての ERROR メッセージを mail_admins ハンドラに渡します。加えて、このロガーはメッセージを親に 伝えない よう設定されています。これは、django.request 内に記述されたログメッセージは django ロガーで処理されないことを意味します。
myproject.custom は INFO もしくはそれ以上のすべてのメッセージを渡し、special フィルタを 2 つのハンドラに引き渡します -- console と mail_admins です。これは、INFO 以上のレベルのメッセージがコンソールで表示され、さらに ERROR と CRITICAL のメッセージは E メールでも出力されることを意味します。
ロガーの設定に Python の dictConfig フォーマットを使用したくない場合は、あなた自身の設定スキームを定義することができます。
\nThe LOGGING_CONFIG setting defines the callable that will\nbe used to configure Django's loggers. By default, it points at\nPython's logging.config.dictConfig() function. However, if you want to\nuse a different configuration process, you can use any other callable\nthat takes a single argument. The contents of LOGGING will\nbe provided as the value of that argument when logging is configured.
ロギングを全く設定したくない（あるいは、自分でロギングをやりたい）なら、 LOGGING_CONFIG を None に設定することもできます。これにより、 Django のデフォルトのロギング設定 を無効化できます。
LOGGING_CONFIG を None に設定すると、自動でロギングの設定が行われなくなるだけです。ロギング自体が使えなくなるわけではありません。自動でのロギング設定を無効化しても、 Django はロギングのメソッドを呼び、もしログ設定がされていれば、そこに出力されます。
Django の自動でのログ設定を無効化し、手動で設定する場合はこのようにします。
\nsettings.pyLOGGING_CONFIG = None\n\nimport logging.config\nlogging.config.dictConfig(...)\nNote that the default configuration process only calls\nLOGGING_CONFIG once settings are fully-loaded. In contrast, manually\nconfiguring the logging in your settings file will load your logging config\nimmediately. As such, your logging config must appear after any settings on\nwhich it depends.
Django は、Webサーバーで特有のログに関する便利な機能を提供しています。
\nDjango provides several built-in loggers.
\ndjangoLink to this heading#django ヒエラルキーにある全てのメッセージをキャッチするロガーです。 django という名前で送られるメッセージはありませんが、以下の名前のロガーからメッセージが送られてきます。
django.requestLink to this heading#リクエストに関するログをハンドリングします。5XXレスポンスは ERROR メッセージとして送られ、 4XXレスポンスは WARNING メッセージとして送られます。 django.security ロガーに出力されたメッセージは、 django.request ロガーには送られません。
このロガーに送られるメッセージには、以下のようなコンテキストが含まれます。
\nstatus_code: リクエストに対するレスポンスのHTTPレスポンスコード。
request: ログのメッセージに対応するリクエストのオブジェクト。
django.serverLink to this heading#runserver コマンドによって立ち上がったサーバーが受け取ったリクエストに関するログメッセージ。HTTP の 5XX レスポンスは ERROR メッセージとして送られ、 4XX レスポンスは WARNING メッセージとして送られ、その他は INFO メッセージとして送られます。
このロガーに送られるメッセージには、以下のようなコンテキストが含まれます。
\nstatus_code: リクエストに対するレスポンスのHTTPレスポンスコード。
request: ログのメッセージに対応するリクエストのオブジェクト。
django.templateLink to this heading#テンプレートのレンダリングに関するログメッセージ。
\nコンテキストに変数が無い場合は DEBUG メッセージとして送られる。
django.db.backendsLink to this heading#コードとデータベースの間でのやりとりに関するメッセージ。例えば、アプリケーションから実行全ての SQL は DEBUG レベルでメッセージが送られます。
このロガーに送られるメッセージには、以下のようなコンテキストが含まれます。
\nduration: SQLを実行するのにかかった時間。
sql: 実行されたSQL文。
params: SQLの呼び出しに使ったパラメータ。
パフォーマンスの観点から、 SQL ログは、ログレベルやハンドラに関わらず、 settings.DEBUG に True が設定されているときのみ有効になります。
このログには、フレームワークによる初期化（例: SET TIMEZONE ）や、トランザクション管理のクエリ（例: BEGIN, BOMMIT, ROLLBACK）は含まれません。全てのデータベースクエリを見たい場合は、データベースのクエリログを有効にしてください。
django.security.*Link to this heading#The security loggers will receive messages on any occurrence of\nSuspiciousOperation and other security-related\nerrors. There is a sub-logger for each subtype of security error, including all\nSuspiciousOperations. The level of the log event depends on where the\nexception is handled. Most occurrences are logged as a warning, while\nany SuspiciousOperation that reaches the WSGI handler will be logged as an\nerror. For example, when an HTTP Host header is included in a request from\na client that does not match ALLOWED_HOSTS, Django will return a 400\nresponse, and an error message will be logged to the\ndjango.security.DisallowedHost logger.
These log events will reach the django logger by default, which mails error\nevents to admins when DEBUG=False. Requests resulting in a 400 response due\nto a SuspiciousOperation will not be logged to the django.request\nlogger, but only to the django.security logger.
To silence a particular type of SuspiciousOperation, you can override that\nspecific logger following this example:
'handlers': {\n 'null': {\n 'class': 'logging.NullHandler',\n },\n},\n'loggers': {\n 'django.security.DisallowedHost': {\n 'handlers': ['null'],\n 'propagate': False,\n },\n},\nOther django.security loggers not based on SuspiciousOperation are:
django.security.csrf: For CSRF failures.
django.db.backends.schemaLink to this heading#Logs the SQL queries that are executed during schema changes to the database by\nthe migrations framework. Note that it won't log the\nqueries executed by RunPython.\nMessages to this logger have params and sql in their extra context (but\nunlike django.db.backends, not duration). The values have the same meaning\nas explained in django.db.backends.
Django provides one log handler in addition to those provided by the\nPython logging module.
\nThis handler sends an email to the site ADMINS for each log\nmessage it receives.
If the log record contains a request attribute, the full details\nof the request will be included in the email. The email subject will\ninclude the phrase "internal IP" if the client's IP address is in the\nINTERNAL_IPS setting; if not, it will include "EXTERNAL IP".
If the log record contains stack trace information, that stack\ntrace will be included in the email.
\nThe include_html argument of AdminEmailHandler is used to\ncontrol whether the traceback email includes an HTML attachment\ncontaining the full content of the debug Web page that would have been\nproduced if DEBUG were True. To set this value in your\nconfiguration, include it in the handler definition for\ndjango.utils.log.AdminEmailHandler, like this:
'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'class': 'django.utils.log.AdminEmailHandler',\n 'include_html': True,\n }\n},\nNote that this HTML version of the email contains a full traceback,\nwith names and values of local variables at each level of the stack, plus\nthe values of your Django settings. This information is potentially very\nsensitive, and you may not want to send it over email. Consider using\nsomething such as Sentry to get the best of both worlds -- the\nrich information of full tracebacks plus the security of not sending the\ninformation over email. You may also explicitly designate certain\nsensitive information to be filtered out of error reports -- learn more on\nFiltering error reports.
\nBy setting the email_backend argument of AdminEmailHandler, the\nemail backend that is being used by the\nhandler can be overridden, like this:
'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'class': 'django.utils.log.AdminEmailHandler',\n 'email_backend': 'django.core.mail.backends.filebased.EmailBackend',\n }\n},\nBy default, an instance of the email backend specified in\nEMAIL_BACKEND will be used.
The reporter_class argument of AdminEmailHandler allows providing\nan django.views.debug.ExceptionReporter subclass to customize the\ntraceback text sent in the email body. You provide a string import path to\nthe class you wish to use, like this:
'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'class': 'django.utils.log.AdminEmailHandler',\n 'include_html': True,\n 'reporter_class': 'somepackage.error_reporter.CustomErrorReporter'\n }\n},\nSends emails to admin users. To customize this behavior, you can\nsubclass the AdminEmailHandler class and\noverride this method.
Django provides some log filters in addition to those provided by the Python\nlogging module.
\nThis filter accepts a callback function (which should accept a single\nargument, the record to be logged), and calls it for each record that\npasses through the filter. Handling of that record will not proceed if the\ncallback returns False.
\nFor instance, to filter out UnreadablePostError\n(raised when a user cancels an upload) from the admin emails, you would\ncreate a filter function:
from django.http import UnreadablePostError\n\ndef skip_unreadable_post(record):\n if record.exc_info:\n exc_type, exc_value = record.exc_info[:2]\n if isinstance(exc_value, UnreadablePostError):\n return False\n return True\nand then add it to your logging config:
\n'filters': {\n 'skip_unreadable_posts': {\n '()': 'django.utils.log.CallbackFilter',\n 'callback': skip_unreadable_post,\n }\n},\n'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'filters': ['skip_unreadable_posts'],\n 'class': 'django.utils.log.AdminEmailHandler'\n }\n},\nThis filter will only pass on records when settings.DEBUG is False.
\nThis filter is used as follows in the default LOGGING\nconfiguration to ensure that the AdminEmailHandler only sends\nerror emails to admins when DEBUG is False:
'filters': {\n 'require_debug_false': {\n '()': 'django.utils.log.RequireDebugFalse',\n }\n},\n'handlers': {\n 'mail_admins': {\n 'level': 'ERROR',\n 'filters': ['require_debug_false'],\n 'class': 'django.utils.log.AdminEmailHandler'\n }\n},\nThis filter is similar to RequireDebugFalse, except that records are\npassed only when DEBUG is True.
デフォルトでは、Django は以下のロギングを設定してあります:
\nDEBUG が True のとき:
django ロガーは、django ヒエラルキー (django.server を除く) において、INFO レベル以上のメッセージをコンソールに送信します。
DEBUG が False のとき:
django ロガーは、django ヒエラルキー (django.server を除く) において、ERROR ないし CRITICAL レベルを AdminEmailHandler に送信します。
DEBUG の値にかかわらず:
django.server ロガーは INFO レベル以上のメッセージをコンソールに送信します。
All loggers except django.server propagate logging to their\nparents, up to the root django logger. The console and mail_admins\nhandlers are attached to the root logger to provide the behavior described\nabove.
django/utils/log.py で定義されている、このデフォルト設定を補完または置換する方法を知りたい場合は、ロギングを設定する を参照してください。
\n