Add support for using Encoder with logback.SentryAppender

[norwood]

📜 Description

this adds support for logback encoders in the sentry appender

💡 Motivation and Context

this was previously added in https://github.com/getsentry/sentry-java/pull/794/files and was mentioned here #2217

💚 How did you test it?

added a test to the test suite
tested against my own sentry instance that formatted messages go through

📝 Checklist

• I reviewed the submitted code
• I added tests to verify the changes
• I updated the docs if needed
• No breaking changes

🔮 Next steps

[adinauer]

Thank you for the contribution @norwood 🙏 and sorry for taking so long - we've been pretty busy. Left one question regarding try/catch otherwise this LGTM.

[adinauer]

Would it make sense to wrap this with a try/catch just in case a faulty encoder has been configured so we still get the formatted message as fallback?

[codecov-commenter]

Codecov Report

Base: 80.10% // Head: 80.11% // Increases project coverage by +0.01% 🎉

Coverage data is based on head (fff5493) compared to base (4796772).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #2246      +/-   ##
============================================
+ Coverage     80.10%   80.11%   +0.01%     
- Complexity     3430     3433       +3     
============================================
  Files           242      242              
  Lines         12758    12765       +7     
  Branches       1703     1703              
============================================
+ Hits          10220    10227       +7     
  Misses         1889     1889              
  Partials        649      649              

Impacted Files	Coverage Δ
...rc/main/java/io/sentry/logback/SentryAppender.java	89.10% <100.00%> (+0.81%)	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[jeacott1]

Is there still a means to add global MDC tags?

[adinauer]

@jeacott1 you can set a list of MDC tags that Sentry will pick up and convert to tags as shown in this sample:

sentry-java/sentry-samples/sentry-samples-logback/src/main/resources/logback.xml

Lines 14 to 15 in c1b740d

	<contextTag>userId</contextTag>
	<contextTag>requestId</contextTag>

I looks like we never documented this feature, created #2351 to do so.

Is the feature not working for you?

[jeacott1]

@adinauer the option used to exist due to my lost commit https://github.com/getsentry/sentry-java/pull/794/files
I didn't know there was now an alternative.
thanks!

[transducer]

@norwood how can this encoder be configured? If I add an encoder to my logback.xml, in Sentry I see an <unlabeled event>.

[norwood]

i have only configured manually, not with logback.xml, and i'm not familiar with the xml configuration path.

[transducer]

@norwood thanks for reply. It looks like this:

<appender name="SENTRY" class="io.sentry.logback.SentryAppender">
  <encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
    <layout class="com.baeldung.logback.MaskingPatternLayout">
      <maskPattern>\"SSN\"\s*:\s*\"(.*?)\"</maskPattern>
    </layout>
  </encoder>
  <options>
    <dsn>***</dsn>
  </options>
</appender>

I thought this would be similar to setEncoder. But it results in empty events like this:

I guess then I have to figure out how to manually configure Sentry (with Java code?).

[adinauer]

@transducer can you please check for processing errors in the Sentry UI? If there's none, you could turn on debug and check the JSON that gets sent to Sentry.

[transducer]

@adinauer I think something else went wrong in my configuration; locally I missed passing a pattern in the XML, thus the whole of Logback was not properly instantiated and onload also an ERROR was visible from Logback ("PatternLayout("null") - Empty or null pattern"). With proper configuration, it does work!

Thanks a lot for the help both.

[transducer]

@adinauer it seems breadcrumbs and messages are encoded, but exception messages are not. Any ideas how exception messages could also be using the encoder? In our use case of scrubbing sensitive information, sometimes sensitive information (like an email address or a database spec) ends up in the message, we want to scrub that.

[adinauer]

@transducer can you please specify where exactly you see the message you're referring to? Is this on Sentry UI or on the JSON you can see in debug log?

I'm assuming the problem is this line:

sentry-java/sentry-logback/src/main/java/io/sentry/logback/SentryAppender.java

Line 102 in 4d55d51

message.setMessage(loggingEvent.getMessage());

Just trying to confirm before digging deeper. As a workaround for now you should be able to filter data from errors in beforeSend.

[transducer]

@adinauer thanks for your reply. It is in the Sentry UI when logging an uncaught exception. It shows the exception message which is not encoded above the stacktrace. Other log messages and breadcrumbs are encoded.

[adinauer]

@transducer thanks. Can you confirm the workaround does fix your problem?

[adinauer]

@transducer we've created #2973 to track. We want to discuss this a bit more internally before implementing. Will update there.