Skip to content

Add Spring Boot version to MongoDB driver handshake and append metadata for user-provided clients #50449

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
alexbevi wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Add Spring Boot version to MongoDB driver handshake and append metadata for user-provided clients #50449

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
de08df8
feat: add Spring Boot version to MongoDB driver handshake metadata
alexbevi May 15, 2026
2cf279b
feat: append MongoDB client metadata for user-provided MongoClient
alexbevi May 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions ...g/springframework/boot/data/mongodb/autoconfigure/DataMongoReactiveAutoConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,11 @@

package org.springframework.boot.data.mongodb.autoconfigure;

import java.lang.reflect.Method;
import java.util.Optional;

import com.mongodb.ClientSessionOptions;
import com.mongodb.MongoDriverInformation;
import com.mongodb.reactivestreams.client.ClientSession;
import com.mongodb.reactivestreams.client.MongoClient;
import com.mongodb.reactivestreams.client.MongoDatabase;
Expand All @@ -27,6 +29,7 @@
import org.jspecify.annotations.Nullable;
import reactor.core.publisher.Mono;

import org.springframework.boot.SpringBootVersion;
import org.springframework.boot.autoconfigure.AutoConfiguration;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
Expand Down Expand Up @@ -76,10 +79,16 @@
@Import(DataMongoConfiguration.class)
public final class DataMongoReactiveAutoConfiguration {

private static final MongoDriverInformation DRIVER_INFO = MongoDriverInformation.builder()
.driverName("spring-boot")
.driverVersion(SpringBootVersion.getVersion())
.build();

@Bean
@ConditionalOnMissingBean(ReactiveMongoDatabaseFactory.class)
SimpleReactiveMongoDatabaseFactory reactiveMongoDatabaseFactory(MongoProperties properties, MongoClient mongo,
MongoConnectionDetails connectionDetails) {
appendMetadata(mongo);
String database = properties.getDatabase();
if (database == null) {
database = connectionDetails.getConnectionString().getDatabase();
Expand All @@ -88,6 +97,16 @@ SimpleReactiveMongoDatabaseFactory reactiveMongoDatabaseFactory(MongoProperties
return new SimpleReactiveMongoDatabaseFactory(mongo, database);
}

private static void appendMetadata(MongoClient mongoClient) {
try {
Method method = mongoClient.getClass().getMethod("appendMetadata", MongoDriverInformation.class);
method.invoke(mongoClient, DRIVER_INFO);
}
catch (Exception ex) {
// appendMetadata not available in this driver version — skip silently
}
}

@Bean
@ConditionalOnMissingBean(ReactiveMongoOperations.class)
ReactiveMongoTemplate reactiveMongoTemplate(ReactiveMongoDatabaseFactory reactiveMongoDatabaseFactory,
Expand Down
20 changes: 20 additions & 0 deletions ...rg/springframework/boot/data/mongodb/autoconfigure/MongoDatabaseFactoryConfiguration.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,12 @@

package org.springframework.boot.data.mongodb.autoconfigure;

import java.lang.reflect.Method;

import com.mongodb.MongoDriverInformation;
import com.mongodb.client.MongoClient;

import org.springframework.boot.SpringBootVersion;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnSingleCandidate;
import org.springframework.boot.mongodb.autoconfigure.MongoConnectionDetails;
Expand All @@ -43,9 +47,15 @@
@ConditionalOnSingleCandidate(MongoClient.class)
class MongoDatabaseFactoryConfiguration {

private static final MongoDriverInformation DRIVER_INFO = MongoDriverInformation.builder()
.driverName("spring-boot")
.driverVersion(SpringBootVersion.getVersion())
.build();

@Bean
MongoDatabaseFactorySupport<?> mongoDatabaseFactory(MongoClient mongoClient, MongoProperties properties,
MongoConnectionDetails connectionDetails) {
appendMetadata(mongoClient);
String database = properties.getDatabase();
if (database == null) {
database = connectionDetails.getConnectionString().getDatabase();
Expand All @@ -54,4 +64,14 @@ MongoDatabaseFactorySupport<?> mongoDatabaseFactory(MongoClient mongoClient, Mon
return new SimpleMongoClientDatabaseFactory(mongoClient, database);
}

private static void appendMetadata(MongoClient mongoClient) {
try {
Method method = mongoClient.getClass().getMethod("appendMetadata", MongoDriverInformation.class);
method.invoke(mongoClient, DRIVER_INFO);
}
catch (Exception ex) {
// appendMetadata not available in this driver version — skip silently
}
}

}
3 changes: 3 additions & 0 deletions ...c/main/java/org/springframework/boot/mongodb/autoconfigure/MongoClientFactorySupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@
import com.mongodb.MongoDriverInformation;
import org.jspecify.annotations.Nullable;

import org.springframework.boot.SpringBootVersion;

/**
* Base class for setup that is common to MongoDB client factories.
*
Expand Down Expand Up @@ -60,6 +62,7 @@ private void customize(Builder builder) {
private MongoDriverInformation driverInformation() {
return MongoDriverInformation.builder(MongoDriverInformation.builder().build())
.driverName("spring-boot")
.driverVersion(SpringBootVersion.getVersion())
.build();
}

Expand Down
Loading