intra-mart Accel Platform ログ仕様書 第12版 2019-12-01

IM-MessageHub ログ

IM-MessageHub ログには、IM-MessageHub を利用した配信機能の配信状況が出力されます。
IM-MessageHub とは、ユーザへの通知を目的としたメッセージの配信機能のフレームワークです。
IM-MessageHub を利用することで、アプリケーションは、メール、IMBox の ApplicationBox、IM-Notice 等の様々な配信先メディアへの通知処理を統一的に扱うことが可能になります。
IM-MessageHub ログでは、IM-MessageHub を利用した場合の、配信先メディア、送信者、宛先、配信結果等の情報が出力され、通知先への配信が実行されたことを確認することができます。
配信処理が開始・正常終了した際は、ログレベル INFO でログが出力されます。
配信処理に失敗したが、後続の宛先への配信処理を続行した際は、ログレベル WARN でログが出力されます。
配信処理が異常終了した際は、ログレベル ERROR でログが出力されます。

注意

IM-MessageHub ログは、intra-mart Accel Platform 2014 Winter(Iceberg) 以降で利用可能です。

モジュール IM-MessageHub
設定場所 %CONTEXT_PATH%/WEB-INF/conf/log/im_logger_message_hub.xml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
<included>

  <!--
     - MESSAGE_HUB_LOG
    -->
  <appender name="MESSAGE_HUB_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>${im.log}/platform/message_hub.log</file>
    <append>true</append>

    <!--
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <fileNamePattern>
        ${im.log}/platform/message_hub-%d{yyyy-MM-dd}.log
      </fileNamePattern>
    </rollingPolicy>
    -->

    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
      <fileNamePattern>${im.log}/platform/message_hub%i.log</fileNamePattern>
      <minIndex>1</minIndex>
      <maxIndex>5</maxIndex>
    </rollingPolicy>

    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
      <maxFileSize>10MB</maxFileSize>
    </triggeringPolicy>

    <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
      <layout class="jp.co.intra_mart.common.platform.log.layout.OutputStackTracePatternLayout">
        <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}]  [%thread]  %X{log.report.sequence}  %-5level  %logger{255}  %X{tenant.id}  %X{log.id}  -  %X{message_hub.message.id}  %X{message_hub.event.id}  [%X{log.message.code}]  %msg  %X{request.id}%nopex%n</pattern>

        <enableOutputStackTrace>true</enableOutputStackTrace>
        <stackTraceDir>${im.log}/platform/exception/</stackTraceDir>
        <stackTraceFilename>'exception_'yyyy-MM-dd_HH-mm-ss'_%logId.log'</stackTraceFilename>
      </layout>
    </encoder>
  </appender>

  <logger name="MESSAGE_HUB_LOG" additivity="false">
    <level value="info" />
    <appender-ref ref="MESSAGE_HUB_FILE" />
  </logger>

</included>

標準出力設定

ログレベル(初期値) INFO
出力先(初期値)
ファイル - ${im.log}/platform/message_hub.log

出力パターン

利用可能なパターン文字列

IM-MessageHub ログで利用可能なパターン文字列は以下の通りです。
パターン文字列については「パターン文字列」を参照してください。
フォーマット文字列 設定有無(初期値) 説明
%d 出力日時
%thread スレッド名
%level ログレベル
%logger ロガー名
%msg
%X
利用可能なキーは「利用可能なMDCキー」を参照してください。

利用可能なMDCキー

IM-MessageHub ログで利用可能なMDCのキーは以下の通りです。
MDCについては「MDC」を参照してください。
MDCキー 設定有無(初期値) 説明
log.thread.group × スレッドグループ
log.id ログ ID
message_hub.message.id メッセージ ID
message_hub.event.id
イベント ID
メッセージの配信を行ったアプリケーション、および、処理を特定するユニークな文字列です。
log.message.code ログメッセージコード
request.id リクエスト ID
user.cd ×
ログ出力時のアカウントコンテキストのユーザコード
user.type ×
ログ出力時のアカウントコンテキストのユーザ種別
administrator : システム管理者
platform : ジョブなどのバックグラウンド
user : 一般ユーザ
tenant.id
ログ出力時のアカウントコンテキストのテナント ID
authenticated ×
ログ出力時のアカウントコンテキストの認証状態
true : 認証済み
false : 未認証