レポートのSQLを含む実行ログを出力したい – Yellowfin Japan サポートサイト

概要：

有事の際の調査や実行の遅いレポートの調査などの用途でレポートの実行履歴やレポートのSQLをロギングしておくことができます。
設定を追加することでレポートの実行のプロセス（実行SQLを含む）、実行キューへの追加、開始、完了、キャンセルの時間などのレポートの実行ログが出力されるようになります。

設定を追加すると下記ディレクトリへレポートの実行ログ（report_exec.log）が出力されるようになります。

■レポートの実行ログ（report_exec.log）出力先

　<Yellowfinインストールディレクトリ>¥appserver¥logs

レポートの実行ログ追加設定（8.0.7以前、9.3.1以前）：

以下ファイルを開きます。
ファイル名：log4j.properties
保存先：<Yellowfinインストールディレクトリ>¥appserver¥webapps¥ROOT¥WEB-INF

log4j.propertiesファイル内に以下を追記します。

# Report execution Log
log4j.appender.reportlog=org.apache.log4j.RollingFileAppender
log4j.appender.reportlog.File=${catalina.home}/logs/report_exec.log
log4j.appender.reportlog.MaxFileSize=1024KB
log4j.appender.reportlog.MaxBackupIndex=9
log4j.appender.reportlog.layout=org.apache.log4j.PatternLayout
log4j.appender.reportlog.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss.SSS} (%M) - %m%n

log4j.category.com.hof.mi.process.MIReportGeneratorProcess=DEBUG,reportlog
log4j.category.com.hof.mi.util.background.QueueItem=DEBUG,reportlog
log4j.category.com.hof.adapter.JDBCEventCreation=DEBUG,reportlog
# set additivity to false so it doesn't also log to standard log files
log4j.additivity.com.hof.mi.process.MIReportGeneratorProcess=false
log4j.additivity.com.hof.mi.util.background.QueueItem=false
log4j.additivity.com.hof.adapter.JDBCEventCreation=false

ファイル保存後、Yellowfinを再起動ください。
再起動後、report_exec.logが出力されます。

レポートの実行ログ追加設定（8.0.8以降、9.4.0以降）：

以下ファイルを開きます。
ファイル名：log4j2.xml
保存先：<Yellowfinインストールディレクトリ>¥appserver¥webapps¥ROOT¥WEB-INF
log4j2.xml ファイルを以下の手順で編集します。
必ずUTF-8に対応したテキストエディタを使用してください。

メモ帳の使用は避けてください。まずは設定を変更がうまくいかない際に元に戻せる様にファイルをバックアップします。

log4j2.xmlをコピーし<Yellowfinインストールディレクトリ>と関係しない別のディレクトリに保持します。

元のディレクトリに log4j2.xml.org などの様にファイル名を変更して保持した場合はそのファイルが読み込まれ設定が適用されてしまいます。必ず別のディレクトリに保持してください。

log4j2の仕様にしたがってlog4j2.xmlを編集します。

Apacheのlog4j2のリファレンスページへのリンクもございますのでYellowfinのロギングについては下記のWikiページを参照してください。https://wiki.yellowfin.co.jp/pages/viewpage.action?pageId=14421426
1. - <Appenders>タグのメンバーに出力するファイル定義を追加します。
    Yellowfin.logと同じ様にローリングするには下記の様に追加します。
```
<Appenders>
・
・
・
  <RollingFile name="reportlog" fileName="${logDir}/report_exec.log" filePattern="${logDir}/report_exec.log.%i">
    <PatternLayout pattern="${appenderPatternLayout}" /> 
    <Policies>
      <SizeBasedTriggeringPolicy size="${maxFileSize}" />
    </Policies>
    <DefaultRolloverStrategy fileIndex="min" max="${maxFiles}"/>
  </RollingFile>
・
・
・
</Appenders>
```
    ※上記は8.0.8以降、9.4.0以降を新規インストールした場合のlog4j2.xmlに追記する例です。
    8.0.7以前、9.3.1以前からアップデートした場合は変数定義（${〜}の部分）が記載されておりませんので、直接数値を指定するか、添付の新規インストールの際に作成されるlog4j2.xmlを参考に変数定義を追加してください。
  - <Loggers>タグのメンバーを下記のように追加します。
```
<Loggers>
・
・
・
    <Logger name="com.hof.adapter.JDBCEventCreation" level="DEBUG" additivity="false">
      <AppenderRef ref="reportlog"/>
    </Logger>
    <Logger name="com.hof.mi.process.MIReportGeneratorProcess" level="DEBUG" additivity="false">
      <AppenderRef ref="reportlog"/>
    </Logger>
    <Logger name="com.hof.mi.util.background.QueueItem" level="DEBUG" additivity="false">
      <AppenderRef ref="reportlog"/>
    </Logger>
・
・
・
</Loggers>
```
ファイル保存後、Yellowfinを再起動ください。
再起動後、report_exec.logが出力されます。

上記、追加設定方法についてご不明な点などございましたら、サポートサイトよりお問い合わせください。

また、Yellowfinにて出力されるログについての説明は以下を参照ください。

■ログとロギング

https://wiki.yellowfin.co.jp/pages/viewpage.action?pageId=14421426

log4j2.xml
4 KB Download

このセクションの記事

関連記事