Simplify configuring Logback integration when environment variable with the DSN is not set. #1271
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When an environment property that is referenced in logback.xml is not set, Logback sets its value to PROPERTY_NAME_IS_UNDEFINED (not a `null` like it could have been expected). This complicates setting up SentryLogback appender configuration where the integration should be disabled in environments that do not have this property.
Before this change, users had to do:
<options>
<dsn>${PROPERTY:- }
</options>
With this change:
<options>
<dsn>${PROPERTY}
</options>
maciejwalkowiak
requested review from
bruno-garcia and
marandaneto
as code owners
marandaneto
reviewed
Feb 19, 2021
sentry-samples/sentry-samples-logback/src/main/resources/logback.xml
Outdated
Show resolved
Hide resolved
marandaneto
reviewed
Feb 19, 2021
| @@ -305,4 +306,11 @@ class SentryAppenderTest { | |||
| }, anyOrNull()) | |||
| } | |||
| } | |||
|
|
|||
| @Test | |||
| fun `does not initialize Sentry when DSN is null`() { | |||
There was a problem hiding this comment.
on Android or standard Sentry.init, if no DSN is passed (null), we throw an exception, because "" empty DSN means disabled SDK, are we allowing to do differently on logback?
There was a problem hiding this comment.
I fixed the test name, as we are not really handling null here. Logback has this weird behavior, that when the env is not set it gets a value "ENV_NAME_IS_UNDEFINED" and the only way to handle it properly is to write it like ${PROPERTY:- }.
We can either clarify it in the docs or make it easier for users. This has been roughly discussed with @bruno-garcia - would be nice if he also has a quick look
bruno-garcia
approved these changes
Feb 19, 2021
marandaneto
reviewed
Feb 21, 2021
sentry-logback/src/main/java/io/sentry/logback/SentryAppender.java
Outdated
Show resolved
Hide resolved
marandaneto
approved these changes
Feb 21, 2021
…java Co-authored-by: Manoel Aranda Neto <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📜 Description
Simplify configuring Logback integration when environment variable with the DSN is not set.
💡 Motivation and Context
When an environment property that is referenced in logback.xml is not set, Logback sets its value to PROPERTY_NAME_IS_UNDEFINED (not a
nulllike it could have been expected). This complicates setting up SentryLogback appender configuration where the integration should be disabled in environments that do not have this property.Before this change, users had to do:
With this change:
💚 How did you test it?
📝 Checklist