Skip to content

Commit 813fec5

Browse files
authored
Clarify behavior of logLevel with custom SLF4J bindings (#328)
Clarify that `logLevel` only has effect when `slf4j-simple` is used.
1 parent f93dd08 commit 813fec5

File tree

1 file changed

+8
-4
lines changed
  • library/src/main/kotlin/com/gabrielfeo/develocity/api

1 file changed

+8
-4
lines changed

library/src/main/kotlin/com/gabrielfeo/develocity/api/Config.kt

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,20 @@ import kotlin.time.Duration.Companion.days
1414
data class Config(
1515

1616
/**
17-
* Changes the default log level for library classes, such as the HTTP client. Default value, by order of
18-
* precedence:
17+
* Changes minimum log level for library classes, including the HTTP
18+
* client, **when using `slf4j-simple`** (bundled with the library). If
19+
* replacing SLF4J bindings, this setting has no effect, and log level
20+
* must be changed in the chosen logging framework.
21+
*
22+
* Default value, by order of precedence:
1923
*
2024
* - `DEVELOCITY_API_LOG_LEVEL` environment variable
2125
* - `org.slf4j.simpleLogger.defaultLogLevel` system property
2226
* - `"off"`
2327
*
24-
* Possible values:
28+
* SLF4J valid log levels and their usage by the library:
2529
*
26-
* - "off" (default)
30+
* - "off" (default, no logs)
2731
* - "error"
2832
* - "warn"
2933
* - "info"

0 commit comments

Comments
 (0)