nablarch.core.log.app

Class FailureJsonLogFormatter

java.lang.Object

nablarch.core.log.app.FailureLogFormatter

nablarch.core.log.app.FailureJsonLogFormatter

@Published(tag="architect")
public class FailureJsonLogFormatter
extends FailureLogFormatter

障害通知ログと障害解析ログのメッセージをJSON形式でフォーマットするクラス。

FailureLogFormatterでは、フォーマットとして出力内容を設定するが、 本クラスでは、 notificationTargets および、analysisTargets プロパティにて、 出力項目を指定する。指定可能な出力項目は下記の通り。

• failureCode: 障害コード
• message: メッセージ
• data: 処理対象データ
• contact: 連絡先

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FailureJsonLogFormatter.ContactBuilder 連絡先を処理するクラス。
static class	FailureJsonLogFormatter.DataBuilder 処理対象データを処理するクラス。
static class	FailureJsonLogFormatter.FailureCodeBuilder 障害コードを処理するクラス。
static class	FailureJsonLogFormatter.MessageBuilder メッセージを処理するクラス。

Nested classes/interfaces inherited from class nablarch.core.log.app.FailureLogFormatter

FailureLogFormatter.ContactItem, FailureLogFormatter.DataItem, FailureLogFormatter.FailureCodeItem, FailureLogFormatter.FailureLogContext, FailureLogFormatter.MessageItem

Field Summary

Fields inherited from class nablarch.core.log.app.FailureLogFormatter

PROPS_PREFIX

Constructor Summary

Constructors

Constructor and Description
FailureJsonLogFormatter()

Method Summary

Modifier and Type	Method and Description
protected JsonSerializationManager	createSerializationManager(JsonSerializationSettings settings) 変換処理に使用するJsonSerializationManagerを生成する。
protected java.lang.String	format(java.util.List<JsonLogObjectBuilder<FailureLogFormatter.FailureLogContext>> structuredTargets, java.lang.Throwable error, java.lang.Object data, java.lang.String failureCode, java.lang.Object[] messageOptions) 指定されたフォーマット済みのログ出力項目を使用してメッセージをフォーマットする。
java.lang.String	formatAnalysisMessage(java.lang.Throwable error, java.lang.Object data, java.lang.String failureCode, java.lang.Object[] messageOptions) 障害解析ログのメッセージをフォーマットする。
java.lang.String	formatNotificationMessage(java.lang.Throwable error, java.lang.Object data, java.lang.String failureCode, java.lang.Object[] messageOptions) 障害通知ログのメッセージをフォーマットする。
protected java.util.List<JsonLogObjectBuilder<FailureLogFormatter.FailureLogContext>>	getStructuredTargets(java.util.Map<java.lang.String,java.lang.String> props, java.lang.String targetsPropName) ログ出力項目を取得する。
protected void	initialize() 初期化
protected void	initializeFormatterSupport(java.util.Map<java.lang.String,java.lang.String> props, java.lang.String prefix, java.lang.String filePath) 各種ログのJSONフォーマット支援オブジェクトの初期化
protected void	initializeTargets(java.util.Map<java.lang.String,java.lang.String> props) 出力項目の初期化

Methods inherited from class nablarch.core.log.app.FailureLogFormatter

format, getAnalysisFormat, getAppFailureCodes, getContactList, getDefaultFailureCode, getDefaultMessage, getFailureCode, getFrameworkFailureCode, getFwFailureCodes, getLogItems, getMessage, getNotificationFormat, getProps, getRootExceptionPoint, initializeFailureCodes, initializeFormat, initializeMessage

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FailureJsonLogFormatter

public FailureJsonLogFormatter()

Method Detail

initialize

protected void initialize()

初期化

Overrides:

initialize in class FailureLogFormatter

initializeFormatterSupport

protected final void initializeFormatterSupport(java.util.Map<java.lang.String,java.lang.String> props,
                                                java.lang.String prefix,
                                                java.lang.String filePath)

各種ログのJSONフォーマット支援オブジェクトの初期化

Parameters:

props - 各種ログ出力の設定情報

createSerializationManager

protected JsonSerializationManager createSerializationManager(JsonSerializationSettings settings)

変換処理に使用するJsonSerializationManagerを生成する。

Parameters:

settings - 各種ログ出力の設定情報

Returns:

JsonSerializationManager

initializeTargets

protected final void initializeTargets(java.util.Map<java.lang.String,java.lang.String> props)

出力項目の初期化

Parameters:

props - 各種ログ出力の設定情報

getStructuredTargets

protected java.util.List<JsonLogObjectBuilder<FailureLogFormatter.FailureLogContext>> getStructuredTargets(java.util.Map<java.lang.String,java.lang.String> props,
                                                                                                           java.lang.String targetsPropName)

ログ出力項目を取得する。

Parameters:

props - 各種ログ出力の設定情報

targetsPropName - 出力項目のプロパティ名

Returns:

ログ出力項目

formatNotificationMessage

public java.lang.String formatNotificationMessage(java.lang.Throwable error,
                                                  java.lang.Object data,
                                                  java.lang.String failureCode,
                                                  java.lang.Object[] messageOptions)

障害通知ログのメッセージをフォーマットする。

 フォーマット対象の出力項目を下記に示す。
 障害コード
 障害コードから取得したメッセージ
 派生元実行時ID
 

Overrides:

formatNotificationMessage in class FailureLogFormatter

Parameters:

error - エラー情報

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

Returns:

フォーマット済みのメッセージ

formatAnalysisMessage

public java.lang.String formatAnalysisMessage(java.lang.Throwable error,
                                              java.lang.Object data,
                                              java.lang.String failureCode,
                                              java.lang.Object[] messageOptions)

障害解析ログのメッセージをフォーマットする。

 フォーマット対象の出力項目を下記に示す。
 障害コード
 障害コードから取得したメッセージ
 派生元実行時ID
 

Overrides:

formatAnalysisMessage in class FailureLogFormatter

Parameters:

error - エラー情報

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

Returns:

フォーマット済みのメッセージ

format

protected java.lang.String format(java.util.List<JsonLogObjectBuilder<FailureLogFormatter.FailureLogContext>> structuredTargets,
                                  java.lang.Throwable error,
                                  java.lang.Object data,
                                  java.lang.String failureCode,
                                  java.lang.Object[] messageOptions)

指定されたフォーマット済みのログ出力項目を使用してメッセージをフォーマットする。

 フォーマット対象の出力項目を下記に示す。
 障害コード
 障害コードから取得したメッセージ
 派生元実行時ID
 

Parameters:

structuredTargets - ログ出力項目

error - エラー情報

data - 処理対象データ

failureCode - 障害コード

messageOptions - 障害コードからメッセージを取得する際に使用するオプション情報

Returns:

フォーマット後のメッセージ