MongoHandlerObservationConvention.java

/*
 * Copyright 2022-present the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.data.mongodb.observability;

import io.micrometer.observation.Observation;
import io.micrometer.observation.ObservationConvention;

/**
 * {@link ObservationConvention} for {@link MongoHandlerContext}.
 * <p>
 * <strong>NOTE:</strong> MongoDB Java Driver 5.7+ comes with observability directly built in which can be configured
 * via {@code MongoClientSettings.Builder#observabilitySettings(ObservabilitySettings)}.
 * We recommend switching to the driver native observability.
 * 
 * @author Greg Turnquist
 * @since 4
 * @deprecated since 5.1 in favor of native MongoDB Java Driver observability support.
 */
@Deprecated(since = "5.1",  forRemoval = true)
public interface MongoHandlerObservationConvention extends ObservationConvention<MongoHandlerContext> {

	@Override
	default boolean supportsContext(Observation.Context context) {
		return context instanceof MongoHandlerContext;
	}
}