Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Capture markers in log4j2 and logback appenders #1551

Merged
merged 2 commits into from
Jun 23, 2021
Merged

Capture markers in log4j2 and logback appenders #1551

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
912408b
Capture markers in logback and log4j2 appenders
anderscarling Jun 22, 2021
97eb5b8
Update CHANGELOG.md
marandaneto Jun 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Unreleased

* Feat: Capture logged marker in log4j2 and logback appenders (#1551)

## 5.1.0-beta.1

* Feat: Measure app start time (#1487)
Expand Down
4 changes: 4 additions & 0 deletions sentry-log4j2/src/main/java/io/sentry/log4j2/SentryAppender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,10 @@ public void append(final @NotNull LogEvent eventObject) {
event.setExtra("thread_name", loggingEvent.getThreadName());
}

if (loggingEvent.getMarker() != null) {
event.setExtra("marker", loggingEvent.getMarker().toString());
}

final Map<String, String> contextData =
CollectionUtils.filterMapEntries(
loggingEvent.getContextData().toMap(), entry -> entry.getValue() != null);
Expand Down
18 changes: 18 additions & 0 deletions sentry-log4j2/src/test/kotlin/io/sentry/log4j2/SentryAppenderTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ import kotlin.test.assertNull
import kotlin.test.assertTrue
import org.apache.logging.log4j.Level
import org.apache.logging.log4j.LogManager
import org.apache.logging.log4j.MarkerManager
import org.apache.logging.log4j.ThreadContext
import org.apache.logging.log4j.core.LoggerContext
import org.apache.logging.log4j.core.config.AppenderRef
Expand Down Expand Up @@ -274,6 +275,23 @@ class SentryAppenderTest {
}
}

@Test
fun `attaches marker information`() {
val logger = fixture.getSut(minimumEventLevel = Level.WARN)
val sqlMarker = MarkerManager.getMarker("SQL").setParents(
MarkerManager.getMarker("SQL_QUERY"),
MarkerManager.getMarker("SQL_UPDATE")
)

logger.warn(sqlMarker, "testing marker tags")

await.untilAsserted {
verify(fixture.transport).send(checkEvent { event ->
assertEquals("SQL[ SQL_QUERY, SQL_UPDATE ]", event.getExtra("marker"))
}, anyOrNull())
}
}

@Test
fun `sets SDK version`() {
val logger = fixture.getSut(minimumEventLevel = Level.INFO)
Expand Down
4 changes: 4 additions & 0 deletions sentry-logback/src/main/java/io/sentry/logback/SentryAppender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@ protected void append(@NotNull ILoggingEvent eventObject) {
event.setExtra("thread_name", loggingEvent.getThreadName());
}

if (loggingEvent.getMarker() != null) {
event.setExtra("marker", loggingEvent.getMarker().toString());
}

// remove keys with null values, there is no sense to send these keys to Sentry
final Map<String, String> mdcProperties =
CollectionUtils.filterMapEntries(
Expand Down
17 changes: 17 additions & 0 deletions sentry-logback/src/test/kotlin/io/sentry/logback/SentryAppenderTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ import org.awaitility.kotlin.await
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import org.slf4j.MDC
import org.slf4j.MarkerFactory

class SentryAppenderTest {
private class Fixture(dsn: String? = "http://key@localhost/proj", minimumBreadcrumbLevel: Level? = null, minimumEventLevel: Level? = null) {
Expand Down Expand Up @@ -251,6 +252,22 @@ class SentryAppenderTest {
}
}

@Test
fun `attaches marker information`() {
fixture = Fixture(minimumEventLevel = Level.WARN)
val sqlMarker = MarkerFactory.getDetachedMarker("SQL")
sqlMarker.add(MarkerFactory.getDetachedMarker("SQL_UPDATE"))
sqlMarker.add(MarkerFactory.getDetachedMarker("SQL_QUERY"))

fixture.logger.warn(sqlMarker, "testing marker tags")

await.untilAsserted {
verify(fixture.transport).send(checkEvent { event ->
assertEquals("SQL [ SQL_UPDATE, SQL_QUERY ]", event.getExtra("marker"))
}, anyOrNull())
}
}

@Test
fun `sets SDK version`() {
fixture = Fixture(minimumEventLevel = Level.INFO)
Expand Down