Class MongoObservationCommandListener

java.lang.Object

org.springframework.data.mongodb.observability.MongoObservationCommandListener

All Implemented Interfaces:

com.mongodb.event.CommandListener

@Deprecated(since="5.1",
            forRemoval=true)
public class MongoObservationCommandListener
extends Object
implements com.mongodb.event.CommandListener

Deprecated, for removal: This API element is subject to removal in a future version.

since 5.1 in favor of native MongoDB Java Driver observability support.

Implement MongoDB's CommandListener using Micrometer's Observation API.

NOTE: MongoDB Java Driver 5.7+ comes with observability directly built in which can be configured via MongoClientSettings.Builder#observabilitySettings(ObservabilitySettings). We recommend switching to the driver native observability.

Since:

4.0

Author:

OpenZipkin Brave Authors, Marcin Grzejszczak, Greg Turnquist, François Kha

Constructor Summary

Constructors

Constructor	Description
MongoObservationCommandListener(io.micrometer.observation.ObservationRegistry observationRegistry)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new MongoObservationCommandListener to record Observations.
MongoObservationCommandListener(io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable com.mongodb.ConnectionString connectionString)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new MongoObservationCommandListener to record Observations.
MongoObservationCommandListener(io.micrometer.observation.ObservationRegistry observationRegistry, @Nullable com.mongodb.ConnectionString connectionString, MongoHandlerObservationConvention observationConvention)	Deprecated, for removal: This API element is subject to removal in a future version. Create a new MongoObservationCommandListener to record Observations.

Method Summary

Modifier and Type	Method	Description
void	commandFailed(com.mongodb.event.CommandFailedEvent event)	Deprecated, for removal: This API element is subject to removal in a future version.
void	commandStarted(com.mongodb.event.CommandStartedEvent event)	Deprecated, for removal: This API element is subject to removal in a future version.
void	commandSucceeded(com.mongodb.event.CommandSucceededEvent event)	Deprecated, for removal: This API element is subject to removal in a future version.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MongoObservationCommandListener

public MongoObservationCommandListener(io.micrometer.observation.ObservationRegistry observationRegistry)

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new MongoObservationCommandListener to record Observations.

Parameters:

observationRegistry - must not be null

MongoObservationCommandListener

public MongoObservationCommandListener(io.micrometer.observation.ObservationRegistry observationRegistry,
 @Nullable com.mongodb.ConnectionString connectionString)

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new MongoObservationCommandListener to record Observations. This constructor attaches the ConnectionString to every Observation.

Parameters:

observationRegistry - must not be null

connectionString - can be null

MongoObservationCommandListener

public MongoObservationCommandListener(io.micrometer.observation.ObservationRegistry observationRegistry,
 @Nullable com.mongodb.ConnectionString connectionString,
 MongoHandlerObservationConvention observationConvention)

Deprecated, for removal: This API element is subject to removal in a future version.

Create a new MongoObservationCommandListener to record Observations. This constructor attaches the ConnectionString to every Observation and uses the given MongoHandlerObservationConvention.

Parameters:

observationRegistry - must not be null

connectionString - can be null

observationConvention - must not be null

Since:

4.3

Method Details

commandStarted

public void commandStarted(com.mongodb.event.CommandStartedEvent event)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

commandStarted in interface com.mongodb.event.CommandListener

commandSucceeded

public void commandSucceeded(com.mongodb.event.CommandSucceededEvent event)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

commandSucceeded in interface com.mongodb.event.CommandListener

commandFailed

public void commandFailed(com.mongodb.event.CommandFailedEvent event)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

commandFailed in interface com.mongodb.event.CommandListener