Merge pull request #4 from ochedru/stacktrace

Ability to configure stacktrace.app.packages

Author: Olivier Chédru

README.md

@@ -39,6 +39,7 @@ appenders:
     release: 1.0.0
     serverName: 10.0.0.1
     extra: {key1:'value1',key2:'value2'}
+    stacktraceAppPackages: ['com.example','com.foo']
 ```
 
 | Setting | Default | Description | Example Value |
@@ -52,6 +53,9 @@ appenders:
 | `release` | [empty] | The release version of your application | `1.0.0` |
 | `serverName` | [empty] | Override the server name (rather than looking it up dynamically) | `10.0.0.1` |
 | `extra` | [empty] | Extra data to be sent with errors (but not as tags) | `{key1:'value1',key2:'value2'}` |
+| `stacktraceAppPackages` | [empty] | List of package prefixes used by application code | `['com.example','com.foo']` |
+
+If you need to set configuration properties not listed above, append them to the `dsn` as described [here](https://docs.sentry.io/clients/java/config/#configuration-via-the-dsn).
 
 ## Maven Artifacts
 

pom.xml

@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.dhatim</groupId>
         <artifactId>root-oss</artifactId>
-        <version>11.0.0</version>
+        <version>12.1.0</version>
     </parent>
     <groupId>org.dhatim</groupId>
     <artifactId>dropwizard-sentry</artifactId>
@@ -40,6 +40,7 @@
         <dependency>
             <groupId>io.sentry</groupId>
             <artifactId>sentry-logback</artifactId>
+            <version>1.7.5</version>
         </dependency>
         <dependency>
             <groupId>junit</groupId>

src/main/java/org/dhatim/dropwizard/sentry/logging/SentryAppenderFactory.java

@@ -6,20 +6,25 @@
 import ch.qos.logback.core.filter.Filter;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonTypeName;
-import static com.google.common.base.Preconditions.checkNotNull;
 import io.dropwizard.logging.AbstractAppenderFactory;
 import io.dropwizard.logging.async.AsyncAppenderFactory;
 import io.dropwizard.logging.filter.LevelFilterFactory;
 import io.dropwizard.logging.layout.LayoutFactory;
 import io.sentry.DefaultSentryClientFactory;
 import io.sentry.SentryClient;
 import io.sentry.SentryClientFactory;
+import io.sentry.dsn.Dsn;
 import io.sentry.logback.SentryAppender;
+import org.dhatim.dropwizard.sentry.filters.DroppingSentryLoggingFilter;
+
+import javax.validation.constraints.NotNull;
+import java.util.List;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
-import javax.validation.constraints.NotNull;
-import org.dhatim.dropwizard.sentry.filters.DroppingSentryLoggingFilter;
+import java.util.stream.Collectors;
+
+import static com.google.common.base.Preconditions.checkNotNull;
 
 @JsonTypeName("sentry")
 public class SentryAppenderFactory extends AbstractAppenderFactory<ILoggingEvent> {
@@ -51,6 +56,9 @@ public class SentryAppenderFactory extends AbstractAppenderFactory<ILoggingEvent
     @JsonProperty
     private Optional<Map<String, Object>> extra = Optional.empty();
 
+    @JsonProperty
+    private Optional<List<String>> stacktraceAppPackages = Optional.empty();
+
     public String getDsn() {
         return dsn;
     }
@@ -115,12 +123,20 @@ public void setExtra(Optional<Map<String, Object>> extra) {
         this.extra = extra;
     }
 
+    public Optional<List<String>> getStacktraceAppPackages() {
+        return stacktraceAppPackages;
+    }
+
+    public void setStacktraceAppPackages(Optional<List<String>> stacktraceAppPackages) {
+        this.stacktraceAppPackages = stacktraceAppPackages;
+    }
+
     @Override
     public Appender<ILoggingEvent> build(LoggerContext context,
-            String applicationName,
-            LayoutFactory<ILoggingEvent> layoutFactory,
-            LevelFilterFactory<ILoggingEvent> levelFilterFactory,
-            AsyncAppenderFactory<ILoggingEvent> asyncAppenderFactory) {
+                                         String applicationName,
+                                         LayoutFactory<ILoggingEvent> layoutFactory,
+                                         LevelFilterFactory<ILoggingEvent> levelFilterFactory,
+                                         AsyncAppenderFactory<ILoggingEvent> asyncAppenderFactory) {
         checkNotNull(context);
 
         SentryClientFactory factory;
@@ -131,6 +147,10 @@ public Appender<ILoggingEvent> build(LoggerContext context,
         } catch (ReflectiveOperationException ex) {
             throw new RuntimeException(ex);
         }
+        String dsn = this.dsn;
+        if (!new Dsn(dsn).getOptions().containsKey("stacktrace.app.packages")) {
+            dsn += "&stacktrace.app.packages=" + stacktraceAppPackages.map(list -> list.stream().collect(Collectors.joining(","))).orElse("");
+        }
         SentryClient sentryClient = SentryClientFactory.sentryClient(dsn, factory);
 
         final SentryAppender appender = new SentryAppender();

src/test/java/org/dhatim/dropwizard/sentry/logging/SentryAppenderFactoryTest.java

@@ -42,11 +42,11 @@ public void buildSentryAppenderShouldFailWithNullContext() {
 
     @Test
     public void buildSentryAppenderShouldWorkWithValidConfiguration() {
-        final SentryAppenderFactory factory = new SentryAppenderFactory();
-        final String dsn = "https://user:pass@app.sentry.io/id";
+        SentryAppenderFactory factory = new SentryAppenderFactory();
+        factory.setDsn("https://user:pass@app.sentry.io/id");
 
         Appender<ILoggingEvent> appender
-                = factory.build(context, dsn, layoutFactory, levelFilterFactory, asyncAppenderFactory);
+                = factory.build(context, "", layoutFactory, levelFilterFactory, asyncAppenderFactory);
 
         assertThat(appender, instanceOf(AsyncAppender.class));
     }