ログ

xitrum.Logオブジェクトを直接使用する

xitrum.Logはどこからでも直接使用することができます:

xitrum.Log.debug("My debug msg")
xitrum.Log.info("My info msg")
...

xitrum.Logトレイトを直接使用する

ログが生成された場所(クラス)を明確に知りたい場合、 xitrum.Logトレイトを継承します。

package my_package
import xitrum.Log

object MyModel extends Log {
  log.debug("My debug msg")
  log.info("My info msg")
  ...
}

log/xitrum.log にはメッセージが MyModel から出力されていることがわかります。

Xitrumのアクションはxitrum.Logトレイトを継承しており、どのactionからでも以下のようにログを出力することができます:

log.debug("Hello World")

ログレベルをチェックする必要はありません

xitrum.Log は SLF4S (API) を使用しており、 SLF4Sは SLF4J の上に構築されています。

ログに出力時の計算によるCPU負荷を減らす目的で、ログ出力前にログレベルをチェックする伝統的な手法がありますが、 SLF4Sが自動でチェックしてくれる ため、 あなたが気にする必要はありません。

これまで (このコードは Xitrum 3.13 以降では動作しません):

if (log.isTraceEnabled) {
  val result = heavyCalculation()
  log.trace("Output: {}", result)
}

現行:

log.trace(s"Output: #{heavyCalculation()}")

ログレベル、ログファイル等の設定

build.sbtに以下の1行があります:

libraryDependencies += "ch.qos.logback" % "logback-classic" % "1.1.2"

これはデフォルトで Logback が使用されていることを意味します。 Logbackの設定ファイルは config/logback.xml になります。

Logback以外の SLF4J 対応ライブラリに置き換えることも可能です。

Fluentd へのログ出力

ログコレクターとして有名な Fluentd というソフトウェアがあります。 Logbackの設定を変更することでFluentdサーバにXitrumのログを（複数の箇所から）転送することができます。

利用するにはまず、プロジェクトの依存ライブラリに logback-more-appenders を追加します:

libraryDependencies += "org.fluentd" % "fluent-logger" % "0.2.11"

resolvers += "Logback more appenders" at "http://sndyuk.github.com/maven"

libraryDependencies += "com.sndyuk" % "logback-more-appenders" % "1.1.0"

そして config/logback.xml を編集します:

...

<appender name="FLUENT" class="ch.qos.logback.more.appenders.DataFluentAppender">
  <tag>mytag</tag>
  <label>mylabel</label>
  <remoteHost>localhost</remoteHost>
  <port>24224</port>
  <maxQueueSize>20000</maxQueueSize>  <!-- Save to memory when remote server is down -->
</appender>

<root level="DEBUG">
  <appender-ref ref="FLUENT"/>
  <appender-ref ref="OTHER_APPENDER"/>
</root>

...