How do I obfuscate sensitive data like passwords in HTTP logs with Logbook?

Use Logbook's built-in filters such as BodyFilters and QueryFilters. For example, configure JSON path filters to replace fields like 'password' or set up header filters to mask Authorization tokens, as described in the Filtering section.

Logbook vs logback-access: which is better for HTTP logging in Java?

Logbook is more flexible, supporting both client and server-side logging across multiple frameworks with customizable formats, while logback-access is server-side only and tied to servlet containers. Choose Logbook for comprehensive, cross-framework needs.

How to integrate Logbook with Spring Boot for automatic configuration?

Add the logbook-spring-boot-starter dependency and adjust properties in application.yml. Logbook auto-configures filters and formatters, but you can override defaults via beans or configuration properties like logbook.format.style.

Does Logbook support logging HTTP client requests in OkHttp 3?

Yes, Logbook has a dedicated logbook-okhttp module. You need to add the dependency and register the LogbookInterceptor in your OkHttpClient builder, as shown in the OkHttp v3.x usage examples.

How can I exclude health check endpoints from being logged to reduce noise?

Use conditions in the Logbook builder with predicates to exclude specific paths, such as requestTo('/health'). This is configurable via the logbook.predicate.exclude property in Spring Boot setups.

What are the performance implications of enabling full HTTP body logging?

Full body logging can increase I/O and memory usage. Logbook provides strategies like BodyOnlyIfStatusAtLeastStrategy to log bodies only for certain status codes (e.g., errors), helping balance detail with performance overhead.

Logbook — Java HTTP Logging Library

What is Logbook?

Logbook is an extensible Java library that enables complete HTTP request and response logging for different client- and server-side technologies. It allows developers to log any HTTP traffic an application receives or sends in a way that facilitates persistence and analysis for log analysis, audit compliance, or traffic investigation.

Target Audience

Java developers building web applications or HTTP-based services who need detailed, customizable logging of HTTP traffic for debugging, monitoring, or compliance purposes.

Value Proposition

Developers choose Logbook for its extensibility, wide framework support (Servlet, Spring, Apache HTTP Client, OkHttp, etc.), and powerful filtering and formatting options that go beyond basic logging to handle sensitive data and production needs.

An extensible Java library for HTTP request and response logging

Use Cases

Best For

Adding detailed HTTP traffic logging to Spring Boot applications
Logging HTTP requests and responses in microservices for audit trails
Debugging HTTP client interactions in Java applications
Obfuscating sensitive data (like tokens or passwords) in HTTP logs
Integrating HTTP logging with structured logging systems like Logstash
Customizing log output format (JSON, cURL, CLF) for different environments

Not Ideal For

Applications running on Java versions below 17, as Logbook mandates Java 17 or higher for compatibility with modern frameworks like Spring Boot 4.
Projects where HTTP logging is delegated to infrastructure layers like API gateways or service meshes, making application-level logging redundant.
Teams seeking plug-and-play logging with zero code changes; Logbook requires integration via filters or interceptors, even with Spring Boot auto-configuration.
Servlet-based applications that extensively use getParameter*() methods, due to known interference issues with Logbook's filter as noted in the Known Issues section.

Pros & Cons

Pros

Complete HTTP Logging

Logs both requests and responses including bodies, with partial logging for unauthorized requests, enabling detailed audit trails and debugging as per the Features section.

Extensible Framework Support

Supports a wide range of Java frameworks like Servlet, Apache HTTP Client, OkHttp, JAX-RS, Netty, Ktor, and Spring via modular integrations, making it highly versatile.

Advanced Data Obfuscation

Provides built-in filters to obfuscate sensitive data in headers, query parameters, and JSON fields, with customizable rules for compliance, including experimental JsonPath filtering.

Multiple Output Formats

Offers various formats such as JSON, HTTP, cURL, Splunk, CLF, and ELF, allowing logs to be tailored for machine readability or human consumption in different environments.

Spring Boot Auto-Configuration

Includes a Spring Boot starter for zero-configuration setup with sensible defaults, simplifying integration and reducing boilerplate code for Spring applications.

Cons

Servlet Filter Limitations

Interferes with downstream code using getWriter and getParameter*() methods and does not support ERROR dispatch, as highlighted in the Known Issues, which can break existing functionality.

Java Version Constraint

Requires Java 17 or higher, which may exclude legacy projects or teams stuck on older Java versions, limiting adoption in certain environments.

Configuration Complexity

Manual setup for non-Spring frameworks involves detailed builder patterns and multiple dependencies, increasing initial effort despite the extensibility praised in the README.

Performance Overhead

Logging all HTTP traffic, especially with body content, can introduce significant latency and resource consumption, necessitating careful strategy selection to mitigate impact.

Frequently Asked Questions

What is Logbook?

Target Audience

Java developers building web applications or HTTP-based services who need detailed, customizable logging of HTTP traffic for debugging, monitoring, or compliance purposes.

Value Proposition

Use Cases

Best For

Adding detailed HTTP traffic logging to Spring Boot applications
Logging HTTP requests and responses in microservices for audit trails
Debugging HTTP client interactions in Java applications
Obfuscating sensitive data (like tokens or passwords) in HTTP logs
Integrating HTTP logging with structured logging systems like Logstash
Customizing log output format (JSON, cURL, CLF) for different environments

Not Ideal For

Applications running on Java versions below 17, as Logbook mandates Java 17 or higher for compatibility with modern frameworks like Spring Boot 4.
Projects where HTTP logging is delegated to infrastructure layers like API gateways or service meshes, making application-level logging redundant.
Teams seeking plug-and-play logging with zero code changes; Logbook requires integration via filters or interceptors, even with Spring Boot auto-configuration.
Servlet-based applications that extensively use getParameter*() methods, due to known interference issues with Logbook's filter as noted in the Known Issues section.

Pros & Cons

Pros

Complete HTTP Logging

Logs both requests and responses including bodies, with partial logging for unauthorized requests, enabling detailed audit trails and debugging as per the Features section.

Extensible Framework Support

Supports a wide range of Java frameworks like Servlet, Apache HTTP Client, OkHttp, JAX-RS, Netty, Ktor, and Spring via modular integrations, making it highly versatile.

Advanced Data Obfuscation

Provides built-in filters to obfuscate sensitive data in headers, query parameters, and JSON fields, with customizable rules for compliance, including experimental JsonPath filtering.

Multiple Output Formats

Offers various formats such as JSON, HTTP, cURL, Splunk, CLF, and ELF, allowing logs to be tailored for machine readability or human consumption in different environments.

Spring Boot Auto-Configuration

Includes a Spring Boot starter for zero-configuration setup with sensible defaults, simplifying integration and reducing boilerplate code for Spring applications.

Cons

Servlet Filter Limitations

Interferes with downstream code using getWriter and getParameter*() methods and does not support ERROR dispatch, as highlighted in the Known Issues, which can break existing functionality.

Java Version Constraint

Requires Java 17 or higher, which may exclude legacy projects or teams stuck on older Java versions, limiting adoption in certain environments.

Configuration Complexity

Manual setup for non-Spring frameworks involves detailed builder patterns and multiple dependencies, increasing initial effort despite the extensibility praised in the README.

Performance Overhead

Logging all HTTP traffic, especially with body content, can introduce significant latency and resource consumption, necessitating careful strategy selection to mitigate impact.

Frequently Asked Questions

Logbook

What is Logbook?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

Logbook

What is Logbook?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?