Skip to content

Commit dc0c03f

Browse files
authored
Merge pull request #5960 from getsentry/fix/jul-null-log-message
fix(jul): [Logs and Metrics Enable Flags 11] Preserve null-message records
2 parents 1f9fc8a + 1a948e4 commit dc0c03f

2 files changed

Lines changed: 78 additions & 8 deletions

File tree

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

Lines changed: 17 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
import java.util.Date;
2929
import java.util.List;
3030
import java.util.Map;
31+
import java.util.ResourceBundle;
3132
import java.util.logging.ErrorManager;
3233
import java.util.logging.Filter;
3334
import java.util.logging.Handler;
@@ -150,10 +151,15 @@ protected void captureLog(@NotNull LogRecord loggingEvent) {
150151
final @Nullable Object[] arguments = loggingEvent.getParameters();
151152
final @NotNull SentryAttributes attributes = SentryAttributes.of();
152153

153-
@NotNull String message = loggingEvent.getMessage();
154+
final @Nullable String messageTemplate = loggingEvent.getMessage();
155+
if (messageTemplate == null) {
156+
return;
157+
}
158+
159+
@NotNull String message = messageTemplate;
154160
if (loggingEvent.getResourceBundle() != null
155-
&& loggingEvent.getResourceBundle().containsKey(loggingEvent.getMessage())) {
156-
message = loggingEvent.getResourceBundle().getString(loggingEvent.getMessage());
161+
&& loggingEvent.getResourceBundle().containsKey(messageTemplate)) {
162+
message = loggingEvent.getResourceBundle().getString(messageTemplate);
157163
}
158164

159165
final @NotNull String formattedMessage = maybeFormatted(arguments, message);
@@ -290,13 +296,16 @@ SentryEvent createEvent(final @NotNull LogRecord record) {
290296
final Message sentryMessage = new Message();
291297
sentryMessage.setParams(toParams(record.getParameters()));
292298

293-
String message = record.getMessage();
294-
if (record.getResourceBundle() != null
295-
&& record.getResourceBundle().containsKey(record.getMessage())) {
296-
message = record.getResourceBundle().getString(record.getMessage());
299+
final @Nullable String messageTemplate = record.getMessage();
300+
final @Nullable ResourceBundle resourceBundle = record.getResourceBundle();
301+
@Nullable String message = messageTemplate;
302+
if (messageTemplate != null
303+
&& resourceBundle != null
304+
&& resourceBundle.containsKey(messageTemplate)) {
305+
message = resourceBundle.getString(messageTemplate);
297306
}
298307
sentryMessage.setMessage(message);
299-
if (record.getParameters() != null) {
308+
if (message != null && record.getParameters() != null) {
300309
try {
301310
sentryMessage.setFormatted(formatMessage(message, record.getParameters()));
302311
} catch (RuntimeException e) {

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

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ import io.sentry.transport.ITransport
1616
import java.time.Instant
1717
import java.time.LocalDateTime
1818
import java.time.ZoneId
19+
import java.util.ListResourceBundle
1920
import java.util.logging.Level
21+
import java.util.logging.LogRecord
2022
import java.util.logging.Logger
2123
import kotlin.test.AfterTest
2224
import kotlin.test.BeforeTest
@@ -485,6 +487,65 @@ class SentryHandlerTest {
485487
verify(fixture.transport, never()).send(checkLogs {})
486488
}
487489

490+
@Test
491+
fun `captures null message as event and breadcrumb when logs are enabled`() {
492+
fixture =
493+
Fixture(
494+
minimumBreadcrumbLevel = Level.INFO,
495+
minimumEventLevel = Level.SEVERE,
496+
enableLogs = true,
497+
)
498+
499+
fixture.logger.info(null as String?)
500+
fixture.logger.severe(null as String?)
501+
Sentry.flush(10)
502+
503+
verify(fixture.transport)
504+
.send(
505+
checkEvent { event ->
506+
assertNull(event.message?.message)
507+
assertEquals(1, event.breadcrumbs?.size)
508+
assertNull(event.breadcrumbs?.single()?.message)
509+
},
510+
anyOrNull(),
511+
)
512+
verify(fixture.transport, never()).send(checkLogs {})
513+
}
514+
515+
@Test
516+
fun `captures null message as event and breadcrumb when resource bundle is set`() {
517+
fixture =
518+
Fixture(
519+
minimumBreadcrumbLevel = Level.INFO,
520+
minimumEventLevel = Level.SEVERE,
521+
enableLogs = true,
522+
)
523+
val resourceBundle =
524+
object : ListResourceBundle() {
525+
override fun getContents(): Array<Array<Any>> =
526+
arrayOf(arrayOf<Any>("message", "localized message"))
527+
}
528+
529+
fixture.handler.publish(
530+
LogRecord(Level.INFO, null).apply { this.resourceBundle = resourceBundle }
531+
)
532+
fixture.handler.publish(
533+
LogRecord(Level.SEVERE, null).apply { this.resourceBundle = resourceBundle }
534+
)
535+
Sentry.flush(10)
536+
537+
verify(fixture.transport)
538+
.send(
539+
checkEvent { event ->
540+
assertNull(event.message?.message)
541+
assertEquals(1, event.breadcrumbs?.size)
542+
assertNull(event.breadcrumbs?.single()?.message)
543+
},
544+
anyOrNull(),
545+
)
546+
verify(fixture.transport, never()).send(checkLogs {})
547+
}
548+
488549
@Test
489550
fun `converts finest log level to Sentry log level`() {
490551
fixture = Fixture(minimumLevel = Level.FINEST)

0 commit comments

Comments
 (0)