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 の状態がアクティブなときは、毎回エラーログが記述されます。
The call to logging.getLogger() obtains (creating, if\nnecessary) an instance of a logger. The logger instance is identified\nby a name. This name is used to identify the logger for configuration\npurposes.
慣習として、logger の名前は通常 __name__ とし、logger が含まれている Python モジュールの名前となるようにします。これにより、ロギングの呼び出しをモジュールごとにフィルタ・ハンドリングできるようになります。しかし、ロギングメッセージを他の方法で組織したい場合は、ドット区切りの名前を logger に与えることもできます。
# Get an instance of a specific named logger\nlogger = logging.getLogger('project.interesting.stuff')\nThe dotted paths of logger names define a hierarchy. The\nproject.interesting logger is considered to be a parent of the\nproject.interesting.stuff logger; the project logger\nis a parent of the project.interesting logger.
Why is the hierarchy important? Well, because loggers can be set to\npropagate their logging calls to their parents. In this way, you can\ndefine a single set of handlers at the root of a logger tree, and\ncapture all logging calls in the subtree of loggers. A logging handler\ndefined in the project namespace will catch all logging messages\nissued on the project.interesting and\nproject.interesting.stuff loggers.
This propagation can be controlled on a per-logger basis. If\nyou don't want a particular logger to propagate to its parents, you\ncan turn off this behavior.
\nロガーのインスタンスは、デフォルトの各ログレベルに対する入力方法を含んでいます:
\nlogger.debug()
logger.info()
logger.warning()
logger.error()
logger.critical()
さらに 2 つのロギング呼び出しが可能です:
\nlogger.log(): 手動で、特定のログレベルでロギングメッセージを吐き出します。
logger.exception(): Creates an ERROR level logging\nmessage wrapping the current exception stack frame.
もちろん、コード内にロギング呼び出しを設置するだけでは不十分です。ロガー、ハンドラ、フィルタおよびフォーマッタが、役立つ形でロギング出力をするように設定する必要があります。
\nPython のロギングライブラリは、実用的なインターフェースから設定ファイルまで、ロギング設定のテクニックを提供しています。デフォルトでは、Django は dictConfig フォーマット を使用します。
\nロギングを設定するために、設定値のディクショナリを定義するため、LOGGING を使います。この設定で、あなた自身のロギングを構成するロガー、ハンドラ、フィルタ、フォーマッタを定義します。また、これらの構成要素が持つべきログレベルや他の属性も定義します。
デフォルトでは、LOGGING 設定は、以下のスキームを使って Django のデフォルトロギング設定 に統合されています。
If the disable_existing_loggers key in the LOGGING dictConfig is\nset to True (which is the dictConfig default if the key is missing)\nthen all loggers from the default configuration will be disabled. Disabled\nloggers are not the same as removed; the logger will still exist, but will\nsilently discard anything logged to it, not even propagating entries to a\nparent logger. Thus you should be very careful using\n'disable_existing_loggers': True; it's probably not what you want. Instead,\nyou can set disable_existing_loggers to False and redefine some or all\nof the default loggers; or you can set LOGGING_CONFIG to None\nand handle logging config yourself.
ロギングは、一般的な Django の setup() 関数の一部として設定されます。したがって、ロガーが常にプロジェクトコード内で使用準備ができていることが保証されています。
dictConfig フォーマット に関する完全なドキュメントが、ロギング設定ディクショナリの最高の教材です。とはいえ、どんなことが可能なのか知ってもらうため、以下にいくつかの例を示します。
\n最初は、 django ロガーからローカルファイルにすべてのロギングを書き込むシンプルな設定です:
\nLOGGING = {\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 アプリケーションを実行しているユーザーが書き込み可能な場所に変更してください。
次は、Django のロギングをコンソールに表示する構成の例です。ローカル開発で有用でしょう。
\nデフォルトでは、この設定は INFO および上位のレベルのメッセージのみをコンソールに送信します (Django のデフォルトのロギング設定と同じですが、デフォルト設定は DEBUG=True のときのみ動作する点が異なります)。 Django はそんなに多くのメッセージを記録するわけではありません。この設定では、環境変数 DJANGO_LOG_LEVEL=DEBUG をセットすることで、Django のデバッグロギングのすべてを見ることもできますが、すべてのデータベースクエリを含んでいるため非常に冗長です:
import os\n\nLOGGING = {\n 'version': 1,\n 'disable_existing_loggers': False,\n 'handlers': {\n 'console': {\n 'class': 'logging.StreamHandler',\n },\n },\n 'loggers': {\n 'django': {\n 'handlers': ['console'],\n 'level': os.getenv('DJANGO_LOG_LEVEL', 'INFO'),\n },\n },\n}\n最後に、なかなか複雑なロギングセットアップの例をご覧ください:
\nLOGGING = {\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 は、ログレベルの名称 (DEBUG など) とログメッセージを出力します。
この 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.
If you don't want to configure logging at all (or you want to manually\nconfigure logging using your own approach), you can set\nLOGGING_CONFIG to None. This will disable the\nconfiguration process for Django's default logging. Here's an example that disables Django's\nlogging configuration and then manually configures logging:
LOGGING_CONFIG = None\n\nimport logging.config\nlogging.config.dictConfig(...)\nSetting LOGGING_CONFIG to None only means that the automatic\nconfiguration process is disabled, not logging itself. If you disable the\nconfiguration process, Django will still make logging calls, falling back to\nwhatever default logging behavior is defined.
Django provides a number of utilities to handle the unique\nrequirements of logging in Web server environment.
\nDjango provides several built-in loggers.
\ndjangoLink to this heading#The catch-all logger for messages in the django hierarchy. No messages are\nposted using this name but instead using one of the loggers below.
django.requestLink to this heading#Log messages related to the handling of requests. 5XX responses are\nraised as ERROR messages; 4XX responses are raised as WARNING\nmessages. Requests that are logged to the django.security logger aren't\nlogged to django.request.
Messages to this logger have the following extra context:
\nstatus_code: The HTTP response code associated with the\nrequest.
request: The request object that generated the logging\nmessage.
django.serverLink to this heading#Log messages related to the handling of requests received by the server invoked\nby the runserver command. HTTP 5XX responses are logged as ERROR\nmessages, 4XX responses are logged as WARNING messages, and everything else\nis logged as INFO.
Messages to this logger have the following extra context:
\nstatus_code: The HTTP response code associated with the request.
request: The request object that generated the logging message.
django.templateLink to this heading#Log messages related to the rendering of templates.
\nMissing context variables are logged as DEBUG messages.
django.db.backendsLink to this heading#Messages relating to the interaction of code with the database. For example,\nevery application-level SQL statement executed by a request is logged at the\nDEBUG level to this logger.
Messages to this logger have the following extra context:
\nduration: The time taken to execute the SQL statement.
sql: The SQL statement that was executed.
params: The parameters that were used in the SQL call.
For performance reasons, SQL logging is only enabled when\nsettings.DEBUG is set to True, regardless of the logging\nlevel or handlers that are installed.
This logging does not include framework-level initialization (e.g.\nSET TIMEZONE) or transaction management queries (e.g. BEGIN,\nCOMMIT, and ROLLBACK). Turn on query logging in your database if you\nwish to view all database queries.
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.
Sends 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