io.quarkus.logging.sentry.SentryHandlerValueFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quarkus-logging-sentry Show documentation

Use Sentry, a self-hosted or cloud-based error monitoring solution

There is a newer version: 3.0.0.Beta1

Show newest version

package io.quarkus.logging.sentry;

import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.logging.Handler;

import org.jboss.logging.Logger;

import io.quarkus.runtime.RuntimeValue;
import io.quarkus.runtime.annotations.Recorder;
import io.quarkus.runtime.configuration.ConfigurationException;
import io.sentry.Sentry;
import io.sentry.SentryOptions;
import io.sentry.jul.SentryHandler;

@Recorder
public class SentryHandlerValueFactory {
    private static final Logger LOG = Logger.getLogger(SentryHandlerValueFactory.class);

    public RuntimeValue> create(final SentryConfig config) {

        if (!config.enable) {
            return new RuntimeValue<>(Optional.empty());
        }

        // Init Sentry
        final SentryOptions options = toSentryOptions(config);
        Sentry.init(options);
        SentryHandler handler = new SentryHandler(options);
        handler.setLevel(config.level);
        handler.setPrintfStyle(true);
        handler.setMinimumEventLevel(config.minimumEventLevel != null ? config.minimumEventLevel : config.level);
        handler.setMinimumBreadcrumbLevel(config.minimumBreadcrumbLevel);
        return new RuntimeValue<>(Optional.of(handler));
    }

    public static SentryOptions toSentryOptions(SentryConfig sentryConfig) {
        if (!sentryConfig.dsn.isPresent()) {
            throw new ConfigurationException(
                    "Configuration key \"quarkus.log.sentry.dsn\" is required when Sentry is enabled, but its value is empty/missing");
        }
        final SentryOptions options = new SentryOptions();

        if (!sentryConfig.inAppPackages.isPresent()) {
            LOG.warn(
                    "No 'quarkus.sentry.in-app-packages' was configured, this option is highly recommended as it affects stacktrace grouping and display on Sentry. See https://quarkus.io/guides/logging-sentry#in-app-packages");
        } else {
            List inAppPackages = sentryConfig.inAppPackages.get();
            if (inAppPackages.size() != 1 || !Objects.equals(inAppPackages.get(0), "*")) {
                inAppPackages.forEach(options::addInAppInclude);
            }
        }
        options.setDsn(sentryConfig.dsn.get());
        sentryConfig.environment.ifPresent(options::setEnvironment);
        sentryConfig.release.ifPresent(options::setRelease);
        sentryConfig.serverName.ifPresent(options::setServerName);
        options.setDebug(sentryConfig.debug);
        return options;
    }
}