147
第14章
デバッグ、アクセスログ、エラー
ロ グ 、要 求 の ト レ ー ス
14.0 はじめに
ログは、アプリケーションを理解するための基礎です。NGINXな ら 、ユ ー ザ ー と ア プ
リケーションにとって意味のあるログ情 報を細かく制御できます。NGINXを使用す
ると、アクセスログをさまざまなコンテキストのさまざまなファイルと形式に分割し、
エラーログのログレベルを変更して、何が起こっているのかをより深く理解できます。
集中型サーバーにログをストリーミングする機能は、Syslogログ機能を通じて提供さ
れます。NGINXとNGINX Plusは 、リ ク エ ス ト が シ ス テ ム 内 を 移 動 す る 際 に ト レ ー ス す
ることもできます。本章では、アクセスログとエラーログ、Syslogプロトコル を介したス
トリーミング、NGINXとOpenTracingによって生成されたリクエスト識別子を使用して
リクエストをエンドツーエンドで追 跡する方法について説 明します。
14.1 アクセスログの設 定
問題
アクセスログの形式を設定して埋め込み変数をリクエストログに追 加する必要があり
ます。
解決法
アクセスロ グの 形 式 を 設 定します：
http {
log_format geoproxy
'[$time_local] $remote_addr '
'$realip_remote_addr $remote_user '
'$proxy_protocol_server_addr $proxy_protocol_server_port '
'$request_method $server_protocol '
'$scheme $server_name $uri $status '
'$request_time $body_bytes_sent '
'$geoip_city_country_code3 $geoip_region '
'"$geoip_city" $http_x_forwarded_for '
'$upstream_status $upstream_response_time '
'"$http_referer" "$http_user_agent"';
# ...
}
このログ形式の構成はgeoproxyという名前で、NGINXログ機能を実行するために埋め
込み変数を使用します。この構成は、リクエストが行われたときのサーバーの現地時間、
接続を開いたIPアドレス、およびクライアントのIPを示します。NGINXはgeoip_proxyま
たはrealip_headerの指示に従って理解します。
サーバーのlistenディレクティブ で proxy_protocolパラメータが使 用されている場
合、$proxy_protocol_server_で始まる変数は、PROXYプ ロトコル ヘッダーからサー
バーに関する情報を提供します。$remote_userは、ベーシック認証によって認証された
ユーザーのユーザー名を示し、その後、要求の方法とプロトコル、HTTPやHTTPSな
どのスキームが続きます。サーバー名一致がログに記録され、リクエストURIと返答の
ステータスコードも記 録されます。
ログに記録される統計には、ミリ秒単位の処理時間とクライアントに送信される本文
のサイズが含まれます国、地方、都市の情報も記録されます。リクエストが別のプロキ
シによって転送されているかどうかを示すために、HTTPヘッダーX-Forwarded-Forが
含まれます。upstreamモジュールは、いくつかの埋め込み変数を有効にします。これら
の 変 数はアップ ストリームサーバーから返された ステータスとアップストリームリクエ
ストが返されるまでにかかる時間を示します。最後に、クライアントが参照された場
所と、クライアントが使用しているブラウザに関する情報をログが記録されています。
log_formatディレクティブ は HTTPコ ン テ キ ス ト 内 で の み 有 効 で す 。オ プ シ ョ ン の
escape パラメータは文字 列でどのタイプのエスケープがなされたかを指定できます。
エ スケ ープ値 は default、json、noneのいずれかです。none値 は エ スケープ を 無 効 にし
ま す 。デ フ ォ ル ト の エ ス ケ ー プ で は 、文 字 “"”、“”および値が32未満または126を超える
その他の文字は、“xXX”としてエスケープされます。変数値が見つからない場合には、
ハイフン (“-”) が 記 録されます。jsonエ スケープの 場 合、JSON文字列で許可されない
すべ ての 文 字 がエ スケープ され ます：“"”や“” は“ "”、“ \”としてエ スケープ され ます。
値が32未満の文字は“
”、“
”、“ ”、“”、“f ”、“u00XX”としてエ スケープ され ます。
このログ構成は、次のようなログエントリをレンダリングします：
148 |
第14章：アクセスログを使用したデバッグとトラブルシューティング、エラーログ、要求のトレース
[25/Nov/2016:16:20:42 +0000] 10.0.1.16 192.168.0.122 Derek
GET HTTP/1.1 http www.example.com / 200 0.001 370 USA MI
"Ann Arbor" - 200 0.001 "-" "curl/7.47.0"
このログ形式を使 用するには、access_log デ ィ レ ク テ ィ ブ を 使 用 し て 、ロ グ フ ァ イ ル パ
スと形式名geoproxyをパラメー タとして 入 力します：
server {
access_log /var/log/nginx/access.log geoproxy;
# ...
}
access_logディレクティブはログファイルパスと形式名をパラメータとして取ります。
このディレクティブは多くのコンテキストで有効で、各コンテキストは異なるログバス
および/またはログ 形式を取ることが できます。buffer、flush、gzipなどのパラメータ
はログファイルにログが 記録される頻 度とファイルが圧 縮されているかどうかを構成
します。ifという名前のパラメータが存在し、条件を設定します。条件が0または空の
文字列と評価する場合には、アクセスは記録されません。
解説
NGINXのログモジュールを使用すると、さまざまなシナリオのログ形式を構成して、必
要に応じて多数のログファイルに記録できます。コンテキストごとに異なるログ形式を
構成して、さまざまなモジュールを使用するのが便 利な場合もあるでしょう。そうしたモ
ジュールの埋め込み変数を使用するほか、必要なすべての情報を提供する単一のキャッ
チオール形式を構成することもできます。そうした方法で形式の文字列を作成すれ
ば、JSONまたはXMLでログインすることもできます。これらのログは、トラフィックパ
ターン、クライアントの使用状況、クライアントが誰であるか、クライアントの所在地
を 理 解 す る の に 役 立 ち ま す 。ア ク セ ス ロ グ は 、ア ッ プ ス ト リ ー ム サ ー バ ー ま た は 特 定 の
URIに関する応答の遅れや問題を見つけるのにも役立ちます。アクセスログを使用し
て、テスト環境のトラフィックパターンを解析、再生し、実際のユーザーの操作を模倣
することもできます。アプリケーションやマーケットのトラブルシューティング、デバッ
グ、分析を行う際に、ログを活用する可能性は無限にあります。
14.2 エラーログの設定
問題
NGINXサーバーの問題をよりよく理解するために、エラーログを構成する必要があり
ます。
解決法
error_logディレクティブを使用してログパスとログレベルを定義します：
error_log /var/log/nginx/error.log warn;
14.2 エラーログの設定 | 149
error_logディレクティブにはパスが必要ですが、ログレベルはオプションで、デフォル
トはerrorで す 。こ の デ ィ レ ク テ ィ ブ は ifステートメントを除くすべてのコンテキストで有
効です。利用可能なログレベルはdebug、info、notice、warn、error、crit、alert、emerg
です。ここに記 載の順 番は 重 大 度の 低いものから高いものとなっています。debugログレ
ベルはNGINXの構成に--with-debugフラグがある場合にのみ利用可能です。
解説
エラーログは、構成ファイルが正しく機能していない場合に最初に確認するものです。
ログは、FastCGIなどのアプリケーションサーバーによって生成されたエラーを見つける
場合にも役立ちます。エラーログを使 用して、ワーカー、メモリーの割り当て、クライア
ントIP、およびサーバーまでの接続をデバッグできます。エラーログはフォーマットでき
ません。しかし、日付、レベル、メッセージという特定の形式をとります。
14.3 Syslogへの転送
問題
ログをSyslogリスナーに転送してログを一元化されたサービスに集約する必要があり
ます。
解決法
error_logおよびaccess_logディレ クティブ を 使 用してログ を Syslogリスナ ーに 送 信します：
error_log syslog:server=10.0.1.42 debug;
access_log syslog:server=10.0.1.42,tag=nginx,severity=info geoproxy;
error_logおよびaccess_logディレクティブの syslogパ ラ メ ー タ に は コ ロ ン が 続 き 、多 く の
オプションを追加できます。オプションには、接 続するIP、DNS名 、ま た は Unixソケット
を 示 す 必 須 の サ ー バ ーフラ グの ほ か 、facility、severity、tag、nohostnameなどのオプション
のフラグが含まれます。serverオプションは ポート番 号とIPアドレスまたは DNS名をと
り ま す 。し か し 、デ フ ォ ル ト は UDP 514です。facility オプションは、SyslogのRFC標準で
定義されている23のログメッセージの1つ と し て 定 義 さ れ て い る 機 能 を 指 し 、デ フ ォ ル
ト値はlocal7です。tagオプションは、メッセージに値のタグを付けます。デフォルトの
値はnginxです。severityのデフォルトはinfoで、送信されたメッセージの重大度を示し
ます。nohostnameフラグは無効にする機能で、ホスト名フィールドをSyslogメッセージ
ヘ ッ ダ ー に 追 加 し 、値 を 取 り ま せ ん 。
150 |
第14章：アクセスログを使用したデバッグとトラブルシューティング、エラーログ、要求のトレース
解説
Syslogは、ログメッセージを送信し、それらのログを単一のサーバーまたは複数の
サーバーに収 集するための標 準プロトコルです。一 元 化され たロケーションにログ
を送信すると、同一サービスの複数のインスタンスが複数のホストで実行されて
いる場 合のデバッグに役 立ちます。これは 集 約ログと呼 ばれます。ログを集 約する
と、1つの場所でログを表示できるため、サーバー間を移動して、タイムスタンプに沿っ
て複数のログファイルをつなぎ合わせる必要がありません。一般的なログ集約スタッ
クは、Elasticsearch、Logstash、Kibanaで 、頭 文 字 を 取 って ELKスタックとも呼ばれま
す。NGINXはaccess_logおよびerror_logデ ィ レ ク テ ィ ブ で 、こ れ ら の ロ グ を Syslogリ
スナーに簡単にストリーミングできるようにします。
14.4 要求トレース
問題
リクエストをエンドツーエンドで理 解するには、NGINXログをアプリケーションログ
と関 連付ける必 要があります。
解決法
request特 定 変 数 を 使 用して、こ れをア プ リケ ーション に わたして 記 録 するようにします：
log_format trace '$remote_addr - $remote_user [$time_local] '
'"$request" $status $body_bytes_sent '
'"$http_referer" "$http_user_agent" '
'"$http_x_forwarded_for" $request_id';
upstream backend {
server 10.0.0.42;
}
server {
listen 80;
# Add the header X-Request-ID to the response to the client
add_header X-Request-ID $request_id;
location / {
proxy_pass http://backend;
# Send the header X-Request-ID to the application
proxy_set_header X-Request-ID $request_id;
access_log /var/log/nginx/access_trace.log trace;
}
}
この例の構成では、traceという名前のlog_formatが 設 定 さ れ 、ロ グ で は 変 数 $request_id
が 使 用されています。$request_id変数はproxy_set_headerディレ クティブ を 使 用して
アップストリームアプリケーションにも渡されます。これにより、アップストリームリク
エストが作 成された 場 合に、ヘッダーにリクエストID が 追 加 さ れ ま す 。リ ク エ ス ト ID
は 、応 答 ヘッ ダ ー に リ ク エ ス ト IDを設 定するadd_headerデ ィ レ ク テ ィ ブ を 介 し て 、ク ラ
イアントに返されます。
14.4 要求トレース | 151
..................Content has been hidden....................
You can't read the all page of ebook, please click here login for view all page.