From d8b671692020bb236bed4546ef2005935afb2210 Mon Sep 17 00:00:00 2001 From: Guillaume Smet Date: Wed, 20 Nov 2024 14:59:15 +0100 Subject: [PATCH 1/3] Add .quarkus to .gitignore --- .gitignore | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index a556d94..2ab4557 100644 --- a/.gitignore +++ b/.gitignore @@ -61,4 +61,7 @@ target/ pom.xml.tag pom.xml.releaseBackup pom.xml.versionsBackup -release.properties \ No newline at end of file +release.properties + +# Quarkus +.quarkus/ From 85c46eda88884bb5b08067e5e99bf56e49b78b0d Mon Sep 17 00:00:00 2001 From: Guillaume Smet Date: Wed, 20 Nov 2024 15:01:05 +0100 Subject: [PATCH 2/3] Update to Quarkus 3.15.2 And it will fix Ecosystem CI in passing. --- .../ROOT/pages/includes/attributes.adoc | 2 +- .../includes/quarkus-logging-sentry.adoc | 173 +++++---- .../quarkus-logging-sentry_quarkus.log.adoc | 354 ++++++++++++++++++ docs/pom.xml | 13 +- integration-tests/pom.xml | 7 +- pom.xml | 13 +- runtime/pom.xml | 26 +- 7 files changed, 489 insertions(+), 99 deletions(-) create mode 100644 docs/modules/ROOT/pages/includes/quarkus-logging-sentry_quarkus.log.adoc diff --git a/docs/modules/ROOT/pages/includes/attributes.adoc b/docs/modules/ROOT/pages/includes/attributes.adoc index 4c54862..c3d0809 100644 --- a/docs/modules/ROOT/pages/includes/attributes.adoc +++ b/docs/modules/ROOT/pages/includes/attributes.adoc @@ -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 diff --git a/docs/modules/ROOT/pages/includes/quarkus-logging-sentry.adoc b/docs/modules/ROOT/pages/includes/quarkus-logging-sentry.adoc index 9d9dea7..c3d49fe 100644 --- a/docs/modules/ROOT/pages/includes/quarkus-logging-sentry.adoc +++ b/docs/modules/ROOT/pages/includes/quarkus-logging-sentry.adoc @@ -1,335 +1,354 @@ - -:summaryTableId: quarkus-logging-sentry +: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|[[quarkus-logging-sentry_configuration]]link:#quarkus-logging-sentry_configuration[Configuration property] - +h|[.header-title]##Configuration property## h|Type h|Default -a| [[quarkus-logging-sentry_quarkus.log.sentry]]`link:#quarkus-logging-sentry_quarkus.log.sentry[quarkus.log.sentry]` +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 +-- +|boolean |`false` - -a| [[quarkus-logging-sentry_quarkus.log.sentry.dsn]]`link:#quarkus-logging-sentry_quarkus.log.sentry.dsn[quarkus.log.sentry.dsn]` +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 +-- +|string | - -a| [[quarkus-logging-sentry_quarkus.log.sentry.level]]`link:#quarkus-logging-sentry_quarkus.log.sentry.level[quarkus.log.sentry.level]` +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://docs.jboss.org/jbossas/javadoc/7.1.2.Final/org/jboss/logmanager/Level.html[Level] - +-- +|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]]`link:#quarkus-logging-sentry_quarkus.log.sentry.minimum-event-level[quarkus.log.sentry.minimum-event-level]` +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://docs.jboss.org/jbossas/javadoc/7.1.2.Final/org/jboss/logmanager/Level.html[Level] - +-- +|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]]`link:#quarkus-logging-sentry_quarkus.log.sentry.minimum-breadcrumb-level[quarkus.log.sentry.minimum-breadcrumb-level]` +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://docs.jboss.org/jbossas/javadoc/7.1.2.Final/org/jboss/logmanager/Level.html[Level] - +-- +|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]]`link:#quarkus-logging-sentry_quarkus.log.sentry.in-app-packages[quarkus.log.sentry.in-app-packages]` +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 +-- +|list of string | - -a| [[quarkus-logging-sentry_quarkus.log.sentry.in-app-excluded-packages]]`link:#quarkus-logging-sentry_quarkus.log.sentry.in-app-excluded-packages[quarkus.log.sentry.in-app-excluded-packages]` +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 +-- +|list of string | - -a| [[quarkus-logging-sentry_quarkus.log.sentry.ignored-exceptions-for-type]]`link:#quarkus-logging-sentry_quarkus.log.sentry.ignored-exceptions-for-type[quarkus.log.sentry.ignored-exceptions-for-type]` +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 +-- +|list of string | - -a| [[quarkus-logging-sentry_quarkus.log.sentry.environment]]`link:#quarkus-logging-sentry_quarkus.log.sentry.environment[quarkus.log.sentry.environment]` +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 +-- +|string | - -a| [[quarkus-logging-sentry_quarkus.log.sentry.release]]`link:#quarkus-logging-sentry_quarkus.log.sentry.release[quarkus.log.sentry.release]` +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 +-- +|string | - -a| [[quarkus-logging-sentry_quarkus.log.sentry.server-name]]`link:#quarkus-logging-sentry_quarkus.log.sentry.server-name[quarkus.log.sentry.server-name]` +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 +-- +|string | - -a| [[quarkus-logging-sentry_quarkus.log.sentry.debug]]`link:#quarkus-logging-sentry_quarkus.log.sentry.debug[quarkus.log.sentry.debug]` +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 +-- +|boolean |`false` - -a| [[quarkus-logging-sentry_quarkus.log.sentry.traces-sample-rate]]`link:#quarkus-logging-sentry_quarkus.log.sentry.traces-sample-rate[quarkus.log.sentry.traces-sample-rate]` +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 +-- +|double | - -a| [[quarkus-logging-sentry_quarkus.log.sentry.context-tags]]`link:#quarkus-logging-sentry_quarkus.log.sentry.context-tags[quarkus.log.sentry.context-tags]` +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 +-- +|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 +| -a| [[quarkus-logging-sentry_quarkus.log.sentry.proxy]]`link:#quarkus-logging-sentry_quarkus.log.sentry.proxy[quarkus.log.sentry.proxy]` +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 +-- +|boolean |`false` - -a| [[quarkus-logging-sentry_quarkus.log.sentry.proxy.host]]`link:#quarkus-logging-sentry_quarkus.log.sentry.proxy.host[quarkus.log.sentry.proxy.host]` +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 +-- +|string | - -a| [[quarkus-logging-sentry_quarkus.log.sentry.proxy.port]]`link:#quarkus-logging-sentry_quarkus.log.sentry.proxy.port[quarkus.log.sentry.proxy.port]` +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 +-- +|int | - -a| [[quarkus-logging-sentry_quarkus.log.sentry.proxy.username]]`link:#quarkus-logging-sentry_quarkus.log.sentry.proxy.username[quarkus.log.sentry.proxy.username]` +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 +-- +|string | - -a| [[quarkus-logging-sentry_quarkus.log.sentry.proxy.password]]`link:#quarkus-logging-sentry_quarkus.log.sentry.proxy.password[quarkus.log.sentry.proxy.password]` +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 +-- +|string | +|=== -a| [[quarkus-logging-sentry_quarkus.log.sentry.tags-tags]]`link:#quarkus-logging-sentry_quarkus.log.sentry.tags-tags[quarkus.log.sentry.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+++[] -endif::add-copy-button-to-env-var[] -ifndef::add-copy-button-to-env-var[] -Environment variable: `+++QUARKUS_LOG_SENTRY_TAGS+++` -endif::add-copy-button-to-env-var[] ---|`Map` -| -|=== \ No newline at end of file +:!summaryTableId: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/includes/quarkus-logging-sentry_quarkus.log.adoc b/docs/modules/ROOT/pages/includes/quarkus-logging-sentry_quarkus.log.adoc new file mode 100644 index 0000000..c3d49fe --- /dev/null +++ b/docs/modules/ROOT/pages/includes/quarkus-logging-sentry_quarkus.log.adoc @@ -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 +| + +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: \ No newline at end of file diff --git a/docs/pom.xml b/docs/pom.xml index f6a48ef..cf9f312 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -39,6 +39,14 @@ + + io.quarkus + quarkus-config-doc-maven-plugin + true + + ${project.basedir}/modules/ROOT/pages/includes/ + + maven-resources-plugin @@ -51,11 +59,6 @@ ${project.basedir}/modules/ROOT/pages/includes/ - - ${project.basedir}/../target/asciidoc/generated/config/ - quarkus-logging-sentry.adoc - false - ${project.basedir}/templates/includes attributes.adoc diff --git a/integration-tests/pom.xml b/integration-tests/pom.xml index 8d440ca..95f2145 100644 --- a/integration-tests/pom.xml +++ b/integration-tests/pom.xml @@ -57,6 +57,10 @@ native + + true + false + @@ -85,9 +89,6 @@ - - native - diff --git a/pom.xml b/pom.xml index acb30d4..8c41258 100644 --- a/pom.xml +++ b/pom.xml @@ -22,13 +22,13 @@ HEAD - 3.8.1 + 3.12.1 true - 11 - 11 + 17 + 17 UTF-8 UTF-8 - 3.0.0.Final + 3.15.2 7.8.0 3.26.3 @@ -61,6 +61,11 @@ quarkus-maven-plugin ${quarkus.version} + + io.quarkus + quarkus-config-doc-maven-plugin + ${quarkus.version} + maven-compiler-plugin ${compiler-plugin.version} diff --git a/runtime/pom.xml b/runtime/pom.xml index 7386a99..ecee899 100644 --- a/runtime/pom.xml +++ b/runtime/pom.xml @@ -40,15 +40,23 @@ maven-compiler-plugin - - - - io.quarkus - quarkus-extension-processor - ${quarkus.version} - - - + + + default-compile + + + + io.quarkus + quarkus-extension-processor + ${quarkus.version} + + + + -AlegacyConfigRoot=true + + + + From 47cf90c2e6878a39fa3ee98cfe490b10eb328dfa Mon Sep 17 00:00:00 2001 From: Guillaume Smet Date: Wed, 20 Nov 2024 15:30:35 +0100 Subject: [PATCH 3/3] Clean up POM a bit These elements are defined in quarkiverse-parent. --- pom.xml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/pom.xml b/pom.xml index 8c41258..3d35011 100644 --- a/pom.xml +++ b/pom.xml @@ -22,10 +22,6 @@ HEAD - 3.12.1 - true - 17 - 17 UTF-8 UTF-8 3.15.2 @@ -66,10 +62,6 @@ quarkus-config-doc-maven-plugin ${quarkus.version} - - maven-compiler-plugin - ${compiler-plugin.version} -