Quarkus - Logging to Sentry

Description
Configuration
- “In Application” Stack Frames
Example
Configuration Reference

This guide explains how to configure Quarkus to log to Sentry.

Description

Sentry is a really easy way to be notified of errors happening in your Quarkus application.

It is a self-hosted and cloud-based error monitoring that helps software teams discover, triage, and prioritize errors in real-time.

They offer a free starter price for cloud-based or you can self host it for free.

Sentry’s Java SDK is open source, but recently sentry.io changed the license for their backend to the non-open source BSL license. This might or might not be an issue for your project and product.

Configuration

To start with, you need to get a Sentry DSN either by creating a Sentry account or installing your own self-hosted Sentry.

In order to configure Sentry logging, add the quarkus-logging-sentry extension to your application pom.xml as illustrated in the following snippet:

Add the Sentry logging extension to your pom.xml

<build>
  <dependencies>
    <!-- ... your other dependencies are here ... -->
    <dependency>
      <groupId>io.quarkus</groupId>
      <artifactId>quarkus-logging-sentry</artifactId>
    </dependency>
  </dependencies>
</build>

“In Application” Stack Frames

You can configure which package prefixes your application uses with the in-app-packages option, which takes a comma separated list of packages:

quarkus.log.sentry.in-app-packages=com.mycompany,com.other.name

If you don’t want to use this feature but want to disable the warning, simply set it to *:

quarkus.log.sentry.in-app-packages=*

Example

All errors and warnings occurring in any of the packages will be sent to Sentry with DSN https://abcd@sentry.io/1234

quarkus.log.sentry=true
quarkus.log.sentry.dsn=https://abcd@sentry.io/1234
quarkus.log.sentry.in-app-packages=*

All errors occurring in the package org.example will be sent to Sentry with DSN https://abcd@sentry.io/1234

quarkus.log.sentry=true
quarkus.log.sentry.dsn=https://abcd@sentry.io/1234
quarkus.log.sentry.level=ERROR
quarkus.log.sentry.in-app-packages=org.example

Configuration Reference

This extension is configured through the standard application.properties file.

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property	Type	Default
`quarkus.log.sentry` Determine whether to enable the Sentry logging extension.	boolean	`false`
`quarkus.log.sentry.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.	string
`quarkus.log.sentry.level` The sentry log level.	Level	`WARN`
`quarkus.log.sentry.in-app-packages` 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	list of string

Configuration property

Type

Default

quarkus.log.sentry

Determine whether to enable the Sentry logging extension.

boolean

false

quarkus.log.sentry.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.

string

quarkus.log.sentry.level

The sentry log level.

Level

WARN

quarkus.log.sentry.in-app-packages

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

list of string