Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Numichi authored Sep 11, 2022
1 parent f0fea33 commit eb54c77
Showing 1 changed file with 2 additions and 57 deletions.
59 changes: 2 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,60 +214,5 @@ fun main() {
}
```

## Reactor

```kotlin
class Example {
private val log = ReactiveLogger.builder()
.setLogger(org.slf4j.LoggerFactory.getLogger(this::class.java)) // Optional parameter [org.slf4j.Logger]
.setMDCContextKey("DEFAULT_REACTOR_CONTEXT_MDC_KEY") // Optional parameter, default from Configuration
.setScheduler(Schedulers.boundedElastic()) // Optional parameter, default from Configuration
.build()

fun foo(msg: String): Mono<Void> {
return Mono.just(msg)
.flatMap {
log.info(it) // result: Mono<ContextView> // MDC: { "key": "example" }
}
.contextWrite {
MDCContext.modifyContext(it) { mdc ->
mdc["key"] = "example"
}
}
.then()
}
}
```

## Coroutine

```kotlin
class Example {
private val customLog = CoroutineLogger.builder(CustomContext) { coroutineContext[it]?.customAttrWhatTypeIsContextView }
// same as below

private val log = CoroutineLogger.reactorBuilder() // reactorBuilder() alias builder(ReactorContext) { coroutineContext[it]?.context }
.setLogger(org.slf4j.LoggerFactory.getLogger(this::class.java)) // Optional parameter [org.slf4j.Logger]
// same as below

private val logK = CoroutineKLogger.reactorBuilder() // reactorBuilder() alias builder(ReactorContext) { coroutineContext[it]?.context }
.setLogger(io.github.numichi.reactive.logger.LoggerFactory.getKLogger(this::class.java)) // Optional parameter [mu.Logger]
.setMDCContextKey("DEFAULT_REACTOR_CONTEXT_MDC_KEY") // Optional parameter, default from Configuration
.setScheduler(Schedulers.boundedElastic()) // Optional parameter, default from Configuration
.build()

suspend fun foo(msg: String) {
val mdc = readMdc()
mdc["key"] = "example"
withMDCContext(mdc) {
customLog.info("bar") // suspended // MDC: { "key": "example" }
log.info("bar") // suspended // MDC: { "key": "example" }
logK.info { "bar" } // suspended // MDC: { "key": "example" }
}

customLog.info("bar") // suspended // MDC: {}
log.info("bar") // suspended // MDC: {}
logK.info { "bar" } // suspended // MDC: {}
}
}
```
## Use Logger
Rework description

0 comments on commit eb54c77

Please sign in to comment.