Skip to content

Commit

Permalink
Merge pull request #259 from gsmet/quarkus-3.15.2
Browse files Browse the repository at this point in the history
Update to Quarkus 3.15.2
  • Loading branch information
gsmet authored Nov 27, 2024
2 parents f94e61a + 47cf90c commit 55bc174
Show file tree
Hide file tree
Showing 8 changed files with 488 additions and 103 deletions.
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,7 @@ target/
pom.xml.tag
pom.xml.releaseBackup
pom.xml.versionsBackup
release.properties
release.properties

# Quarkus
.quarkus/
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/includes/attributes.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
:quarkus-version: 3.0.0.Final
:quarkus-version: 3.15.2
:quarkus-logging-sentry-version: 2.0.7

:quarkus-org-url: https://github.com/quarkusio
Expand Down
173 changes: 96 additions & 77 deletions docs/modules/ROOT/pages/includes/quarkus-logging-sentry.adoc

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,354 @@
:summaryTableId: quarkus-logging-sentry_quarkus-log
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[.header-title]##Configuration property##
h|Type
h|Default

a| [[quarkus-logging-sentry_quarkus-log-sentry]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry[`quarkus.log.sentry`]##

[.description]
--
Determine whether to enable the Sentry logging extension.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`false`

a| [[quarkus-logging-sentry_quarkus-log-sentry-dsn]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-dsn[`quarkus.log.sentry.dsn`]##

[.description]
--
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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_DSN+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_DSN+++`
endif::add-copy-button-to-env-var[]
--
|string
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-level]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-level[`quarkus.log.sentry.level`]##

[.description]
--
The sentry log level.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_LEVEL+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_LEVEL+++`
endif::add-copy-button-to-env-var[]
--
|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level]
|`WARN`

a| [[quarkus-logging-sentry_quarkus-log-sentry-minimum-event-level]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-minimum-event-level[`quarkus.log.sentry.minimum-event-level`]##

[.description]
--
The minimum event level. Every log statement that is greater than minimum event level is turned into Sentry event.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_MINIMUM_EVENT_LEVEL+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_MINIMUM_EVENT_LEVEL+++`
endif::add-copy-button-to-env-var[]
--
|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level]
|`WARN`

a| [[quarkus-logging-sentry_quarkus-log-sentry-minimum-breadcrumb-level]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-minimum-breadcrumb-level[`quarkus.log.sentry.minimum-breadcrumb-level`]##

[.description]
--
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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_MINIMUM_BREADCRUMB_LEVEL+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_MINIMUM_BREADCRUMB_LEVEL+++`
endif::add-copy-button-to-env-var[]
--
|link:https://javadoc.io/doc/org.jboss.logmanager/jboss-logmanager/latest/org/jboss/logmanager/Level.html[Level]
|`INFO`

a| [[quarkus-logging-sentry_quarkus-log-sentry-in-app-packages]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-in-app-packages[`quarkus.log.sentry.in-app-packages`]##

[.description]
--
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


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_IN_APP_PACKAGES+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_IN_APP_PACKAGES+++`
endif::add-copy-button-to-env-var[]
--
|list of string
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-in-app-excluded-packages]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-in-app-excluded-packages[`quarkus.log.sentry.in-app-excluded-packages`]##

[.description]
--
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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_IN_APP_EXCLUDED_PACKAGES+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_IN_APP_EXCLUDED_PACKAGES+++`
endif::add-copy-button-to-env-var[]
--
|list of string
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-ignored-exceptions-for-type]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-ignored-exceptions-for-type[`quarkus.log.sentry.ignored-exceptions-for-type`]##

[.description]
--
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)


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_IGNORED_EXCEPTIONS_FOR_TYPE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_IGNORED_EXCEPTIONS_FOR_TYPE+++`
endif::add-copy-button-to-env-var[]
--
|list of string
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-environment]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-environment[`quarkus.log.sentry.environment`]##

[.description]
--
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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_ENVIRONMENT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_ENVIRONMENT+++`
endif::add-copy-button-to-env-var[]
--
|string
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-release]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-release[`quarkus.log.sentry.release`]##

[.description]
--
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


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_RELEASE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_RELEASE+++`
endif::add-copy-button-to-env-var[]
--
|string
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-server-name]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-server-name[`quarkus.log.sentry.server-name`]##

[.description]
--
Server name Sets the server name that will be sent with each event.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_SERVER_NAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_SERVER_NAME+++`
endif::add-copy-button-to-env-var[]
--
|string
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-debug]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-debug[`quarkus.log.sentry.debug`]##

[.description]
--
Debug Enables Sentry debug mode.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_DEBUG+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_DEBUG+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`false`

a| [[quarkus-logging-sentry_quarkus-log-sentry-traces-sample-rate]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-traces-sample-rate[`quarkus.log.sentry.traces-sample-rate`]##

[.description]
--
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.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_TRACES_SAMPLE_RATE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_TRACES_SAMPLE_RATE+++`
endif::add-copy-button-to-env-var[]
--
|double
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-context-tags]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-context-tags[`quarkus.log.sentry.context-tags`]##

[.description]
--
Context Tags Specifics the MDC tags that are used as Sentry tags


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_CONTEXT_TAGS+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_CONTEXT_TAGS+++`
endif::add-copy-button-to-env-var[]
--
|list of string
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-tags-tags]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-tags-tags[`quarkus.log.sentry.tags."tags"`]##

[.description]
--
Static tags Static tags that are sent to Sentry with every event.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_TAGS__TAGS_+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_TAGS__TAGS_+++`
endif::add-copy-button-to-env-var[]
--
|Map<String,String>
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-proxy]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-proxy[`quarkus.log.sentry.proxy`]##

[.description]
--
Determine whether to enable a Proxy for all Sentry outbound requests. This is also used for HTTPS requests.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_PROXY+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_PROXY+++`
endif::add-copy-button-to-env-var[]
--
|boolean
|`false`

a| [[quarkus-logging-sentry_quarkus-log-sentry-proxy-host]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-proxy-host[`quarkus.log.sentry.proxy.host`]##

[.description]
--
Sets the host name of the proxy server.


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_PROXY_HOST+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_PROXY_HOST+++`
endif::add-copy-button-to-env-var[]
--
|string
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-proxy-port]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-proxy-port[`quarkus.log.sentry.proxy.port`]##

[.description]
--
Sets the port number of the proxy server


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_PROXY_PORT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_PROXY_PORT+++`
endif::add-copy-button-to-env-var[]
--
|int
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-proxy-username]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-proxy-username[`quarkus.log.sentry.proxy.username`]##

[.description]
--
Sets the username to authenticate on the proxy server


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_PROXY_USERNAME+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_PROXY_USERNAME+++`
endif::add-copy-button-to-env-var[]
--
|string
|

a| [[quarkus-logging-sentry_quarkus-log-sentry-proxy-password]] [.property-path]##link:#quarkus-logging-sentry_quarkus-log-sentry-proxy-password[`quarkus.log.sentry.proxy.password`]##

[.description]
--
Sets the password to authenticate on the proxy server


ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_LOG_SENTRY_PROXY_PASSWORD+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_LOG_SENTRY_PROXY_PASSWORD+++`
endif::add-copy-button-to-env-var[]
--
|string
|

|===


:!summaryTableId:
13 changes: 8 additions & 5 deletions docs/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,14 @@
</execution>
</executions>
</plugin>
<plugin>
<groupId>io.quarkus</groupId>
<artifactId>quarkus-config-doc-maven-plugin</artifactId>
<extensions>true</extensions>
<configuration>
<targetDirectory>${project.basedir}/modules/ROOT/pages/includes/</targetDirectory>
</configuration>
</plugin>
<plugin>
<artifactId>maven-resources-plugin</artifactId>
<executions>
Expand All @@ -51,11 +59,6 @@
<configuration>
<outputDirectory>${project.basedir}/modules/ROOT/pages/includes/</outputDirectory>
<resources>
<resource>
<directory>${project.basedir}/../target/asciidoc/generated/config/</directory>
<include>quarkus-logging-sentry.adoc</include>
<filtering>false</filtering>
</resource>
<resource>
<directory>${project.basedir}/templates/includes</directory>
<include>attributes.adoc</include>
Expand Down
Loading

0 comments on commit 55bc174

Please sign in to comment.