Skip to content

Commit 2d93f42

Browse files
committed
Update README.md
Signed-off-by: Dmitry Sulman <[email protected]>
1 parent 0802b2f commit 2d93f42

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,15 @@
55
[![CodeQL](https://github.com/dmitrysulman/logback-access-reactor-netty/actions/workflows/codeql.yml/badge.svg)](https://github.com/dmitrysulman/logback-access-reactor-netty/actions/workflows/codeql.yml)
66
[![codecov](https://codecov.io/gh/dmitrysulman/logback-access-reactor-netty/graph/badge.svg?token=LOEJQ7K8Z7)](https://codecov.io/gh/dmitrysulman/logback-access-reactor-netty)
77

8-
A library that integrates Logback Access with Reactor Netty HTTP server, providing comprehensive access logging capabilities.
8+
A Java/Kotlin library that integrates Logback Access with Reactor Netty HTTP server, providing comprehensive access logging capabilities.
99

1010
## Overview
1111

12-
This library serves as a bridge between the Reactor Netty HTTP logging mechanism and the Logback Access library. It enables detailed HTTP access logging with configurable formats, filters, and appenders through Logback Access configuration.
12+
**Reactor Netty HTTP Server** is a non-blocking, asynchronous server built on the Netty networking framework and used as the default runtime for handling HTTP requests in Spring WebFlux. It enables reactive, event-driven processing of web requests, making it well-suited for scalable and high-throughput applications. In Spring Boot, it's automatically configured when building reactive applications with the `spring-boot-starter-webflux` dependency.
13+
14+
**Logback Access** is a module of the Logback logging framework that provides HTTP access logging capabilities, similar to those in servlet containers like Tomcat or Jetty. It allows logging of incoming HTTP requests and responses using customizable patterns and supports easy configuration through an XML file.
15+
16+
**Logback Access for Reactor Netty** library serves as a bridge between the Reactor Netty HTTP logging mechanism and the Logback Access library. It enables detailed HTTP access logging with configurable formats, filters, and appenders through Logback Access configuration.
1317

1418
## Features
1519

@@ -38,14 +42,14 @@ This library serves as a bridge between the Reactor Netty HTTP logging mechanism
3842
<dependency>
3943
<groupId>io.github.dmitrysulman</groupId>
4044
<artifactId>logback-access-reactor-netty</artifactId>
41-
<version>1.0.1</version>
45+
<version>1.0.2</version>
4246
</dependency>
4347
```
4448

4549
#### Gradle
4650

4751
```
48-
implementation("io.github.dmitrysulman:logback-access-reactor-netty:1.0.1")
52+
implementation("io.github.dmitrysulman:logback-access-reactor-netty:1.0.2")
4953
```
5054

5155
### Basic Setup
@@ -76,7 +80,7 @@ HttpServer.create()
7680

7781
The library can be configured in several ways:
7882

79-
1. **Default configuration** uses `logback-access.xml` file in the classpath.
83+
1. **Default configuration** uses `logback-access.xml` file on the classpath.
8084
2. **System property.** Set `-Dlogback.access.reactor.netty.config` property to specify configuration file location.
8185
3. **Programmatic configuration.** Provide configuration file filename or URL of the resource directly:
8286
```java
@@ -105,7 +109,6 @@ public class NettyAccessLogConfiguration {
105109
```
106110

107111
#### Kotlin
108-
109112
```kotlin
110113
@Configuration
111114
class NettyAccessLogConfiguration {
@@ -116,6 +119,7 @@ class NettyAccessLogConfiguration {
116119
}
117120
}
118121
```
122+
See [enableLogbackAccess()](https://dmitrysulman.github.io/logback-access-reactor-netty/logback-access-reactor-netty/io.github.dmitrysulman.logback.access.reactor.netty/enable-logback-access.html) extension function documentation.
119123

120124
## Documentation
121125

@@ -128,5 +132,5 @@ class NettyAccessLogConfiguration {
128132

129133
## See Also
130134

131-
- [Logback Access Documentation](https://logback.qos.ch/access.html)
132135
- [Reactor Netty HTTP Server Documentation](https://projectreactor.io/docs/netty/release/reference/http-server.html)
136+
- [Logback Access Documentation](https://logback.qos.ch/access.html)

0 commit comments

Comments
 (0)