Download as PDF, PPTX
![#jjugログとは！例:$ kink -Vdebug -e ''2015-10-04 15:58:29 [main] DEBUG BoxingValues - use box proto listenerorg.kink_lang.kink.internal.eval.VarAssignEvaluator$VarAssignListener@3af49f1c2015-10-04 15:58:29 [main] DEBUG BoxingValues - use box proto listenerorg.kink_lang.kink.internal.eval.ArgsPassingEvaluator$ListAssignListener@1c20c6842015-10-04 15:58:29 [main] DEBUG BoxingValues - use box proto listenerorg.kink_lang.kink.internal.eval.ThenUtils$BoolThenListener@1218025c2015-10-04 15:58:29 [main] DEBUG BoxingValues - Setup prototype for java.lang.String2015-10-04 15:58:29 [main] DEBUG Modules - Load module _enhance/java/lang/Objectfrom org.kink_lang.kink.internal.box.ObjectEnhancer@5e8c92f42015-10-04 15:58:29 [main] INFO Definer -org.kink_lang.kink.internal.define.frequency_threshold=128...システムの状態を後から見られるように出力したテキスト3/67](/image.pl?url=https%3a%2f%2fimage.slidesharecdn.com%2fconceptsandtoolsoflogginginjava-151014081951-lva1-app6892%2f75%2fJava-3-2048.jpg&f=jpg&w=240)
TM
Uploaded byTaku Miyakawa
PDF, PPTX78,740 views
Javaのログ出力: 道具と考え方
Concepts and tools of logging in Java.Javaにおけるログ出力の考え方と道具について説明.CC Attribution Licenseの元に公開します.
Javaのログ出力: 道具と考え方
- 1.
- 2. @miyakawa_taku JJUG幹事SI屋で賃労働 尾上部屋の里山関のファンです オレオレJVM言語Kinkを作っていますhttps://bitbucket.org/kink/kink自己紹介 #jjug2/67
- 3.#jjugログとは！例:$ kink -Vdebug-e ''2015-10-04 15:58:29 [main] DEBUG BoxingValues - use box proto listenerorg.kink_lang.kink.internal.eval.VarAssignEvaluator$VarAssignListener@3af49f1c2015-10-04 15:58:29 [main] DEBUG BoxingValues - use box proto listenerorg.kink_lang.kink.internal.eval.ArgsPassingEvaluator$ListAssignListener@1c20c6842015-10-04 15:58:29 [main] DEBUG BoxingValues - use box proto listenerorg.kink_lang.kink.internal.eval.ThenUtils$BoolThenListener@1218025c2015-10-04 15:58:29 [main] DEBUG BoxingValues - Setup prototype for java.lang.String2015-10-04 15:58:29 [main] DEBUG Modules - Load module _enhance/java/lang/Objectfrom org.kink_lang.kink.internal.box.ObjectEnhancer@5e8c92f42015-10-04 15:58:29 [main] INFO Definer -org.kink_lang.kink.internal.define.frequency_threshold=128...システムの状態を後から見られるように出力したテキスト3/67
- 4.
- 5.なんで「ログ」って言うの? #jjuglog =丸太5/67
- 6.なんで「ログ」って言うの? #jjuglog =船の速度標丸太 (log) を引っ張る綱の張りで船の速度を測った6/67
- 7.なんで「ログ」って言うの? #jjuglogbook =航海日誌Photo by vxla, Licensed as CC BY 2.0, https://www.flickr.com/photos/vxla/5779530912/logで測った速度や方向などを帳面 (logbook) につける7/67
- 8.
- 9.
- 10.
- 11.
- 12.
- 13.#jjugvs テストテストとログは相補的な関係テストの領分 個別具体的な要件について不具合がないことを、ある程度保証する個別を積み重ねて全体に近づくログの領分 しかし完璧なテストはなく、たぶん故障は起きる。起きた故障を解析するためにはログが必要 ログは、開発・テスト時にシステムの動きを把握するのにも有用13/67
- 14.#jjugvs デバッガデバッガとログも相補的な関係デバッガの領分 動作中のシステムの状態が閲覧・変更できるログの領分過去のシステムの状態が閲覧できる 本番システムで利用できる 再現させるための条件が厳しかったり、不明だったりする故障について、故障発生前後の状況が追跡できる14/67
- 15.
- 16.
- 17.
- 18.
- 19.
- 20.
- 21.
- 22.#jjugログの道具に必要な特性一部のログ出力が抑止できる必要がある開発環境DEBUG doGet開始INFO 注文#42を閲覧DEBUGSELECT xxx FROM ...WARN Bobは注文#42を閲覧不可DEBUG doGet終了本番環境INFO 注文#42を閲覧WARN Bobは注文#42を閲覧不可ディスク領域節約・性能確保のため、重要でないログの出力を抑止することがあります22/67
- 23.#jjugログの道具に必要な特性その他 ログ出力先が簡単に切り替えられること ログローテーションできること複数スレッドからログが出力できること ディスクまで確実に書き込むこと 速いこと 例外を投げないこと ……23/67
- 24.#jjugログの道具ログの道具の諸特性を提供するため、多くの言語は専用ライブラリを用意していますRuby logging添付ライブラリPython loggingモジュールJavaLog4j,java.util.logging,Commons Logging, SLF4J,Logback, JBoss Logging, Log4j2,....24/67
- 25.
- 26.#jjug問題次の中で役割が異るライブラリはどれでしょう?A) java.util.loggingB) Log4jC)LogbackD) SLF4J26/67
- 27.
- 28.
- 29.ログ出力の階層 #jjugアプリケーションログファサードライブラリログ出力ライブラリファイル/コンソール/...ど う考 え て も本 質 的 に は 要 ら な い も のなぜこんなことになったのかそれを知るには歴史を紐解く必要があります29/67
- 30.
- 31.
- 32.前史時代 #jjugApache Tomcat3.0（最初期リリース）// org.apache.tomcat.core.ServletContextFacadepublic void log(String msg) {System.err.println(msg);}32/67
- 33.
- 34.Log4jの登場 #jjugimport org.apache.log4j.Logger;publicclass EchoServlet extends HttpServlet {private Logger logger = Logger.getLogger(getClass());protected void doGet(HttpServletRequest req, HttpServletResponse resp) {String text = req.getParameter("text");this.logger.info("テキスト: " + text);...}}Log4jを使うサーブレットの例:34/67
- 35.#jjugLog4jはすごい!ログライブラリの事実上の標準に しばらくはAvalon Logkitも有力だった後続のログ関連ライブラリはだいたいLog4jの機能を踏襲階層化されたロガー ログ書き込みを行うアペンダ MDCによる文脈情報の保持35/67
- 36.
- 37.階層化されたロガー #jjugロ ガー org.kink_langレ ベ ル = WARNア ペ ン ダ =ConsoleAppenderorg.kink_lang.kinkレ ベ ル = DEBUGア ペ ン ダ =ConsoleAppender（ 継 承 ）org.kink_lang.kink.Valueレ ベ ル = DEBUG（ 継 承 ）ア ペ ン ダ =ConsoleAppender（ 継 承 ）+ RollingFileAppenderWARN, ERROR, FATAL のロ グ を コ ン ソ ー ル に 出 す加 え て DEBUG, INFO のロ グ も コ ン ソ ー ル に 出 すコ ン ソ ー ル に 加 え てフ ァ イ ル に も ロ グ を 出 す37/67
- 38.
- 39.#jjugMDC例: リクエストIDを設定するフィルタimport org.apache.log4j.MDC;publicclass PutRequestIdFilter implements Filter {public void doFilter (ServletRequest req, ServletResponse resp, FilterChain chain)throws IOException, ServletException {String reqId = UUID.randomUUID().toString();MDC.put("request", reqId);try {chain.doFilter(req, resp);} finally {MDC.remove("request");}}...}39/67
- 40.
- 41.
- 42.java.util.logging #jjugLog4jとだいたいおなじ!import java.util.logging.Logger;publicclass EchoServlet extends HttpServlet {private Logger logger= Logger.getLogger(getClass().getName());protected void doGet(HttpServletRequest req, HttpServletResponse resp) {String text = req.getParameter("text");this.logger.info("テキスト: " + text);...}} Log4j と の 差 分42/67
- 43.#jjugjava.util.loggingLog4jの牙城を崩すには至らず ログレベルが謎 SEVERE,WARNING,INFO,CONFIG,FINE,FINER,FINESTデフォルトの書式が扱いづらい ハンドラ（=アペンダ）の実装が不足 Java 1.3以前で使えない JVM全体で1つの設定しか持てない サーブレットコンテナ下で、各アプリケーションが個別のログ設定を持つための組み込みの方法がない43/67
- 44.
- 45.#jjugCommons Loggingの登場Commons HttpClientから派生したログファサードライブラリHttpClientのような便利ライブラリが、特定のログ実装に依存するのはちょっと、という理由ではじまったLog4jやjava.util.loggingを切り替えて使えるようになる（はずだった）45/67
- 46.Commons Logging #jjugimportorg.apache.commons.logging.Log;import org.apache.commons.logging.LogFactory;public class EchoServlet extends HttpServlet {private Log logger = LogFactory.getLog(getClass());protected void doGet(HttpServletRequest req, HttpServletResponse resp) {String text = req.getParameter("text");this.logger.info("テキスト: " + text);...}}Log4jとだいたいおなじ!Log4j と の 差 分46/67
- 47.
- 48.#jjugCommons Logging実現したかったこと（のひとつ）A Pサ ー バ共 有 ラ イ ブ ラ リア プ リ Aア プ リ BCommons Loggingロ グ via Log4jロ グ via java.util.loggingログ実装の決定方法 Context Classloaderから始まって、親・祖先のクラスローダ内でアダプタクラスを探索 最初にみつかったアダプタを使う48/67
- 49.#jjugCommons Logging実際にはうまく行っていませんJava EEコンテナOSGiコンテナクラスローダ不一致によるNoClassDefFoundErrorの頻発→アドホックな try-catchで対処動かすための設定が非直感的かつAPサーバごとに 異なるContext Classloaderを 使 っ て お ら ず 親 クラスローダへの委譲もない→ そもそも動かない動的探索という構想に無理がありました49/67
- 50.
- 51.#jjugSLF4J / LogbackLog4jの開発者CekiGülcüが、開発の遅延に愛想を尽かして立ち上げたプロジェクトSLF4JLogbackログファサードライブラリログ出力ライブラリSLF4Jと組み合わせて使う前提2015年現在のデファクトスタンダード51/67
- 52.SLF4J / Logback#jjugimport org.slf4j.Logger;import org.slf4j.LoggerFactory;public class EchoServlet extends HttpServlet {private Logger logger = LoggerFactory.getLogger(getClass());protected void doGet(HttpServletRequest req, HttpServletResponse resp) {String text = req.getParameter("text");this.logger.info("テキスト: {}", text);...}}やっぱりLog4jとだいたいおなじLog4j と の 差 分52/67
- 53.
- 54.#jjugSLF4J必要なJARslf4j-api-*.jarAPI（必須）ログ実装へのバインディング（どれか一個） logback-classic-*.jar (Logback)slf4j-log4j12-*.jar(Log4j)slf4j-jdk14-*.jar (java.util.logging)log4j-slf4j-impl-*.jar (Log4j2)両方のJARを同一のクラスローダが参照する場所に配置します54/67
- 55.#jjugSLF4J静的バインディングの中身LoggerFactoryアプリStaticLoggerBindergetLogger()getSingleton()バ イ ンデ ィ ン グ の J A R 内 に同 名 の ク ラ ス が そ れ ぞ れ 存 在slf4j-api-*.jarに存在55/67
- 56.
- 57.#jjugSLF4Jログの横取りLog4jjava.util.loggingCommonsLogginglog4j-over-slf4j-*.jarLog4j と同名のクラスを提供実際には SLF4Jに流し込むjcl-over-slf4j-*.jarCommonsLoggingと同名のクラスを提供実際には SLF4Jに流し込むjul-to-slf4j-*.jarSLF4Jに流し込むハンドラを提供slf4j-api-*.jarと同じ場所に配置します57/67
- 58.#jjugLogback独自のロガーインタフェースを持たず、SLF4J経由で呼び出します提供する機能 マーカー ログ行のラベル的なものマーカー「 auth」がついてるログは auth.logに出す、みたいなことができます 設定のリロード アプリごとにログ出力先を分ける機能58/67
- 59.Javaのログライブラリの歴史 #jjug～19991999200020012005前史時代Log4jの登場java.util.logging規格化開始Commons Loggingの登場SLF4J/ Logback2014 Log4j259/67
- 60.
- 61.Log4j2 #jjugimport org.apache.logging.log4j.Logger;importorg.apache.logging.log4j.LogManager;public class EchoServlet extends HttpServlet {private Logger logger = LogManager.getLogger(getClass());protected void doGet(HttpServletRequest req, HttpServletResponse resp) {String text = req.getParameter("text");this.logger.info("テキスト: {}", text);...}}早い話がLog4jですLog4j と の 差 分61/67
- 62.
- 63.#jjug使うべきログ関連ライブラリ共有ライブラリ SLF4Jにログを出す compileスコープではログ実装ライブラリに依存しないテストでは好みのログ実装を使うGradle dependencies:compile 'org.slf4j:slf4j-api:1.7.12'testCompile 'ch.qos.logback:logback-core:1.1.3'testCompile 'ch.qos.logback:logback-classic:1.1.3'63/67
- 64.#jjug使うべきログ関連ライブラリアプリケーション 基盤・ミドルウェアの制約しだい 制約がなければSLF4J+Logbackが無難Log4j(1/2)やjava.util.loggingを直接叩くのも可ですが、あえてSLF4Jを避ける理由はなさそう64/67
- 65.
- 66.#jjugJavaのログ まとめ Log4jがJavaのログの道具立てを作ったロガー/アペンダ/MDC... ライブラリの依存性の都合からログファサードが生まれた SLF4Jを使っておけばとりあえずOK66/67
- 67.