Nginxでカスタムアクセスとエラーログ形式を構成する方法


ある[ Nginx HTTP のサーバーは高度にカスタマイズ可能である驚異的なロギング機能を備えています。この記事では、LinuxでNginxのアクセスログとエラーログのフォーマットを独自に設定する方法を説明します。

このガイドの目的は、ログの生成方法を理解して、デバッグ、トラブルシューティング、またはWebサーバー内で展開されているもの(トレース要求など)の分析を目的としたカスタムログ形式を構成することです。

この記事は、アクセス/エラーログの設定、およびNginxで条件付きログ記録を有効にする方法について説明する3つのセクションで構成されています。

Nginxでのアクセスログの設定

[ Nginx ]の下には、サーバーへのすべてのクライアントリクエストが ngx_http_log_module モジュールを使用して、指定された形式でアクセスログに記録されます。

デフォルトのログファイルは log/access.log (通常はLinuxシステムでは/var/log/nginx/access_log )で、ロギングのデフォルト形式は通常複合またはメインです。フォーマット(これはディストリビューションごとに異なります)。

access_log ディレクティブ(http、server、location、該当する場合はコンテキストを除く)を使用してログファイルと log_format ディレクティブを設定します。ログ形式の設定にはhttp context only)が使用されます。ログ形式は、共通変数、およびログが書き込まれたときにのみ生成される変数によって記述されます。

ログフォーマットを設定するための構文は次のとおりです。

log_format format_name 'set_of_variables_to_define_format';

アクセスログを設定するための構文は次のとおりです。

access_log /path/to/log_file format_name;		#simplest form 
OR
access_log /path/to/log_file [format [buffer=size] [gzip[=level]] [flush=time] [if=condition]];

以下は CentOS 7 のデフォルトのNginx設定ファイル /etc/nginx/nginx.conf からの抜粋です。

/etc/nginx/nginx.conf

http {
	#main log format 
	log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                               '$status $body_bytes_sent "$http_referer" '
                               '"$http_user_agent" "$http_x_forwarded_for"';

	access_log /var/log/nginx/access.log;
}

このログ形式では、次のログエントリが生成されます。

127.0.0.1 - dbmanager [20/Nov/2017:18:52:17 +0000] "GET / HTTP/1.1" 401 188 "-" "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:47.0) Gecko/20100101 Firefox/47.0"

以下は、いくつかのデフォルト変数を使用してWebアプリケーションへのリクエストをトレースするために使用するもう1つの便利なロギングフォーマットです。

/etc/nginx/nginx.conf

log_format  custom '$remote_addr - $remote_user [$time_local] '
                         	     '"$request" $status $body_bytes_sent '
                      		     '"$http_referer" "$http_user_agent" '
                     		     '"$http_x_forwarded_for" $request_id '
                   		     '$geoip_country_name $geoip_country_code '
                  		     '$geoip_region_name $geoip_city ';

あなたはこのようにそれを使うことができます:

access_log  /var/log/nginx/access.log custom;

これにより、このようなログエントリが作成されます。

153.78.107.192 - - [21/Nov/2017:08:45:45 +0000] "POST /ngx_pagespeed_beacon?url=https%3A%2F%2Fwww.example.com%2Fads%2Ffresh-oranges-1509260795 HTTP/2.0" 204 0 "https://www.suasell.com/ads/fresh-oranges-1509260795" "Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:47.0) Gecko/20100101 Firefox/47.0" "-" a02b2dea9cf06344a25611c1d7ad72db Uganda UG Kampala Kampala 

同じレベルの access_log ディレクティブを使用して複数のログを指定できます。ここでは、httpコンテキストで複数のログファイルを使用しています。

/etc/nginx/nginx.conf

http{
	##default log format
	log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
                                	      '$status $body_bytes_sent "$http_referer" '
                                         '"$http_user_agent" "$http_x_forwarded_for"';
      
	##request tracing using custom format
	log_format custom '$remote_addr - $remote_user [$time_local] '
                                           '"$request" $status $body_bytes_sent '
                                           '"$http_referer" "$http_user_agent" '
                                           '"$http_x_forwarded_for" $request_id '
                                           '$geoip_country_name $geoip_country_code '
                                          '$geoip_region_name $geoip_city ';

	##this uses the default log format
	access_log /var/log/nginx/access.log;

	##this uses the our custom log format
	access_log /var/log/nginx/custom_log custom;
}

以下は、より高度なロギング設定の例です。これは、圧縮関連の変数を含むログ形式や圧縮ログファイルの作成に役立ちます。

access_log /var/log/nginx/custom_log custom buffer 32k;
access_log /path/to/log.gz compression  gzip  flush=5m;

Nginxでエラーログを設定する

Nginx に何らかの不具合が発生した場合、エラーログにそれらに関する情報が記録されます。これらの問題は、デバッグ情報注意事項警告エラー(これはデフォルトのレベルで、世界中で機能します)、 crit alert 、または emerg のいずれかです。

デフォルトのログファイルは log/error.log ですが、通常Linuxディストリビューションでは/var/log/nginx/にあります。 error_log ディレクティブはログファイルを指定するために使用され、メイン、http、メール、ストリーム、サーバー、ロケーションのコンテキストで(この順序で)使用できます。

次の点にも注意してください。

  • Configurations in the main context are always inherited by lower levels in the order above.
  • and configurations in the lower levels override the configurations inherited from the higher levels.

次の構文を使用してエラーログを設定できます。

error_log /path/to/log_file log_level;

例えば:

error_log /var/log/nginx/error_log warn; 

これはNginxにタイプ警告とより重大なログレベル crit アラート emerg のすべてのメッセージをログに記録するように指示します。メッセージ

次の例では、 crit alert emerg レベルのメッセージがログに記録されます。

error_log /var/www/example1.com/log/error_log crit;

以下の設定を考えてみてください。ここでは、エラーログを異なるレベルで定義しました(httpとserverのコンテキストで)。エラーが発生した場合、メッセージは、エラーが発生したレベルに最も近い1つのエラーログにのみ書き込まれます。

/etc/nginx/nginx.conf

http {
	log_format compression '$remote_addr - $remote_user [$time_local] '
                           '"$request" $status $body_bytes_sent '
                           '"$http_referer" "$http_user_agent" "$gzip_ratio"';
	
	error_log  /var/log/nginx/error_log  crit;

    	server {
		listen 80;
		server_name example1.com;

		#this logs errors messages for example1.com only
      		error_log  /var/log/nginx/example1.error_log  warn;
            	…...
	}

     	server {
		listen 80;
		server_name  example2.com;

		#this logs errors messages for example2.com only
        		error_log  /var/log/nginx/example1.error_log;
        		…….
    	}
}

以下の設定(同じレベル)のように複数の error_log ディレクティブを使用すると、メッセージは指定されたすべてのログに書き込まれます。

/etc/nginx/nginx.conf

server {
		listen 80;
		server_name example1.com;

      		error_log  /var/www/example1.com/log/error_log  warn;
		error_log  /var/log/nginx/example1.error_log  crit;
            	…...
	}

Nginxで条件付きロギングを設定する

場合によっては、Nginxにメッセージの条件付きロギングを実行させたいことがあります。すべてのメッセージがNginxによって記録される必要があるわけではないので、特定のインスタンスについて、アクセスログからの重要でないまたは重要性の低いログエントリを無視することができます。

値が他の変数の値に依存する変数を作成する ngx_http_map_module モジュールを使用できます。マップブロック内のパラメータ(httpコンテンツにのみ存在する必要があります)は、ソース値と結果値の間のマッピングを指定します。

この種の設定では、条件が“ 0” または空の文字列と評価された場合、リクエストは記録されません。この例では、HTTPステータスコードが 2xx 3xx のリクエストを除外しています。

/etc/nginx/nginx.conf

http{
	map $status $condition {
		~^[23] 0;
    		default 1;
	}
	server{
		access_log  /path/to/access.log  custom if=$condition;
	}
}

開発段階でWebアプリケーションをデバッグするためのもう1つの便利な例を示します。これはすべてのメッセージを無視し、デバッグ情報だけを記録します。

/etc/nginx/nginx.conf

 
http{
	map $info  $debuggable { 
    		default     0; 
    		debug       1; 
	} 
	server{
		……..
		access_log /var/log/nginx/testapp_debug_access_log  debug if=$debuggable; 
		#logs other requests 
		access_log  /var/log/nginx/testapp_access.log  main; 
		…….
	}
}

syslogへのログ記録など、より多くの情報をここで見つけることができます。

それは今のところすべてです!このガイドでは、Nginxでアクセスログとエラーログのカスタムログフォーマットを設定する方法を説明しました。下記のフィードバックフォームを使用して質問をしたり、この記事についてのあなたの考えを共有してください。