アプリケーションログについて

HULFT-WebFileTransferのアプリケーションログには以下の種類があります。

  • システムメッセージ(webft.log)

  • ファイル転送履歴(webft_transfer.log)

  • フォルダイベント履歴(webft_folderevent.log)

上記のログはログ出力設定ファイル(log4j2.xml)の設定に基づいて出力されます。設定を変更するには、XMLエディタ等でログ出力設定ファイル(log4j2.xml)を編集してください。

ログ出力設定ファイル(log4j2.xml)は以下のフォルダに格納されています。

Apache Tomcatを使用する場合

Windows

:

Tomcatインストールフォルダ\webapps\webft\WEB-INF\classes

Linux

:

Tomcatインストールディレクトリ/webapps/webft/WEB-INF/classes

IBM WebSphere Application Serverを使用する場合

Windows

:

WebSphereインストールフォルダ\サーバ名\profiles\プロファイル名\デプロイ先\webft.ear\webft.war\WEB-INF\classes

Linux

:

WebSphereインストールディレクトリ/サーバ名/profiles/プロファイル名/installedApps/セル名/webft.ear/webft.war/WEB-INF/classes

= 備考 =

ファイルコピーによるインストールの場合、Tomcatがインストールされているフォルダはコピー先のTURNKEY\tomcat\です。

注意
  • HULFT-WebFileTransferのコンテキスト名を変更している場合はログ出力設定ファイル(log4j2.xml)の格納場所が変わります。詳細は「ディレクトリ構成」を参照してください。

  • ログ出力設定ファイル(log4j2.xml)を編集する際は、事前にアプリケーションサーバを停止し、編集後に再起動してください。

ログ出力設定ファイル(log4j2.xml)についての詳細は、以下のWebサイトを参照してください。

URL: https://logging.apache.org/log4j/2.x/

(1) 出力の有効化

ファイル転送履歴とフォルダイベント履歴は、初期状態ではアプリケーションログに出力しない設定になっています。

= 備考 =

DBの履歴ファイルには、常にファイル転送履歴とフォルダイベント履歴が出力されます。

ファイル転送履歴の場合

ファイル転送履歴を出力する場合は、以下の下線部分を修正および削除してください。

<修正前>

...
  <!-- Webft File Transfer Log -->
  <!-- FileSize -->
  <!--
  <RollingFile name="WEBFT_TRANSFER_LOG" fileName="${sys:catalina.base:-}/logs/webft_transfer.log"
   filePattern="${sys:catalina.base:-}/logs/webft_transfer.log.%i">
      <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:SESSIONID[%X{SESSIONID}] [%t] %-5p %c - %m (%F:%L)%n" charset="UTF-8"/>
      <Policies>
          <SizeBasedTriggeringPolicy size="10MB" />
      </Policies>
      <DefaultRolloverStrategy fileIndex="max" min="1" max="10" />
  </RollingFile>
  -->
  <!-- Daily -->
...

...
  <Logger name="jp.co.saison.sis.hulft.webft.commons.log.TransferAppLog" level="info" additivity="false">
    <AppenderRef ref="EMPTY" /> 
    <!-- <AppenderRef ref="WEBFT_TRANSFER_LOG" /> --> 
...

<修正後>

...
  <!-- Webft File Transfer Log -->
  <!-- FileSize -->
  <RollingFile name="WEBFT_TRANSFER_LOG" fileName="${sys:catalina.base:-}/logs/webft_transfer.log"
   filePattern="${sys:catalina.base:-}/logs/webft_transfer.log.%i">
      <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:SESSIONID[%X{SESSIONID}] [%t] %-5p %c - %m (%F:%L)%n" charset="UTF-8"/>
      <Policies>
          <SizeBasedTriggeringPolicy size="10MB" />
      </Policies>
      <DefaultRolloverStrategy fileIndex="max" min="1" max="10" />
  </RollingFile>
  <!-- Daily -->
...

...
  <Logger name="jp.co.saison.sis.hulft.webft.commons.log.TransferAppLog" level="info" additivity="false">
    <!-- <AppenderRef ref="EMPTY" /> --> 
    <AppenderRef ref="WEBFT_TRANSFER_LOG" /> 
...

フォルダイベント履歴の場合

フォルダイベント履歴を出力する場合は、以下の下線部分を修正および削除してください。

<修正前>

...
  <!-- Webft Folder Event Log -->
  <!-- FileSize -->
  <!--
  <RollingFile name="WEBFT_FOLDEREVENT_LOG" fileName="${sys:catalina.base:-}/logs/webft_folderevent.log"
   filePattern="${sys:catalina.base:-}/logs/webft_folderevent.log.%i">
      <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:SESSIONID[%X{SESSIONID}] [%t] %-5p %c - %m (%F:%L)%n" charset="UTF-8"/>
      <Policies>
          <SizeBasedTriggeringPolicy size="10MB" />
      </Policies>
      <DefaultRolloverStrategy fileIndex="max" min="1" max="10" />
  </RollingFile>
  -->
  <!-- Daily -->
...

...
  <Logger name="jp.co.saison.sis.hulft.webft.commons.log.FolderEventAppLog" level="info" additivity="false">
    <AppenderRef ref="EMPTY" /> 
    <!-- <AppenderRef ref="WEBFT_FOLDEREVENT_LOG" /> --> 
...

<修正後>

...
  <!-- Webft Folder Event Log -->
  <!-- FileSize -->
  <RollingFile name="WEBFT_FOLDEREVENT_LOG" fileName="${sys:catalina.base:-}/logs/webft_folderevent.log"
   filePattern="${sys:catalina.base:-}/logs/webft_folderevent.log.%i">
      <PatternLayout pattern="%d{yyyy-MM-dd HH:mm:ss,SSS}:SESSIONID[%X{SESSIONID}] [%t] %-5p %c - %m (%F:%L)%n" charset="UTF-8"/>
      <Policies>
          <SizeBasedTriggeringPolicy size="10MB" />
      </Policies>
      <DefaultRolloverStrategy fileIndex="max" min="1" max="10" />
  </RollingFile>
  <!-- Daily -->
...

...
  <Logger name="jp.co.saison.sis.hulft.webft.commons.log.FolderEventAppLog" level="info" additivity="false">
    <!-- <AppenderRef ref="EMPTY" /> --> 
    <AppenderRef ref="WEBFT_FOLDEREVENT_LOG" /> 
...

(2) 出力レベルの変更

アプリケーションログの出力レベルを変更する場合の修正個所は、以下のLoggerの下線部分(level="info")です。この行の“info”を“warn”に変更すると、infoレベルのログ出力を抑制できます。

システムメッセージの場合

...
  <Logger name="org.hibernate.persister.entity.AbstractEntityPersister" level="info">
    <AppenderRef ref="WEBFT_SYSTEM_LOG" />
  </Logger>
...
  <Logger name="jp.co.saison" level="info">
    <!-- <AppenderRef ref="STDOUT" /> -->
    <AppenderRef ref="WEBFT_SYSTEM_LOG" />
    <AppenderRef ref="WEBFT_SYSTEM_WARN_LOG" />
  </Logger>
...

ファイル転送履歴の場合

...
  <Logger name="jp.co.saison.sis.hulft.webft.commons.log.TransferAppLog" level="info" additivity="false">
    <!-- <AppenderRef ref="EMPTY" /> -->
    <AppenderRef ref="WEBFT_TRANSFER_LOG" />
...

フォルダイベント履歴の場合

...
  <Logger name="jp.co.saison.sis.hulft.webft.commons.log.FolderEventAppLog" level="info" additivity="false">
    <!-- <AppenderRef ref="EMPTY" /> -->
    <AppenderRef ref="WEBFT_FOLDEREVENT_LOG" />
...

(3) 出力ファイルの変更

HULFT-WebFileTransferを複数起動し、各HULFT-WebFileTransferのアプリケーションログを個別のファイルに出力する場合や、任意のディレクトリにアプリケーションログを出力する場合には、ファイル名を変更する必要があります。

修正個所は、以下のRollingFileの下線部分(fileName="File"とfilePattern="File")です。この値を変更するとアプリケーションログのファイル名を変更できます。

システムメッセージの場合

...
  <RollingFile name="WEBFT_SYSTEM_LOG" fileName="${sys:catalina.base:-}/logs/webft.log" 
    filePattern="${sys:catalina.base:-}/logs/webft.log.%i">
...

ファイル転送履歴の場合

...
  <RollingFile name="WEBFT_TRANSFER_LOG" fileName="${sys:catalina.base:-}/logs/webft_transfer.log" 
    filePattern="${sys:catalina.base:-}/logs/webft_transfer.log.%i">
...

フォルダイベント履歴の場合

...
  <RollingFile name="WEBFT_FOLDEREVENT_LOG" fileName="${sys:catalina.base:-}/logs/webft_folderevent.log" 
    filePattern="${sys:catalina.base:-}/logs/webft_folderevent.log.%i">
...

= 備考 =

デフォルトの出力先は“${catalina.base}/logs/”です。

  • Apache Tomcatを使用する場合

    出力先は、Tomcatが使用する環境変数CATALINA_BASEに指定されたディレクトリの下の“logs/”になります。

  • IBM WebSphere Application Serverを使用する場合

    出力先は、JavaVM起動オプションの${catalina.base}が設定されないため、WebSphereのインストール先の“/logs/”になります。デフォルトのまま使用すると権限の設定によっては出力に失敗しますので、適切な出力先に変更してください。

(4) アプリケーションログの出力内容

アプリケーションログは、1行に1レコードずつ出力されます。レコードの最初の部分はログの種類によらず共通で、以下の項目が出力されます。

表4.2 アプリケーションログの共通項目

項目

説明

YYYY-MM-DD HH:MM:SS,sss

ログを出力した日時

YYYY-MM-DD HH:MM:SS,sss形式(ミリ秒まで)

SESSIONID=sessionId

ログを出力した処理のセッションID

[http-8080-1]

ログを出力した処理のスレッドID

ERROR

メッセージレベル

INFO

: 正常終了

WARN

: 警告(システムメッセージのみ)

ERROR

: 異常終了

FATAL

: 異常終了(システムメッセージのみ)

className -

ログを出力したクラスのクラス名

共通部分の後は、アプリケーションログの種類によって内容が異なります。

システムメッセージ

HULFT-WebFileTransferの動作に伴う各種メッセージが出力されます。

ファイル転送履歴

以下の項目が半角スペースで区切られて1行に出力されます。

表4.3 ファイル転送履歴の項目

項目

説明

FILE_TRANSFER_LOG

ファイル転送履歴であることを示す文字列

PATH=パス情報

ファイル転送の対象となるファイルが格納されているHULFT-WebFileTransfer上のフォルダのパス情報

FILE_NAME=ファイル名

ファイル転送の対象となるファイルのHULFT-WebFileTransfer上のファイル名

LOAD_TYPE=種別

ファイル転送の種別

UPLOAD

:

アップロード

DOWNLOAD

:

ダウンロード

START_DATE=開始日 開始時刻

ファイル転送の開始日時

YYYYMMDDHHMMSSsss形式(ミリ秒まで)

END_DATE=終了日 終了時刻

ファイル転送の終了日時

YYYYMMDDHHMMSSsss形式(ミリ秒まで)

RETURN_CODE=完了コード

ファイル転送の完了コード

FILE_SIZE=サイズ

転送されたファイルのサイズ(バイト単位)

OPERATION_ID=処理識別子

ファイル転送の処理識別子

PARENT_OBJECT_ID=親オブジェクトID

ファイル転送の対象となるファイルが格納されているHULFT-WebFileTransfer上のフォルダのオブジェクトID

OBJECT_ID=オブジェクトID

ファイル転送の対象となるファイルのHULFT-WebFileTransfer上のオブジェクトID

. (ソースファイル名:行番号)

ファイル転送履歴を出力したソース上の位置を特定するためのファイル名と行番号

フォルダイベント履歴

以下の項目が半角スペースで区切られて1行に出力されます。

表4.4 フォルダイベント履歴の項目

項目

説明

FOLDER_EVENT_LOG

フォルダイベント履歴であることを示す文字列

PATH=フォルダ名

フォルダイベントの登録先フォルダ

FOLDER_EVENT_ID=フォルダイベントID

フォルダイベントID

LOAD_TYPE=転送種別

実行対象のアクションの転送種別

UPLOAD

:

アップロード

DOWNLOAD

:

ダウンロード

SCHEDULE

:

スケジュール

START_DATE=開始日 開始時刻

フォルダイベントの開始日時

YYYYMMDDHHMMSSsss形式(ミリ秒まで)

END_DATE=終了日 終了時刻

フォルダイベントの終了日時

YYYYMMDDHHMMSSsss形式(ミリ秒まで)

STATUS=ステータス

ファイルイベントのステータス

HULFT_INTERFACE=HULFT連携有無

HULFT連携を実行したかどうか

ture

: HULFT連携あり

false

: HULFT連携なし

HULFT_PREREQUISITE=HULFT連携前提イベント

HULFT連携の前提イベント

0

: なし

1

: メール連携

3

: アプリ連携

4

: フォルダ移動

HULFT_FILE_ID=ファイルID

HULFT連携で使用したファイルID

HULFT_RETURN_CODE=完了コード

HULFT連携の完了コード

HULFT_DETAIL_CODE=詳細コード

HULFT連携の詳細コード

APP_INTERFACE=アプリ連携有無

アプリ連携を実行したかどうか

ture

: アプリ連携あり

false

: アプリ連携なし

APP_PREREQUISITE=アプリ連携前提イベント

アプリ連携の前提イベント

0

: なし

1

: メール連携

2

: HULFT 連携

4

: フォルダ移動

APP_CMD1_RETURN_CODE=完了コード

アプリ連携のコマンド1の完了コード

APP_CMD1_DETAIL_CODE=詳細コード

アプリ連携のコマンド1の詳細コード

APP_CMD2_RETURN_CODE=完了コード

アプリ連携のコマンド2の完了コード

APP_CMD2_DETAIL_CODE=詳細コード

アプリ連携のコマンド2の詳細コード

APP_CMD3_RETURN_CODE=完了コード

アプリ連携のコマンド3の完了コード

APP_CMD3_DETAIL_CODE=詳細コード

アプリ連携のコマンド3の詳細コード

APP_CMD_FILE_UPLOAD=アプリコマンドファイルアップロード有無

アプリ連携正常終了時に一時ファイルをアップロードするかどうか

true

: アップロードする

false

: アップロードしない

APP_CMD_FILE_UPLOAD_RETURN_CODE=アプリ連携コマンドファイルアップロード完了コード

アプリ連携コマンドファイルアップロードの完了コード

APP_CMD_FILE_UPLOAD_DETAIL_CODE=アプリ連携コマンドファイルアップロード詳細コード

アプリ連携コマンドファイルアップロードの詳細コード

MAIL_INTERFACE=メール連携有無

メール連携を実行したかどうか

ture

: メール連携あり

false

: メール連携なし

MAIL_PREREQUISITE=メール連携前提イベント

メール連携の前提イベント

0

: なし

2

: HULFT連携

3

: アプリ連携

4

: フォルダ移動

MAIL_RETURN_CODE=完了コード

メール連携の完了コード

MOVE_FOLDER=フォルダ移動有無

フォルダ移動を実行したかどうか

ture

: フォルダ移動あり

false

: フォルダ移動なし

MOVE_PREREQUISITE=フォルダ移動前提イベント

フォルダ移動の前提イベント

0

: なし

1

: メール連携

2

: HULFT連携

3

: アプリ連携

MOVE_FOLDER_RETURN_CODE=完了コード

フォルダ移動の完了コード

OPERATION_ID=処理識別子

フォルダイベントの処理識別子

OBJECT_ID=オブジェクトID

フォルダイベントの登録先フォルダのオブジェクトID

. (ソースファイル名:行番号)

フォルダイベント履歴を出力したソース上の位置を特定するためのファイル名と行番号