PV168/Logování: Porovnání verzí

Z FI WIKI
Přejít na: navigace, hledání
(Simple Logging Facade for Java (SLF4J) [http://www.slf4j.org/])
(update na log4j2)
Řádka 6: Řádka 6:
  
 
* Logback [http://logback.qos.ch/ http://logback.qos.ch/]
 
* Logback [http://logback.qos.ch/ http://logback.qos.ch/]
* Log4J 1.2 [http://logging.apache.org/log4j/1.2/ http://logging.apache.org/log4j/1.2/]
+
* Log4j 2 [http://logging.apache.org/log4j/2.x/ http://logging.apache.org/log4j/2.x/]
* JUL (java.util.logging) [http://docs.oracle.com/javase/7/docs/technotes/guides/logging/overview.html Java Logging Overview]
+
* JUL (java.util.logging) [http://docs.oracle.com/javase/8/docs/technotes/guides/logging/overview.html Java Logging Overview]
  
 
Aby nemusely být aplikace a knihovny psány pro konkrétní z těchto implementací, existují dvě ''obalovací'' logovací knihovny,
 
Aby nemusely být aplikace a knihovny psány pro konkrétní z těchto implementací, existují dvě ''obalovací'' logovací knihovny,
Řádka 188: Řádka 188:
 
</xml>
 
</xml>
  
=== Log4j (LS) [http://logging.apache.org/log4j/docs/] ===
+
=== Log4j2 (LS) [http://logging.apache.org/log4j/2.x/log4j-api/apidocs/index.html] ===
 
* velmi komplexní a robustní logovací knihovna
 
* velmi komplexní a robustní logovací knihovna
 
* umí vše co JUL a něco navíc
 
* umí vše co JUL a něco navíc
 
* defacto standard logování J2EE aplikací
 
* defacto standard logování J2EE aplikací
* nyní součástí http://logging.apache.org/, existuje k němu prohlížeč logů [http://logging.apache.org/log4j/docs/chainsaw.html Chainsaw]
+
* nyní součástí http://logging.apache.org/
* úrovně (třída [http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/Level.html Level]) ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF
+
* úrovně (třída [https://logging.apache.org/log4j/2.x/log4j-api/apidocs/org/apache/logging/log4j/Level.html Level]) ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF
 
* handlery pro logování na konzolu, do souboru, do databáze, přes JMS, do syslogu, emailem a další
 
* handlery pro logování na konzolu, do souboru, do databáze, přes JMS, do syslogu, emailem a další
Pro správnou funkci je třeba mít v CLASSPATH soubor jménem '''log4j.xml''' s konfigurací, např.:
+
Pro správnou funkci je třeba mít v CLASSPATH soubor jménem '''log4j2.xml''' s konfigurací, např.:
<xml><?xml version="1.0" encoding="UTF-8" ?>
+
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
+
<Configuration status="debug" strict="true" name="XMLConfigTest" packages="">
<log4j:configuration xmlns:log4j='http://jakarta.apache.org/log4j/'>
+
 
     <!-- appender určuje, kam se bude logovat, v tomto případě na konzolu -->
 
     <!-- appender určuje, kam se bude logovat, v tomto případě na konzolu -->
     <appender name="STDOUT" class="org.apache.log4j.ConsoleAppender">
+
     <Appenders>
        <layout class="org.apache.log4j.PatternLayout">
+
        <Console name="STDOUT" target="SYSTEM_OUT">
            <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n"/>
+
            <PatternLayout pattern="%d [%t] %-5p %c - %m%n"/>
         </layout>
+
         </Console>
    </appender>
+
        <!-- tento appender loguje do denně rotovaného souboru v adresáři určeném obsahem systémové property catalina.base-->
    <!-- tento appender loguje do denně rotovaného souboru v adresáři určeném obsahem systémové property catalina.base-->
+
         <RollingFile name="RollingFile" fileName="${catalina.base}/logs/app.log" filePattern="${catalina.base}/logs/app-%d{MM-dd-yyyy}-%i.log">
    <appender name="roll" class="org.apache.log4j.DailyRollingFileAppender">
+
            <PatternLayout>
         <param name="File" value="${catalina.base}/logs/pbsmon2.log4j"/>
+
                <Pattern>%d [%t] %-5p %c - %m%n</Pattern>
        <param name="DatePattern" value=".yyyy-MM-dd"/>
+
            </PatternLayout>
        <layout class="org.apache.log4j.PatternLayout">
+
            <Policies>
            <param name="ConversionPattern" value="%d [%t] %-5p %c - %m%n"/>
+
              <TimeBasedTriggeringPolicy />
        </layout>
+
              <SizeBasedTriggeringPolicy size="250 MB"/>
    </appender>
+
            </Policies>
    <!-- category určuje úroveň logování pro třídy v určitém package -->
+
         </RollingFile>
    <category name="org.apache.log4j.xml">
+
     </Appenders>
         <priority value="info"/>
+
     <!-- definuje hlavní konfiguraci, tedy které z appenderů se mají použít -->
     </category>
+
    <Loggers>
     <category name="net.sourceforge.stripes">
+
        <!-- určuje úroveň logování pro třídy v určitém package -->
            <priority value="info"/>
+
        <Logger name="net.sourceforge.stripes" level="trace">
    </category>
+
             <AppenderRef ref="STDOUT"/>
    <category name="cz.muni.fi.pa165.cv5">
+
        </Logger>
             <priority value="debug"/>
+
        <!-- všechno ostatní se bude logovat s defaultně nastavenou úrovní -->
    </category>
+
        <Root level="error">
    <!-- root definuej hlavní konfiguraci, tedy které z appenderů se mají použít -->
+
    <AppenderRef ref="STDOUT" />
    <root>
+
            <AppenderRef ref="RollingFile" />
        <priority value="info"/>
+
        </Root>
        <appender-ref ref="STDOUT"/>
+
    </Loggers>
    </root>
+
</Configuration>
</log4j:configuration>
+
 
</xml>
+
Rovněž je možné konfiguraci dodat ve formátu [https://logging.apache.org/log4j/2.x/manual/configuration.html#JSON JSON] nebo jako [https://logging.apache.org/log4j/2.x/manual/configuration.html#Properties .properties] soubor.
  
  

Verze z 2. 2. 2016, 16:23

Přehled

Logování je ukládání informací o událostech v programu, jehož účelem je v případě potřeby dohledání činnosti systému nebo diagnostikování chyby.

V jazyce Java existují v podstatě tyto tři hlavní implementace logování:

Aby nemusely být aplikace a knihovny psány pro konkrétní z těchto implementací, existují dvě obalovací logovací knihovny, které neposkytují implementaci logování, jen rozhraní:

Logback a Log4J jsou od stejného autora, Logback je novější, rychlejší a flexibilnější než Log4J. Log4J bylo odjakživa lepší než JUL, ale JUL byl prosazen silou firmou Sun jako standardní součást JDK.

SLF4J je nástupce JCL, odstraňuje jeho problémy s classloadery.

Co mám použít ?

Ve zdrojových textech svých programů používejte rozhraní SLF4J.

Při nasazení programů používejte implementaci Logback.

Při využití cizích knihoven nebo programů, které používají něco jiného, využijte SLF4J legacy bridge, tj. jcl-over-slf4j, log4j-over-slf4j, jul-to-slf4j bridge.

Logovací rozhraní

Simple Logging Facade for Java (SLF4J) [1]

Definuje úrovně ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF, viz třída Level.

Použití

 
public class PbsCacheImpl implements PbsCache {
 
    final static Logger log = LoggerFactory.getLogger(PbsCacheImpl.class);
 //...
 
  // u jednoduchých výpisů stačí uvést řetězec a argumenty pro nahrazení
  log.debug("Server {} má {} položek",server,numItems);
 
  //u složitějších výpisů je vhodné předřadit if, aby se argumenty zbytečně nevyhodnocovaly
  if(log.isDebugEnabled()) {
     log.debug("Měla "+babka+" "+babkaPocetJablek+" a dědoušek jen "+dedaPocetJablek);
  }
 
  // u vyjímek pak
   try {
     //...
   } catch(Exception ex) {
     log.error("Houstone, máme problém",ex);
   }

Pokud používáte projekt typu Maven, přidáte knihovnu SLF4J rozhraní přidáním této závislosti:

 
<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-api</artifactId>
    <version>1.7.6</version>
</dependency>

nebo u spustitelného projektu se můžete spolehnout na to, že tranzitivními závislostmi bude SLF4J přidán automaticky, např. přidáním Logback:

 
<dependency> 
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.1.1</version>
</dependency>

Live template pro SLF4J v IntelliJ IDEA

V IntelliJ IDEA existují zkratky, tzv. Live Templates. Je výhodné si nastavit zkratku pro vkládání deklarace proměnné pro logování, viz následující obrázek, pak lze deklaraci vložit posloupností kláves slf<Enter>.

Live template slf.png

Jakarta Commons Logging (JCL) [2]

U nových projektů není doporučeno používat.

Implementace logování

Logback [3]

  • nástupce Log4J od stejného autora
  • výhody Logback proti Log4J
  • logback-classic přímo implementuje rozhraní SLF4J, které doporučuje používat

V projektech typu Maven stačí přidat závislost:

 
  <dependency>
   <groupId>ch.qos.logback</groupId>
   <artifactId>logback-classic</artifactId>
   <version>1.0.11</version>
  </dependency>

Pokud neexistuje konfigurační soubor, automaticky loguje všechno od úrovně DEBUG na standardní výstup.

Konfigurační soubor definuje

  • appender - kam a jakým způsobem se budou logy ukládat, např. na konzolu, do denně rotovaného souboru, do syslogu, do SQL databáze, atd.
  • logger - má jméno a úroveň, určuje od jaké Level (DEBUG, INFO atd.) budou události v určitých třídách nebo packages logovány.
  • root - definuje hlavní appender a úroveň, kterou od něj dědí explicitně nevyjmenované loggery

Například následující soubor logback.xml určuje, že

  • variantní appendery:
    • pokud budou třídy uvnitř servletového kontejneru Tomcat, bude se logovat do denně rotovaného souboru s názvem obsahujícím datum, např. mujprojekt.log.2013-12-31
    • pokud nebudou třídy v Tomcatu, bude se logovat na konzolu (standardní výstup)
  • loggery pro různé packages a třídy
    • třída cz.muni.fi.pv168.cemetery.GraveManagerImpl bude logovat na úrovni DEBUG
    • ostatní třídy jejichž balík začíná na cz.muni.fi.pv168 budou logovat na úrovni INFO
    • ostatní třídy jejichž balík začíná na cz budou logovat na úrovni WARN
  • tzv. root logger, ze kterého dědí nevyjmenované loggery, loguje od úrovně INFO
 
<configuration>
    <contextName>mujprojekt</contextName>
 
    <if condition='isDefined("catalina.base")'>
        <then>
            <appender name="APP" class="ch.qos.logback.core.rolling.RollingFileAppender">
                <file>${catalina.base}/logs/${CONTEXT_NAME}.log</file>
                <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                    <fileNamePattern>${catalina.base}/logs/${CONTEXT_NAME}.log.%d{yyyy-MM-dd}</fileNamePattern>
                </rollingPolicy>
                <encoder>
                    <!-- http://logback.qos.ch/manual/layouts.html#conversionWord -->
                    <pattern>%d [%thread] %-5level %logger{36} - %msg%n</pattern>
                </encoder>
            </appender>
        </then>
        <else>
            <appender name="APP" class="ch.qos.logback.core.ConsoleAppender">
                <encoder>
                    <pattern>%d [%thread] %-5level %logger{36} - %msg%n</pattern>
                </encoder>
            </appender>
        </else>
    </if>
 
    <logger name="cz" level="warn"/>
    <logger name="cz.muni.fi.pv168" level="info"/>
    <logger name="cz.muni.fi.pv168.cemetery.GraveManagerImpl" level="debug"/>
 
    <root level="info">
        <appender-ref ref="APP"/>
    </root>
 
</configuration>

Pokud používáme v konfiguračním souboru variany pomocí tagů <if><then<else>, je třeba ještě přidat knihovnu Janino, tedy závislost

 
   <dependency>
     <groupId>org.codehaus.janino</groupId>
     <artifactId>janino</artifactId>
     <version>2.6.1</version>
   </dependency>

Pokud používáme kromě vlastního kódu i knihovny, které používají některý jiný logovací framework, tj. JCL nebo Log4J, přesměrujeme jejich logovací výpisy do SLF4J a tím do Logback přidáním závislostí

 
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>1.7.2</version>
        </dependency>
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>log4j-over-slf4j</artifactId>
            <version>1.7.2</version>
        </dependency>
 

Log4j2 (LS) [4]

  • velmi komplexní a robustní logovací knihovna
  • umí vše co JUL a něco navíc
  • defacto standard logování J2EE aplikací
  • nyní součástí http://logging.apache.org/
  • úrovně (třída Level) ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF
  • handlery pro logování na konzolu, do souboru, do databáze, přes JMS, do syslogu, emailem a další

Pro správnou funkci je třeba mít v CLASSPATH soubor jménem log4j2.xml s konfigurací, např.: <?xml version="1.0" encoding="UTF-8"?> <Configuration status="debug" strict="true" name="XMLConfigTest" packages="">

   <Appenders>
       <Console name="STDOUT" target="SYSTEM_OUT">
           <PatternLayout pattern="%d [%t] %-5p %c - %m%n"/>
       </Console>
       <RollingFile name="RollingFile" fileName="${catalina.base}/logs/app.log" filePattern="${catalina.base}/logs/app-%d{MM-dd-yyyy}-%i.log">
           <PatternLayout>
               <Pattern>%d [%t] %-5p %c - %m%n</Pattern>
           </PatternLayout>
           <Policies>
              <TimeBasedTriggeringPolicy />
              <SizeBasedTriggeringPolicy size="250 MB"/>
           </Policies>
       </RollingFile>
   </Appenders>
   <Loggers>
       <Logger name="net.sourceforge.stripes" level="trace">
           <AppenderRef ref="STDOUT"/>
       </Logger>
       <Root level="error">

<AppenderRef ref="STDOUT" />

           <AppenderRef ref="RollingFile" />
       </Root>
   </Loggers>

</Configuration>

Rovněž je možné konfiguraci dodat ve formátu JSON nebo jako .properties soubor.


java.util.logging (JUL) [5]

  • ve standardním API od JDK 1.4
  • třída Logger (instance mají asociované jméno, jehož základ by měl tvořit název balíku, protože je na něm postavena hierarchie Loggerů)
  • Úrovně (instance třídy Level) ALL, FINEST, FINER, FINE, CONFIG, INFO, WARNING, SEVERE, OFF
  • Možnost implementace vlastního Filteru
  • Připravené handlery pro paměť, OutputStream, soubor (včetně rotování), konzolu, IP socket (i více najednou)
  • Připravené textové a XML formátování
  • Podpora lokalizovaných zpráv přebíraných z ResourceBundle
  • LogManager spravující všechny Loggery a jejich konfiguraci

Když neprovedu žádnou konfiguraci, JUL loguje od úrovně INFO na konzolu pomocí SimpleFormatter, protože to je konfigurace v souboru $JAVA_HOME/lib/logging.properties.

Pokud to chci změnit, musím vyrobit soubor logging.properties s obsahem alespoň

#vypis pujde na konzolu
handlers=java.util.logging.ConsoleHandler
# handler propusti vsechno od finest
java.util.logging.ConsoleHandler.level=FINEST
# loggery propusti vsechno od finest
.level= FINEST
#
#java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter
#java.util.logging.ConsoleHandler.formatter=java.util.logging.XMLFormatter

a při spuštění specifikovat jeho místo:

java -Djava.util.logging.config.file=/home/nekdo/nekde/logging.properties