ログプロパティの構成オプション

この記事には、ログプロパティファイルの構成に関する情報が含まれます。ログ設定を変更する必要がない場合は、このセクションはスキップして飛ばすことができます。

デフォルトのログオプション

ログプロパティファイルは、自動登録設定ユーティリティのログプロパティ設定を使用して指定されます。以下は、デフォルトのプロパティファイルの内容を示したものです。

# A line starting with # is a comment and ignored.
# Define with log-level (DEBUG, INFO, WARN, or ERROR) and appender name
log4cpp.rootCategory=INFO, DAILY
# Configured appender type
log4cpp.appender.DAILY=DailyRollingFileAppender
# File name and path
# AE Server requires write permission, and directory must exist
log4cpp.appender.DAILY.fileName=C:\Program Files\DigiCert\AEServer\logs\AEServer.log
# Max days to keep the old log files
log4cpp.appender.DAILY.maxDaysKeep=30
# Output pattern (see http://log4cpp.sourceforge.net/#faq for format details)
log4cpp.appender.DAILY.layout=PatternLayout
log4cpp.appender.DAILY.layout.ConversionPattern=%d{%Y-%m-%d %H:%M:%S} %-5p [%t] %m%n

表 1. ログプロパティの詳細

プロパティキー	説明
log4cpp.rootCategory	構成に使用するログレベルとログ名を指定します。値は次の形式になります。 <log_level>，<logger_name> log_levelは、ロギングのレベルを記述したものです。 DEBUG（デバッグ）、INFO（情報）、WARN（警告）、またはERROR（エラー）に設定することができます。このうち、DEBUG（デバッグ）が最も冗長となります。レベルをDEBUG（デバッグ）に設定すると、ログ出力量が大幅に増加しますので、プロダクション環境での使用には注意が必要です。 logger_name は設定名を記述したもので、他のプロパティキーでも使用されます。これには任意の値を指定できますが、デフォルトとしてデイリーが使用されます。
log4cpp.appender.<logger_name>	ログアペンダーのタイプを指定します。現在は、DailyRollingFileAppenderとSyslogAppenderが対象です。DailyRollingFileAppenderアペンダーを使用するとログファイルが毎日00:00（現地時間）にローテーションし、<log_filename>.yyyy-MM-ddという名前のログファイルが作成されます。注記ログファイルのローテーションは、00:00（現地時間）以降に新しいログエントリがある場合にのみ発生します。 SyslogAppender というアペンダーを使用すると、Autoenrollment Server は設定された syslog サーバーにログメッセージをダンプできるようになります。このアペンダーの詳細については、次の「syslog を使用してログを記録する」のセクションを参照してください。
log4cpp.appender.<logger_name>.fileName	ログファイル名とパスを指定します。デフォルトの場所は、<インストールディレクトリ>\AEServer.log になります。これは、Autoenrollment Serverがインストールされた場所によって変更されます。注記ログファイルディレクトリが存在していなければなりません。自動登録サービスには、このファイルに対する書き込み権限が必要です。
log4cpp.appender.<logger_name>.maxDaysKeep	ログファイルを保存する最大日数を指定します。最大日数を超えたログエントリは、ファイルシステムから削除されます。
log4cpp.appender.<logger_name>.layout	ログのレイアウトクラスを指定します。現在、PatternLayoutのみが対象です。
log4cpp.appender.<logger_name>.ConversionPattern	ログの出力形式を指定します。カスタムログメッセージに使用可能なフォーマット文字の詳細については、http://log4cpp.sourceforge.net/#faq を参照してください。デフォルトのログフォーマットは、`“<Date{yyyy-mm-dd}> <Time{hh:mm:ss}> <LogLevel> [<TheadID>] <LogMessage>”.`に設定されています。以下の例： `2021-09-22 04:15:28 INFO [6176] pki-ws.symauth.com:443 で承認局（CA）バックエンドを使用。`

注記

ファイルの内容を変更した場合は、自動登録サービスを再起動後に有効になります。
#で始まる行は無視されます。

syslog を使用してログを記録する

Autoenrollment Server は、自動登録設定のログプロパティ設定を使用して、syslog で出力をログに記録できます。syslog にログを記録できるようにするには、logger.properties ファイルの内容を変更するか、対象のプロパティファイルのパスを変更します。

サンプル syslog プロパティファイルは、Autoenrollment Serverのインストールディレクトリに syslogger_sample.properties という名前で存在します。以下は、サンプルの内容を示したものです。

#  # で始まる行はコメントであり、無視されます。
# ログレベル(DEBUG、INFO、WARN、ERROR)とアペンダ名を定義します。
log4cpp.rootCategory=INFO, SYSLOG
# アペンダーの種類を設定します
log4cpp.appender.SYSLOG=SyslogAppender
# リモートsyslogサーバのIPアドレス
log4cpp.appender.SYSLOG.syslogHost=192.168.1.1
# リモートsyslogサーバのポート番号
log4cpp.appender.SYSLOG.portNumber=514
# シスログファシリティ番号
log4cpp.appender.SYSLOG.facility=1
# 出力パターン（フォーマットの詳細はhttp://log4cpp.sourceforge.net/#faq を参照してください）
log4cpp.appender.SYSLOG.layout=PatternLayout
log4cpp.appender.SYSLOG.layout.ConversionPattern=[AESRV].ConversionPattern=[AESRV]:%d{%Y-%m-%d %H:%M:%S} %-5p [%t] %m%n

表 2. 各 syslog プロパティの詳細

プロパティキー	説明
log4cpp.rootCategory	logger_name をデフォルトで SYSLOG として設定します。
log4cpp.appender.<logger_name>	syslog を使用するには、値は SyslogAppender でなければなりません。
log4cpp.appender.<logger_name>.syslogHost	リモート syslog サーバーの IP アドレスを指定します。注記リモート syslog サーバーは、Autoenrollment Server がインストールされているマシンからアクセス可能でなければなりません。
log4cpp.appender.<logger_name>.portNumber	リモート syslog サーバーのポート番号を指定します。
log4cpp.appender.<logger_name>.facility	リモート syslog サーバーのファシリティ番号を指定します。デフォルト値は1（ユーザーレベルのメッセージ）です。
log4cpp.appender.<logger_name>.layout	ログのレイアウトクラスを指定します。現在、PatternLayoutのみが対象です。
log4cpp.appender.<logger_name>.ConversionPattern	デフォルトのログ形式は、「[AESRV]: <Date{yyyy-mm-dd}> <Time{hh:mm:ss}> <LogLevel> [<ThreadID>] <LogMessage>」に設定されています。Autoenrollment Server のログを他のログと区別するために、すべてのログメッセージの先頭に [AESRV]: という文字列が意図的に追加されています。以下はその例です。 [AESRV]:2021-09-22 04:15:28 INFO [6176] サービスが開始され、要求を待っています。

このセクションの内容: