uk.gov.service.payments.logging.SentryAppenderFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of logging-dropwizard-3 Show documentation
There is a newer version: 1.0.20241118085938
/*
Copyright 2021 Olivier Chédru

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Original: https://github.com/dhatim/dropwizard-sentry/blob/2.1.6/src/main/java/org/dhatim/dropwizard/sentry/logging/SentryAppenderFactory.java

Trivial modifications made by the GOV.UK Pay team to use Dropwizard 3
imports. Modifications licensed under the MIT License (see LICENCE file).
*/
package uk.gov.service.payments.logging;

import ch.qos.logback.classic.LoggerContext;
import ch.qos.logback.classic.spi.ILoggingEvent;
import ch.qos.logback.core.Appender;
import ch.qos.logback.core.filter.Filter;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.JsonTypeName;
import com.google.common.base.Preconditions;
import io.dropwizard.logging.common.AbstractAppenderFactory;
import io.dropwizard.logging.common.async.AsyncAppenderFactory;
import io.dropwizard.logging.common.filter.LevelFilterFactory;
import io.dropwizard.logging.common.layout.LayoutFactory;
import io.sentry.Sentry;
import io.sentry.SentryOptions;
import io.sentry.logback.SentryAppender;
import org.dhatim.dropwizard.sentry.SentryConfigurator;
import org.dhatim.dropwizard.sentry.filters.DroppingSentryLoggingFilter;

import javax.validation.constraints.NotNull;
import java.lang.reflect.InvocationTargetException;
import java.util.List;
import java.util.Map;
import java.util.Optional;

@JsonTypeName("pay-dropwizard-3-sentry")
public class SentryAppenderFactory extends AbstractAppenderFactory {

    @JsonProperty
    public @NotNull String dsn = null;
    @JsonProperty
    public String environment = null;
    @JsonProperty
    public Map tags = null;
    @JsonProperty
    public String release = null;
    @JsonProperty
    public String serverName = null;
    @JsonProperty
    public List inAppIncludes = null;
    @JsonProperty
    public List inAppExcludes = null;
    @JsonProperty
    public String configurator = null;

    public SentryAppenderFactory() {
    }

    @Override
    public Appender build(LoggerContext context, 
                                         String applicationName, 
                                         LayoutFactory layoutFactory,
                                         LevelFilterFactory levelFilterFactory,
                                         AsyncAppenderFactory asyncAppenderFactory) {
        Preconditions.checkNotNull(context);
        SentryOptions options = new SentryOptions();
        options.setDsn(this.dsn);
        Optional.ofNullable(this.environment).ifPresent(options::setEnvironment);
        Optional.ofNullable(this.tags).ifPresent((tags) -> {
            tags.forEach(options::setTag);
        });
        Optional.ofNullable(this.release).ifPresent(options::setRelease);
        Optional.ofNullable(this.serverName).ifPresent(options::setServerName);
        Optional.ofNullable(this.inAppIncludes).ifPresent((inAppIncludes) -> {
            inAppIncludes.forEach(options::addInAppInclude);
        });
        Optional.ofNullable(this.inAppExcludes).ifPresent((inAppExcludes) -> {
            inAppExcludes.forEach(options::addInAppExclude);
        });
        Optional.ofNullable(this.configurator).ifPresent((configurator) -> {
            try {
                Class klass = Class.forName(configurator);
                if (!SentryConfigurator.class.isAssignableFrom(klass)) {
                    throw new IllegalArgumentException("configurator class " + configurator + " does not implement " + SentryConfigurator.class.getName());
                } else {
                    SentryConfigurator sentryConfigurator = (SentryConfigurator)klass.getDeclaredConstructor().newInstance();
                    sentryConfigurator.configure(options);
                }
            } catch (ClassNotFoundException var4) {
                throw new IllegalArgumentException("configurator class " + configurator + " not found", var4);
            } catch (NoSuchMethodException var5) {
                throw new IllegalArgumentException("configurator class " + configurator + " does not define a default constructor", var5);
            } catch (InstantiationException | IllegalAccessException | InvocationTargetException var6) {
                throw new IllegalArgumentException("cannot invoke default constructor on configurator class " + configurator, var6);
            }
        });
        Sentry.close();
        SentryAppender appender = new SentryAppender();
        appender.setOptions(options);
        appender.setName("dropwizard-sentry");
        appender.setContext(context);
        appender.setMinimumBreadcrumbLevel(this.threshold);
        appender.setMinimumEventLevel(this.threshold);
        appender.addFilter(levelFilterFactory.build(this.threshold));
        this.getFilterFactories().forEach((f) -> {
            appender.addFilter(f.build());
        });
        appender.start();
        Filter filter = new DroppingSentryLoggingFilter();
        filter.start();
        appender.addFilter(filter);
        return appender;
    }
}