Support Spring boot 4

[toon-borgers-hs]

Is your feature request related to a problem? Please describe.

In spring boot 4 the structure of packages has been changed and there is a modularization.

In the spring boot autoconfiguration, org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration is referenced in JdbcInstrumentationAutoConfiguration. This is now moved to the org.springframework.boot.jdbc.autoconfigure package.

Describe the solution you'd like

In november Spring Boot 4 is scheduled to release. It would be good if by then there's support for the changed packages.

Describe alternatives you've considered

No response

Additional context

No response

Tip

_{React with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding +1 or me too, to help us triage it. Learn more here.}

[bjorntj]

Is there a workaround for this while we wait?

[toon-borgers-hs]

@bjorntj I excluded the JdbcInstrumentationAutoConfiguration class from autoconfiguration and created a own version that uses the correct import

[bjorntj]

Aaah.. Never done that before, do you want to share how you did that? 😇

[toon-borgers-hs]

@bjorntj Create a class like following:

public class JdbcInstrumentationAutoConfigurationFilter implements AutoConfigurationImportFilter {

  private static final String JDBC_INSTRUMENTATION_AUTO_CONFIGURATION =
      "io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.jdbc.JdbcInstrumentationAutoConfiguration";

  @Override
  public boolean[] match(
      @Nullable String[] autoConfigurationClasses,
      AutoConfigurationMetadata autoConfigurationMetadata) {
    boolean[] matches = new boolean[autoConfigurationClasses.length];

    for (int i = 0; i < autoConfigurationClasses.length; i++) {
      matches[i] = !JDBC_INSTRUMENTATION_AUTO_CONFIGURATION.equals(autoConfigurationClasses[i]);
    }
    return matches;
  }
}

And include this by creating a file resources/META-INF/spring.factories with following content:

org.springframework.boot.autoconfigure.AutoConfigurationImportFilter=io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.jdbc.JdbcInstrumentationAutoConfigurationFilter

Next, create a class with the correct import:

package io.opentelemetry.instrumentation.spring.autoconfigure.internal.instrumentation.jdbc;

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.instrumentation.spring.autoconfigure.internal.ConditionalOnEnabledInstrumentation;
import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
import javax.sql.DataSource;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.jdbc.autoconfigure.DataSourceAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@ConditionalOnEnabledInstrumentation(module = "jdbc")
@AutoConfiguration(after = DataSourceAutoConfiguration.class)
@ConditionalOnBean({DataSource.class})
@Configuration(proxyBeanMethods = false)
public class JdbcInstrumentationAutoConfigurationPatch {
  @Bean
  // static to avoid "is not eligible for getting processed by all BeanPostProcessors" warning
  static DataSourcePostProcessor dataSourcePostProcessor(
      ObjectProvider<OpenTelemetry> openTelemetryProvider,
      ObjectProvider<ConfigProperties> configPropertiesProvider) {
    return new DataSourcePostProcessor(openTelemetryProvider, configPropertiesProvider);
  }
}

And import it with the META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports file

[bjorntj]

I say.. Will try this tonight. Thx! 🙂

[bjorntj]

Had to create my own DataSourcePostProcessor class also but with a little help from Mr. AI it seems to be working. 😊

[bjorntj]

I see new version has been released but without a fix for this. Any reason not to fix this as well?

[breedx-splk]

I see new version has been released but without a fix for this. Any reason not to fix this as well?

PRs are welcome.

[vinsguru]

I see that traceparent header is NOT propagated in spring boot 4 as part of webmvc module.

[bjorntj]

I see new version has been released but without a fix for this. Any reason not to fix this as well?

PRs are welcome.

Yes, I would if I could but this is a bit out of my league. 😇

[jaydeluca]

hey all, I have been picking away at this with the hope of getting things in place before the next agent release, but there is a lot of moving parts (and it is a holiday week here in the U.S.).

I am going to try and summarize where I believe things are at, but input and help is welcome in analyzing and working on everything. Some instrumentations need to be fixed, and others just need some configuration changes in order to make the tests work with the new module structure. There might be some spring 7 stuff mixed in here too that isn't necessary spring boot related.

Here are what I think to be the remaining modules in need of fixing, but again, I could be missing something:

• opentelemetry spring starter - I have a draft PR open: [Spring Starter] Spring boot 4 support #15459.
  • I think I am getting close to having a green build, having some trouble reproducing some of the native test failures locally so it's slow moving
  • some additional diligence will be good to ensure all classes have been addressed that were moved, even if we don't have explicit test coverage for them
• spring-cloud-aws-3.0
  • waiting on spring cloud 4.0 release: https://github.com/awspring/spring-cloud-aws/milestone/42
• spring-cloud-gateway
  • I have a branch for this in progress, but from what I can tell spring cloud gateway is trying to import WebMvcAutoConfiguration using the old package path from Spring Boot 3.x
    (org.springframework.boot.autoconfigure.web.servlet), but in Spring Boot 4, this class moved to org.springframework.boot.webmvc.autoconfigure. Perhaps there's a way around this, but needs more work
• spring-webflux-5.0
  • I haven't been able to spend much time on this one yet. Help wanted.
• spring-webmvc-6.0
  • I have a branch for this one, but something changed and the deferredResult tests are failing. Still trying to investigate what needs to be patched to fix the async flows