Skip to content

Commit 46a0ae4

Browse files
authored
Merge pull request #5942 from getsentry/feat/logs-opt-in-jul
feat(jul): [Logs and Metrics Enable Flags 3] Add Logs opt-in
2 parents 15f4197 + 9285b4c commit 46a0ae4

6 files changed

Lines changed: 89 additions & 2 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
### Features
66

7+
- Add an explicit Logs opt-in to the JUL handler ([#5942](https://github.com/getsentry/sentry-java/pull/5942))
78
- Add an explicit Logs opt-in to the Log4j2 appender ([#5941](https://github.com/getsentry/sentry-java/pull/5941))
89
- Add an explicit Logs opt-in to the Logback appender ([#5940](https://github.com/getsentry/sentry-java/pull/5940))
910
- Deprecate `sendDefaultPii` in favor of `dataCollection` ahead of its removal in 9.0 ([#6158](https://github.com/getsentry/sentry-java/pull/6158))

‎sentry-jul/api/sentry-jul.api‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,10 @@ public class io/sentry/jul/SentryHandler : java/util/logging/Handler {
1515
public fun getMinimumBreadcrumbLevel ()Ljava/util/logging/Level;
1616
public fun getMinimumEventLevel ()Ljava/util/logging/Level;
1717
public fun getMinimumLevel ()Ljava/util/logging/Level;
18+
public fun isEnableLogs ()Z
1819
public fun isPrintfStyle ()Z
1920
public fun publish (Ljava/util/logging/LogRecord;)V
21+
public fun setEnableLogs (Z)V
2022
public fun setMinimumBreadcrumbLevel (Ljava/util/logging/Level;)V
2123
public fun setMinimumEventLevel (Ljava/util/logging/Level;)V
2224
public fun setMinimumLevel (Ljava/util/logging/Level;)V

‎sentry-jul/src/main/java/io/sentry/jul/SentryHandler.java‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ public class SentryHandler extends Handler {
5353
*/
5454
private boolean printfStyle;
5555

56+
private boolean enableLogs;
57+
5658
private @NotNull Level minimumBreadcrumbLevel = Level.INFO;
5759
private @NotNull Level minimumEventLevel = Level.SEVERE;
5860
private @NotNull Level minimumLevel = Level.INFO;
@@ -112,7 +114,8 @@ public void publish(final @NotNull LogRecord record) {
112114
return;
113115
}
114116
try {
115-
if (ScopesAdapter.getInstance().getOptions().getLogs().isEnabled()
117+
if (enableLogs
118+
&& ScopesAdapter.getInstance().getOptions().getLogs().isEnabled()
116119
&& record.getLevel().intValue() >= minimumLevel.intValue()) {
117120
captureLog(record);
118121
}
@@ -191,6 +194,7 @@ private void retrieveProperties() {
191194
final LogManager manager = LogManager.getLogManager();
192195
final String className = SentryHandler.class.getName();
193196
setPrintfStyle(Boolean.parseBoolean(manager.getProperty(className + ".printfStyle")));
197+
setEnableLogs(Boolean.parseBoolean(manager.getProperty(className + ".enableLogs")));
194198
setLevel(parseLevelOrDefault(manager.getProperty(className + ".level")));
195199
final String minimumBreadCrumbLevel =
196200
manager.getProperty(className + ".minimumBreadcrumbLevel");
@@ -390,6 +394,14 @@ public void setPrintfStyle(final boolean printfStyle) {
390394
this.printfStyle = printfStyle;
391395
}
392396

397+
public void setEnableLogs(final boolean enableLogs) {
398+
this.enableLogs = enableLogs;
399+
}
400+
401+
public boolean isEnableLogs() {
402+
return enableLogs;
403+
}
404+
393405
public void setMinimumBreadcrumbLevel(final @Nullable Level minimumBreadcrumbLevel) {
394406
if (minimumBreadcrumbLevel != null) {
395407
this.minimumBreadcrumbLevel = minimumBreadcrumbLevel;

‎sentry-jul/src/test/kotlin/io/sentry/jul/SentryHandlerTest.kt‎

Lines changed: 71 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ import kotlin.test.assertNull
2828
import kotlin.test.assertTrue
2929
import org.mockito.kotlin.anyOrNull
3030
import org.mockito.kotlin.mock
31+
import org.mockito.kotlin.never
3132
import org.mockito.kotlin.verify
3233
import org.slf4j.MDC
3334

@@ -40,6 +41,8 @@ class SentryHandlerTest {
4041
val transport: ITransport = mock(),
4142
contextTags: List<String>? = null,
4243
printfStyle: Boolean? = null,
44+
enableLogs: Boolean? = true,
45+
enableGlobalLogs: Boolean = true,
4346
) {
4447
var logger: Logger
4548
var handler: SentryHandler
@@ -48,6 +51,7 @@ class SentryHandlerTest {
4851
val options = SentryOptions()
4952
options.dsn = "http://key@localhost/proj"
5053
options.setTransportFactory { _, _ -> transport }
54+
options.logs.isEnabled = enableGlobalLogs
5155
options.logs.loggerBatchProcessorFactory = ILoggerBatchProcessorFactory { options, client ->
5256
LoggerBatchProcessor(options, client, ImmediateExecutorService())
5357
}
@@ -58,6 +62,9 @@ class SentryHandlerTest {
5862
handler.setMinimumBreadcrumbLevel(minimumBreadcrumbLevel)
5963
handler.setMinimumEventLevel(minimumEventLevel)
6064
handler.setMinimumLevel(minimumLevel)
65+
if (enableLogs != null) {
66+
handler.setEnableLogs(enableLogs)
67+
}
6168
if (printfStyle == true) {
6269
handler.setPrintfStyle(printfStyle)
6370
}
@@ -318,11 +325,22 @@ class SentryHandlerTest {
318325

319326
@Test
320327
fun `fetches configuration from logging dot properties`() {
321-
fixture = Fixture(configureWithLogManager = true)
328+
fixture = Fixture(configureWithLogManager = true, enableLogs = null)
322329
assertEquals(Level.CONFIG, fixture.handler.minimumBreadcrumbLevel)
323330
assertEquals(Level.WARNING, fixture.handler.minimumEventLevel)
324331
assertEquals(Level.ALL, fixture.handler.level)
325332
assertTrue(fixture.handler.isPrintfStyle)
333+
assertTrue(fixture.handler.isEnableLogs)
334+
335+
fixture.logger.info("this should be captured as a log")
336+
Sentry.flush(10)
337+
338+
verify(fixture.transport)
339+
.send(
340+
checkLogs { logs ->
341+
assertEquals("this should be captured as a log", logs.items.first().body)
342+
}
343+
)
326344
}
327345

328346
@Test
@@ -418,6 +436,58 @@ class SentryHandlerTest {
418436
)
419437
}
420438

439+
@Test
440+
fun `does not capture logs by default`() {
441+
fixture = Fixture(enableLogs = null, enableGlobalLogs = true)
442+
443+
assertFalse(fixture.handler.isEnableLogs)
444+
fixture.logger.info("this should not be captured as a log")
445+
Sentry.flush(10)
446+
447+
verify(fixture.transport, never()).send(checkLogs {})
448+
}
449+
450+
@Test
451+
fun `captures logs when enabled through Java`() {
452+
fixture = Fixture(enableLogs = true, enableGlobalLogs = true)
453+
454+
assertTrue(fixture.handler.isEnableLogs)
455+
fixture.logger.info("this should be captured as a log")
456+
Sentry.flush(10)
457+
458+
verify(fixture.transport)
459+
.send(
460+
checkLogs { logs ->
461+
assertEquals("this should be captured as a log", logs.items.first().body)
462+
}
463+
)
464+
}
465+
466+
@Test
467+
fun `captures events and breadcrumbs when logs are disabled`() {
468+
fixture =
469+
Fixture(
470+
minimumBreadcrumbLevel = Level.INFO,
471+
minimumEventLevel = Level.SEVERE,
472+
enableLogs = false,
473+
enableGlobalLogs = true,
474+
)
475+
476+
fixture.logger.info("this should be a breadcrumb")
477+
fixture.logger.severe("this should be an event")
478+
Sentry.flush(10)
479+
480+
verify(fixture.transport)
481+
.send(
482+
checkEvent { event ->
483+
assertEquals("this should be an event", event.message?.message)
484+
assertEquals("this should be a breadcrumb", event.breadcrumbs?.single()?.message)
485+
},
486+
anyOrNull(),
487+
)
488+
verify(fixture.transport, never()).send(checkLogs {})
489+
}
490+
421491
@Test
422492
fun `converts finest log level to Sentry log level`() {
423493
fixture = Fixture(minimumLevel = Level.FINEST)

‎sentry-jul/src/test/resources/logging.properties‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@ io.sentry.jul.SentryHandler.minimumEventLevel=WARNING
33
io.sentry.jul.SentryHandler.minimumBreadcrumbLevel=CONFIG
44
io.sentry.jul.SentryHandler.minimumLevel=CONFIG
55
io.sentry.jul.SentryHandler.printfStyle=true
6+
io.sentry.jul.SentryHandler.enableLogs=true
67

78
jul.SentryHandlerTest.handlers=java.util.logging.ConsoleHandler, io.sentry.jul.SentryHandler

‎sentry-samples/sentry-samples-jul/src/main/resources/logging.properties‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ io.sentry.jul.SentryHandler.minimumEventLevel=INFO
22
io.sentry.jul.SentryHandler.minimumBreadcrumbLevel=CONFIG
33
io.sentry.jul.SentryHandler.minimumLevel=INFO
44
io.sentry.jul.SentryHandler.printfStyle=true
5+
io.sentry.jul.SentryHandler.enableLogs=true
56
io.sentry.jul.SentryHandler.level=FINEST
67
java.util.logging.ConsoleHandler.level = FINE
78
handlers=io.sentry.jul.SentryHandler

0 commit comments

Comments
 (0)