Skip to content

Migration Guide 3.13

Jump to bottom
Clement Escoffier edited this page Sep 13, 2024 · 24 revisions
Note

We highly recommend the use of quarkus update to update to a new version of Quarkus.

Items marked below with ⚙️ ✅ are automatically handled by quarkus update.

Redis Client

Fixed parameter ordering in JSON.MGET

The JsonCommands.jsonMget() method (and similar methods like ReactiveJsonCommands.jsonMget()) declare parameters in the following order:

  • String path

  • K... keys

This is opposite to the Redis JSON.MGET command, which accepts keys first and path last.

The implementation of the jsonMget() method used to follow the Redis order, despite its own declaration. That is, the path had to be last, even though it should be first.

This is now fixed. All users of this method have to check and fix the call sites.

OpenTelemetry

Many changes on this release, affecting documentation, Metrics support and breaking changes due to the new semantic conventions for HTTP.

OpenTelemetry metrics support

Added with experimental status, please set quarkus.otel.metrics.enabled=true to enable it at build time.

Now you can create OpenTelemetry Metrics by following the Metrics Guide.

There are no automatic OpenTelemetry metrics instrumentation in Quarkus, for now. Metrics in Quarkus are implemented by the Micrometer extension. We plan to provide, in the future, a bridge for those metrics to be available in OpenTelemetry as well.

Documentation updates

The old OpenTelemetry guide has been split into this generic guide, the OpenTelemetry Tracing Guide and the new OpenTelemetry Metrics Guide has been created.

Breaking Changes

  • Upgrade to OpenTelemetry SDK 1.39.0 and OpenTelemetry instrumentation 2.5.0. We haven’t upgraded OpenTelemetry for a while to allow a transition period from the old, deprecated HTTP semantic conventions, as announced in this wiki migration guide for Quarkus 3.9 and the Dev mailing list. The transition period has now ended with the upgrade of the OpenTelemetry SDK to 1.39.0 and OpenTelemetry instrumentation to 2.5.0. These versions require the new semantic conventions for HTTP. The full list of changes.

  • quarkus.otel.semconv-stability.opt-in system property was removed because users cannot opt-in anymore;

  • DB Span names have changed in the case of table creation;

  • Deprecated annotation for io.opentelemetry.extension.annotations.WithSpan has been removed. Please use the new io.opentelemetry.instrumentation.annotations.WithSpan, as previously announced.

Grafana LGTM (all-in-one) Observability Dev Service

The extension now detects which extensions (Otel, Micrometer OTLP registry) are being used and sets their properties accordingly. No need to configure the application.properties file for this anymore. The documentation was also updated.

Breaking Change

The following properties are removed because they are not needed anymore:

  • quarkus.otel-collector.url

  • quarkus.grafana.url

Hibernate ORM

Auto-flush optimization

Starting with Quarkus 3.13, before executing a JPQL/HQL or native query, Hibernate ORM will only flush pending changes to the database if it detects that the query results may be impacted by these changes.

This optimization was available for a long time in Hibernate ORM, but was disabled by mistake in Quarkus 1.13, causing performance issues ever since.

Most applications should only experience performance improvements (better batching), but some might run into problems:

Tip
 If you want to revert to the old behavior, this is possible starting with Quarkus 3.15 through configuration property quarkus.hibernate-orm.flush.mode. See this entry of the Quarkus 3.15 migration guide for more information.

@QuarkusTestResource replaced by @WithTestResource

While we initially planned replacing @QuarkusTestResource with @WithTestResource, some severe issues led us to reconsider this plan.

Thus, while you will see that @QuarkusTestResource has been deprecated in 3.13, we will undeprecate it in 3.14 so please keep using it and don’t move to @WithTestResource.

You can have a look at https://groups.google.com/g/quarkus-dev/c/rS8-WN6b7XQ for more details.

Quarkus CLI

The default behaviour of calling quarkus config is to display the help text for all subcommands instead of calling set.

config set

  • The Options name and value are now Parameters. For instance, to set the configuration foo=bar, the previous command was quarkus config set --name=foo --value=bar. The new command is quarkus config set foo bar.

  • No longer removes the configuration if it exists from application.properties when the value parameter is omitted from the command. Now, there is a specific subcommand to remove configuration quarkus config remove NAME

config encrypt

  • The Option secret is now a Parameter. For instance, to encrypt a value, the previous command was quarkus config encrypt --secret=12345678. The new command is quarkus config encrypt 1234578.

Dev Services startup detection change

The way we check if Dev Services should be started has changed. We used to check if a property was defined to know if we should start the Dev Services or not without expanding it but it was causing issues if in the end the property was empty when expanded. We now check that the expanded property is empty, which might lead to the Dev Services being started while they weren’t in some cases.

For instance, people using the quarkus-test-oidc-server component to mock the OIDC server will have to adjust their configuration due to a change in how we check the presence of configuration property in the Dev Services startup code. Note that this particular example that is quite common is handled by quarkus update ⚙️ ✅.

If you have this in your application.properties:

%test.quarkus.oidc.auth-server-url=${keycloak.url}/realms/quarkus/

You should change it to this: 

%test.quarkus.oidc.auth-server-url=${keycloak.url:replaced-by-test-resource}/realms/quarkus/
Clone this wiki locally