{"id":138,"date":"2024-01-07T21:21:35","date_gmt":"2024-01-07T20:21:35","guid":{"rendered":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/?p=138"},"modified":"2024-01-08T21:27:34","modified_gmt":"2024-01-08T20:27:34","slug":"logging-in-spring-boot","status":"publish","type":"post","link":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/?p=138","title":{"rendered":"Logging in Spring Boot"},"content":{"rendered":"\n

Logging ist ein entscheidender Aspekt der Softwareentwicklung und wird oft vernachl\u00e4ssigt, bis Probleme in Produktionsumgebungen auftreten. Spring Boot, ein beliebtes Framework zur Entwicklung von Java-Anwendungen, bietet von Haus aus robuste Logging-Funktionen. In diesem Artikel werden wir das Logging in Spring Boot erkunden und die Grundlagen, Konfiguration, g\u00e4ngige Bibliotheken und bew\u00e4hrte Praktiken behandeln.<\/p>\n\n\n\n

Warum Logging wichtig ist<\/h2>\n\n\n\n

Effektives Logging ist aus mehreren Gr\u00fcnden wichtig:<\/p>\n\n\n\n

    \n
  1. Fehlersuche<\/strong>: Logging hilft Entwicklern dabei, Probleme zu identifizieren und zu beheben, indem es Einblicke in das Verhalten der Anwendung zur Laufzeit liefert.<\/li>\n\n\n\n
  2. \u00dcberwachung<\/strong>: Logs k\u00f6nnen verwendet werden, um die Gesundheit und Leistung der Anwendung in Produktionsumgebungen zu \u00fcberwachen.<\/li>\n\n\n\n
  3. Auditierung<\/strong>: Logging ist wichtig, um Benutzeraktivit\u00e4ten zu verfolgen und eine Audit-Trail aufrechtzuerhalten.<\/li>\n\n\n\n
  4. Sicherheit<\/strong>: Es hilft dabei, Sicherheitsverletzungen und unbefugten Zugriff zu identifizieren.<\/li>\n<\/ol>\n\n\n\n

    Logging in Spring Boot<\/h2>\n\n\n\n

    Spring Boot verwendet die Commons Logging API<\/strong>, die eine flexible und benutzerfreundliche Logging-Abstraktion bietet. Im Hintergrund integriert sie verschiedene Logging-Frameworks wie Logback, Log4j2 und Java Util Logging (JUL). Das bedeutet, dass Sie das Logging-Framework ausw\u00e4hlen k\u00f6nnen, das Ihren Anforderungen am besten entspricht, oder bei der Standardeinstellung bleiben k\u00f6nnen.<\/p>\n\n\n\n

    Standard-Logging-Konfiguration<\/h3>\n\n\n\n

    Spring Boot stellt eine sinnvolle Standard-Logging-Konfiguration bereit, um Ihnen einen schnellen Einstieg zu erm\u00f6glichen. Standardm\u00e4\u00dfig verwendet es Logback<\/strong> als Logging-Framework. Die Standardkonfiguration finden Sie im Verzeichnis src\/main\/resources<\/code> Ihrer Spring-Boot-Anwendung unter dem Namen logback-spring.xml<\/code>.<\/p>\n\n\n\n

    Hier ist ein einfaches Beispiel f\u00fcr eine Standard-logback-spring.xml<\/code>:<\/p>\n\n\n

    <configuration<\/span>><\/span>\n    <include<\/span> resource<\/span>=\"org\/springframework\/boot\/logging\/logback\/defaults.xml\"<\/span> \/><\/span>\n    <property<\/span> name<\/span>=\"LOG_FILE\"<\/span> value<\/span>=\"logs\/myapp.log\"<\/span> \/><\/span>\n    <include<\/span> resource<\/span>=\"org\/springframework\/boot\/logging\/logback\/console-appender.xml\"<\/span> \/><\/span>\n    <root<\/span> level<\/span>=\"INFO\"<\/span>><\/span>\n        <appender-ref<\/span> ref<\/span>=\"CONSOLE\"<\/span> \/><\/span>\n        <appender-ref<\/span> ref<\/span>=\"FILE\"<\/span> \/><\/span>\n    <\/root<\/span>><\/span>\n<\/configuration<\/span>><\/span><\/code><\/span>Code-Sprache:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
    In dieser Konfiguration werden Logs sowohl in die Konsole als auch in eine Datei mit dem Namen myapp.log<\/code> geschrieben.<\/p>\n\n\n\n
    Logging-Ebenen<\/h3>\n\n\n\n
    Das Logging in Spring Boot folgt einer Hierarchie von Logging-Ebenen<\/strong>, die die Schwere einer Lognachricht anzeigen. Die gebr\u00e4uchlichen Logging-Ebenen sind (in aufsteigender Reihenfolge der Schwere):<\/p>\n\n\n\n
      \n
    • TRACE<\/strong>: Die detailliertesten Informationen, die in der Regel f\u00fcr die Fehlersuche verwendet werden.<\/li>\n\n\n\n
    • DEBUG<\/strong>: Detaillierte Informationen, n\u00fctzlich zur Diagnose von Problemen.<\/li>\n\n\n\n
    • INFO<\/strong>: Informationelle Nachrichten, die best\u00e4tigen, dass alles wie erwartet funktioniert.<\/li>\n\n\n\n
    • WARN<\/strong>: Weist auf potenzielle Probleme hin, die Aufmerksamkeit erfordern k\u00f6nnen.<\/li>\n\n\n\n
    • ERROR<\/strong>: Deutet auf ernsthafte Probleme hin, die sofortige Aufmerksamkeit erfordern.<\/li>\n\n\n\n
    • FATAL<\/strong>: Die schwerwiegendste Ebene, die auf einen kritischen Fehler hinweist, der zum Herunterfahren der Anwendung f\u00fchren kann.<\/li>\n<\/ul>\n\n\n\n
      Sie k\u00f6nnen die Logging-Ebene f\u00fcr verschiedene Teile Ihrer Anwendung konfigurieren, um die Detailtiefe in Ihren Logs zu steuern.<\/p>\n\n\n\n
      Logging in Spring Boot-Anwendungen<\/h3>\n\n\n\n
      Spring Boot bietet verschiedene M\u00f6glichkeiten, um das Logging in Ihrer Anwendung durchzuf\u00fchren:<\/p>\n\n\n\n
      1. Verwenden des Logger<\/code>-Interfaces von Spring<\/h4>\n\n\n\n
      Sie k\u00f6nnen das Logger<\/code>-Interface aus dem Paket org.slf4j<\/code> verwenden, um in Ihren Klassen zu loggen. Hier ist ein Beispiel:<\/p>\n\n\n
      import<\/span> org.slf4j.Logger;\nimport<\/span> org.slf4j.LoggerFactory;\n\npublic class<\/span> MeinService<\/span> <\/span>{\n    private static<\/span> final Logger logger = LoggerFactory.getLogger(MeinService.class);\n\n    public void<\/span> etwasTun() {\n        logger.debug(\"Mache etwas...\"<\/span>);\n        \/\/ Ihr Code hier<\/span>\n    }\n}<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      2. Verwenden der @Slf4j<\/code>-Annotation von Spring<\/h4>\n\n\n\n
      Sie k\u00f6nnen das Logging in Ihren Klassen mit der @Slf4j<\/code>-Annotation vereinfachen, die automatisch ein Logger<\/code>-Feld f\u00fcr Sie generiert:<\/p>\n\n\n
      import<\/span> lombok.extern.slf4j.Slf4j;\n\n@Slf4j\npublic class<\/span> MeinService<\/span> <\/span>{\n    public void<\/span> etwasTun() {\n        log.debug(\"Mache etwas...\"<\/span>);\n        \/\/ Ihr Code hier<\/span>\n    }\n}<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      3. Logging in Spring Beans<\/h4>\n\n\n\n
      Sie k\u00f6nnen die Spring-@Log<\/code>-Annotation verwenden, um das Logging f\u00fcr Spring-Beans zu aktivieren. F\u00fcgen Sie die @Log<\/code>-Annotation Ihrer Bean-Klasse hinzu, um das Logging f\u00fcr alle Methoden dieser Klasse zu aktivieren:<\/p>\n\n\n
      import<\/span> org.springframework.stereotype.Service;\nimport<\/span> org.springframework.boot.logging.Log;\nimport<\/span> lombok.extern.slf4j.Slf4j;\n\n@Service\n@Log\npublic class<\/span> MeinService<\/span> <\/span>{\n    public void<\/span> etwasTun() {\n        \/\/ Das Logging ist automatisch f\u00fcr diese Methode aktiviert<\/span>\n        \/\/ Ihr Code hier<\/span>\n    }\n}<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      Anpassen der Logging-Konfiguration<\/h3>\n\n\n\n
      Obwohl Spring Boot sinnvolle Standards bereitstellt, m\u00fcssen Sie m\u00f6glicherweise die Logging-Konfiguration an Ihre speziellen Anforderungen anpassen. Dies k\u00f6nnen Sie durch \u00c4ndern der Datei logback-spring.xml<\/code> oder Verwenden von Eigenschaften in den Dateien application.properties<\/code> oder application.yml<\/code> erreichen.<\/p>\n\n\n\n
      Verwenden von application.properties<\/code><\/h4>\n\n\n\n
      Sie k\u00f6nnen Logging-Eigenschaften in der Datei application.properties<\/code> konfigurieren:<\/p>\n\n\n
      # Setzen der Log-Ebene f\u00fcr den Root-Logger<\/span>\nlogging.level.root=INFO\n\n# Konfigurieren des Log-Dateinamens und -speicherorts<\/span>\nlogging.file=myapp.log\n\n# Konfigurieren des Log-Musters<\/span>\nlogging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} %-5<\/span>level %logger{36<\/span>} - %msg%n<\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
      Verwenden von application.yml<\/code><\/h4>\n\n\n\n
      Alternativ k\u00f6nnen Sie die Datei application.yml<\/code> f\u00fcr die Konfiguration verwenden:<\/p>\n\n\n
      # Setzen der Log-Ebene f\u00fcr den Root-Logger<\/span>\nlogging:\n  level:\n    root: INFO\n\n# Konfigurieren des Log-Dateinamens und -speicherorts<\/span>\nlogging:\n  file: myapp.log\n\n# Konfigurieren des<\/span>\n\n Log-Musters\nlogging:\n  pattern:\n    console: \"%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n\"<\/span><\/code><\/span>Code-Sprache:<\/span> PHP<\/span> (<\/span>php<\/span>)<\/span><\/small><\/pre>\n\n\n
      Programmatische Konfiguration des Loggings<\/h4>\n\n\n\n
      Wenn Sie eine dynamischere Kontrolle \u00fcber die Logging-Konfiguration ben\u00f6tigen, k\u00f6nnen Sie diese in Ihrer Spring-Boot-Anwendungsklasse programmatisch konfigurieren:<\/p>\n\n\n
      import<\/span> org.springframework.boot.SpringApplication;\nimport<\/span> org.springframework.boot.autoconfigure.SpringBootApplication;\nimport<\/span> org.springframework.boot.logging.LogLevel;\nimport<\/span> org.springframework.boot.logging.LoggingSystem;\nimport<\/span> org.springframework.context.ApplicationContext;\nimport<\/span> org.springframework.context.annotation.Bean;\n\n@SpringBootApplication\npublic class<\/span> MeineAnwendung<\/span> <\/span>{\n\n    public static<\/span> void<\/span> main(String<\/span>[] args) {\n        ApplicationContext context = SpringApplication.run(MeineAnwendung.class, args);\n\n        \/\/ Programmatische \u00c4nderung der Log-Ebene<\/span>\n        LoggingSystem.get(context.getClassLoader()).setLogLevel(\"com.example.meineklasse\"<\/span>, LogLevel.DEBUG);\n    }\n}<\/code><\/span>Code-Sprache:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
      Logging an verschiedene Ausgaben<\/h3>\n\n\n\n
      Spring Boot erm\u00f6glicht es Ihnen, Logs an verschiedene Ausgaben wie Konsole, Dateien oder entfernte Server zu leiten. Hier sind einige g\u00e4ngige Szenarien:<\/p>\n\n\n\n
      Konsole-Logging<\/h4>\n\n\n\n
      Das Konsole-Logging ist in Spring Boot standardm\u00e4\u00dfig aktiviert. Sie k\u00f6nnen das Format des Konsolenlogs anpassen, indem Sie die Eigenschaft logging.pattern.console<\/code> in Ihrer Konfigurationsdatei \u00e4ndern, wie bereits zuvor gezeigt.<\/p>\n\n\n\n
      Datei-Logging<\/h4>\n\n\n\n
      Sie k\u00f6nnen Spring Boot so konfigurieren, dass Logs in Dateien geschrieben werden, indem Sie die Eigenschaft logging.file<\/code> in Ihrer Konfigurationsdatei festlegen. Standardm\u00e4\u00dfig werden Logs im Arbeitsverzeichnis der Anwendung geschrieben, aber Sie k\u00f6nnen einen absoluten Pfad oder einen relativen Pfad angeben.<\/p>\n\n\n
      logging.file=myapp.log<\/code><\/span><\/pre>\n\n\n
      Rolling File Appenders<\/h4>\n\n\n\n
      Um zu verhindern, dass Logdateien unbegrenzt wachsen, k\u00f6nnen Sie Rolling File Appenders konfigurieren. Die Standardkonfiguration von Spring Boot logback-spring.xml<\/code> enth\u00e4lt einen FILE<\/code>-Appender, der Logdateien bei Erreichen einer bestimmten Gr\u00f6\u00dfe oder eines bestimmten Datums neu startet. Sie k\u00f6nnen dieses Verhalten nach Bedarf anpassen.<\/p>\n\n\n\n
      Remote Logging<\/h4>\n\n\n\n
      In Produktionsumgebungen m\u00f6chten Sie m\u00f6glicherweise Logs an einen zentralen Logserver oder -dienst senden. Spring Boot unterst\u00fctzt das Remote Logging mit verschiedenen Appenders wie Logstash, Elasticsearch oder Splunk. Sie k\u00f6nnen diese Appender konfigurieren, um Logdaten an das gew\u00fcnschte entfernte Ziel zu senden.<\/p>\n\n\n\n
      Verwendung von Drittanbieter-Logging-Bibliotheken<\/h3>\n\n\n\n
      Obwohl Spring Boot eine integrierte L\u00f6sung f\u00fcr das Logging bietet, k\u00f6nnen Sie auch Drittanbieter-Logging-Bibliotheken wie Log4j2 oder Logback integrieren, die erweiterte Funktionen und Anpassungsm\u00f6glichkeiten bieten.<\/p>\n\n\n\n
      Verwenden von Log4j2<\/h4>\n\n\n\n
      Um Log4j2 in Ihrer Spring Boot-Anwendung zu verwenden, f\u00fcgen Sie die Log4j2-Abh\u00e4ngigkeiten zur pom.xml<\/code> Ihres Projekts hinzu:<\/p>\n\n\n
      <dependency<\/span>><\/span>\n    <groupId<\/span>><\/span>org.springframework.boot<\/groupId<\/span>><\/span>\n    <artifactId<\/span>><\/span>spring-boot-starter-log4j2<\/artifactId<\/span>><\/span>\n<\/dependency<\/span>><\/span><\/code><\/span>Code-Sprache:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
      Konfigurieren Sie dann Log4j2, indem Sie eine Datei log4j2.xml<\/code> im Verzeichnis src\/main\/resources<\/code> erstellen. Spring Boot erkennt und verwendet diese Konfiguration automatisch.<\/p>\n\n\n\n
      Verwenden von Logback<\/h4>\n\n\n\n
      Um Logback in Ihrer Spring Boot-Anwendung zu verwenden, f\u00fcgen Sie die Logback-Abh\u00e4ngigkeiten zur pom.xml<\/code> Ihres Projekts hinzu:<\/p>\n\n\n
      <dependency<\/span>><\/span>\n    <groupId<\/span>><\/span>org.springframework.boot<\/groupId<\/span>><\/span>\n    <artifactId<\/span>><\/span>spring-boot-starter<\/artifactId<\/span>><\/span>\n<\/dependency<\/span>><\/span>\n<dependency<\/span>><\/span>\n    <groupId<\/span>><\/span>ch.qos.logback<\/groupId<\/span>><\/span>\n    <artifactId<\/span>><\/span>logback-classic<\/artifactId<\/span>><\/span>\n<\/dependency<\/span>><\/span><\/code><\/span>Code-Sprache:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\n
      Anschlie\u00dfend k\u00f6nnen Sie die Konfigurationsdatei logback-spring.xml<\/code> nach Bedarf anpassen.<\/p>\n\n\n\n
      Bew\u00e4hrte Praktiken f\u00fcr das Logging in Spring Boot<\/h3>\n\n\n\n
      Um ein effektives Logging in Ihrer Spring Boot-Anwendung sicherzustellen, sollten Sie die folgenden bew\u00e4hrten Praktiken beachten:<\/p>\n\n\n\n
        \n
      1. Verwenden Sie geeignete Logging-Ebenen<\/strong>: Verwenden Sie die geeignete Logging-Ebene f\u00fcr jede Lognachricht. Vermeiden Sie \u00fcberm\u00e4\u00dfiges Logging auf niedrigeren Ebenen (z. B. DEBUG) in der Produktionsumgebung.<\/li>\n\n\n\n
      2. Loggen von Ausnahmestapeln<\/strong>: Beim Abfangen von Ausnahmen sollten Sie immer den Stapeltrace protokollieren. Dies erleichtert die Diagnose von Problemen erheblich.<\/li>\n\n\n\n
      3. Parameterisiertes Logging<\/strong>: Verwenden Sie parameterisiertes Logging, um den Aufwand f\u00fcr die Erstellung von Lognachrichten zu reduzieren, wenn die Logging-Ebene nicht aktiviert ist. Verwenden Sie z. B. log.debug(\"Bearbeite Anfrage f\u00fcr Benutzer: {}\", benutzername)<\/code> anstelle der Zeichenkettenverkettung.<\/li>\n\n\n\n
      4. Loggen von aussagekr\u00e4ftigen Nachrichten<\/strong>: Stellen Sie sicher, dass Lognachrichten klar sind und ausreichend Kontext bieten, um das Verhalten der Anwendung zu verstehen.<\/li>\n\n\n\n
      5. Rotation und Archivierung von Logs<\/strong>: Konfigurieren Sie die Rotation und Archivierung von Logs, um zu verhindern, dass Logdateien zu gro\u00df werden.<\/li>\n\n\n\n
      6. Zentrales Logging<\/strong>: In verteilten Systemen sollten Sie zentrale Logging-L\u00f6sungen wie Elasticsearch, Logstash und Kibana (ELK-Stack) oder Splunk in Betracht ziehen, um eine bessere Verwaltung von Logs zu erm\u00f6glichen.<\/li>\n\n\n\n
      7. Sicherheit und sensible Informationen<\/strong>: Seien Sie vorsichtig beim Protokollieren sensibler Informationen wie Passw\u00f6rter oder API-Schl\u00fcssel. Verwenden Sie immer Logmaskierung oder Verschl\u00fcsselungstechniken, um sensible Daten zu sch\u00fctzen.<\/li>\n\n\n\n
      8. \u00dcberwachung und Benachrichtigung<\/strong>: Richten Sie die \u00dcberwachung und Benachrichtigung von Logs ein, um \u00fcber kritische Probleme sofort informiert zu werden, wenn sie in der Produktion auftreten.<\/li>\n\n\n\n
      9. Testen der Logging-Konfiguration<\/strong>: \u00dcberpr\u00fcfen Sie, ob Ihre Logging-Konfiguration in verschiedenen Umgebungen, einschlie\u00dflich produktions\u00e4hnlicher Konfigurationen, wie erwartet funktioniert.<\/li>\n\n\n\n
      10. Dokumentation<\/strong>: Dokumentieren Sie Ihre Logging-Praktiken und Konventionen, um eine konsistente Verwendung im Entwicklungsteam sicherzustellen.<\/li>\n<\/ol>\n","protected":false},"excerpt":{"rendered":"
        Logging ist ein entscheidender Aspekt der Softwareentwicklung und wird oft vernachl\u00e4ssigt, bis Probleme in Produktionsumgebungen auftreten. Spring Boot, ein beliebtes Framework zur Entwicklung von Java-Anwendungen, bietet von Haus aus robuste Logging-Funktionen. In diesem Artikel werden wir das Logging in Spring Boot erkunden und die Grundlagen, Konfiguration, g\u00e4ngige Bibliotheken und bew\u00e4hrte Praktiken behandeln. Warum Logging wichtig […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5],"tags":[],"class_list":["post-138","post","type-post","status-publish","format-standard","hentry","category-spring"],"_links":{"self":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/138","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=138"}],"version-history":[{"count":1,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/138\/revisions"}],"predecessor-version":[{"id":139,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/138\/revisions\/139"}],"wp:attachment":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=138"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=138"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=138"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}