Package io.quarkus.logging.sentry

Interface SentryConfig

@ConfigRoot(phase=RUN_TIME) @ConfigMapping(prefix="quarkus.log.sentry") public interface SentryConfig
Configuration for Sentry logging.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<List<String>>
    contextTags()
    Context Tags Specifics the MDC tags that are used as Sentry tags
    boolean
    debug()
    Debug Enables Sentry debug mode.
    Optional<String>
    dsn()
    Sentry DSN The DSN is the first and most important thing to configure because it tells the SDK where to send events.
    Optional<Boolean>
    enable()
    Deprecated, for removal: This API element is subject to removal in a future version.
    we try to stay away from this pattern now, replace with quarkus.log.sentry.enabled.
    boolean
    enabled()
    Determine whether to enable the Sentry logging extension.
    Optional<String>
    environment()
    Environment With Sentry you can easily filter issues, releases, and user feedback by environment.
    Optional<List<String>>
    ignoredExceptionsForType()
    You can use this option to set exceptions that will be filtered out before sending to Sentry by adding the names of the exception.
    Optional<List<String>>
    inAppExcludedPackages()
    Sentry differentiates stack frames that are directly related to your application (“in application”) from stack frames that come from other packages such as the standard library, frameworks, or other dependencies.
    Optional<List<String>>
    inAppPackages()
    Sentry differentiates stack frames that are directly related to your application (“in application”) from stack frames that come from other packages such as the standard library, frameworks, or other dependencies.
    Level
    level()
    The sentry log level.
    Level
    minimumBreadcrumbLevel()
    The minimum breadcrumb level.
    Level
    minimumEventLevel()
    The minimum event level.
    SentryProxyConfig
    proxy()
     
    Optional<String>
    release()
    Release A release is a version of your code that is deployed to an environment.
    Optional<String>
    serverName()
    Server name Sets the server name that will be sent with each event.
    Map<String,String>
    tags()
    Static tags Static tags that are sent to Sentry with every event.
    OptionalDouble
    tracesSampleRate()
    This should be a float/double between 0.0 and 1.0 (inclusive) and represents the percentage chance that any given transaction will be sent to Sentry.

  • Method Details

    • enable

      @Deprecated(forRemoval=true) @WithParentName Optional<Boolean> enable()
      Deprecated, for removal: This API element is subject to removal in a future version.
      we try to stay away from this pattern now, replace with quarkus.log.sentry.enabled.
      Determine whether to enable the Sentry logging extension.

    • enabled

      @WithDefault("false") boolean enabled()
      Determine whether to enable the Sentry logging extension.

    • dsn

      Optional<String> dsn()
      Sentry DSN The DSN is the first and most important thing to configure because it tells the SDK where to send events. You can find your project’s DSN in the “Client Keys” section of your “Project Settings” in Sentry.

    • level

      @WithDefault("WARN") Level level()
      The sentry log level.

    • minimumEventLevel

      @WithDefault("WARN") Level minimumEventLevel()
      The minimum event level. Every log statement that is greater than minimum event level is turned into Sentry event.

    • minimumBreadcrumbLevel

      @WithDefault("INFO") Level minimumBreadcrumbLevel()
      The minimum breadcrumb level. Every log statement that is greater than minimum breadcrumb level is added to Sentry scope as a breadcrumb, which can be later attached to SentryEvent if one is triggered.

    • inAppPackages

      Optional<List<String>> inAppPackages()
      Sentry differentiates stack frames that are directly related to your application (“in application”) from stack frames that come from other packages such as the standard library, frameworks, or other dependencies. The difference is visible in the Sentry web interface where only the “in application” frames are displayed by default. You can configure which package prefixes your application uses with this option. This option is highly recommended as it affects stacktrace grouping and display on Sentry. See documentation: https://quarkus.io/guides/logging-sentry#in-app-packages

    • inAppExcludedPackages

      Optional<List<String>> inAppExcludedPackages()
      Sentry differentiates stack frames that are directly related to your application (“in application”) from stack frames that come from other packages such as the standard library, frameworks, or other dependencies. The difference is visible in the Sentry web interface where only the “in application” frames are displayed by default. You can configure which package prefixes your application uses with this option. You can configure which package prefixes you want to exclude from logging.

    • ignoredExceptionsForType

      Optional<List<String>> ignoredExceptionsForType()
      You can use this option to set exceptions that will be filtered out before sending to Sentry by adding the names of the exception.(e.g. java.lang.RuntimeException)

    • environment

      Optional<String> environment()
      Environment With Sentry you can easily filter issues, releases, and user feedback by environment. The environment filter on sentry affects all issue-related metrics like count of users affected, times series graphs, and event count. By setting the environment option, an environment tag will be added to each new issue sent to Sentry. There are a few restrictions: -> the environment name cannot contain newlines or spaces, cannot be the string “None” or exceed 64 characters.

    • release

      Optional<String> release()
      Release A release is a version of your code that is deployed to an environment. When you give Sentry information about your releases, you unlock a number of new features: - Determine the issues and regressions introduced in a new release - Predict which commit caused an issue and who is likely responsible - Resolve issues by including the issue number in your commit message - Receive email notifications when your code gets deployed

    • serverName

      Optional<String> serverName()
      Server name Sets the server name that will be sent with each event.

    • debug

      @WithDefault("false") boolean debug()
      Debug Enables Sentry debug mode.

    • tracesSampleRate

      OptionalDouble tracesSampleRate()
      This should be a float/double between 0.0 and 1.0 (inclusive) and represents the percentage chance that any given transaction will be sent to Sentry. So, barring outside influence, 0.0 is a 0% chance (none will be sent) and 1.0 is a 100% chance (all will be sent). This rate applies equally to all transactions.

    • contextTags

      Optional<List<String>> contextTags()
      Context Tags Specifics the MDC tags that are used as Sentry tags

    • tags

      Map<String,String> tags()
      Static tags Static tags that are sent to Sentry with every event.

    • proxy

      SentryProxyConfig proxy()