Polishing.

Add request tracker integration to capture completion/error responses. Add reactive integration. Properly observe prepare requests. Simplify documentation.

See #1321
Original pull request: #1322

Author: mp911de

spring-data-cassandra-distribution/pom.xml

@@ -42,48 +42,30 @@
 				<artifactId>exec-maven-plugin</artifactId>
 				<executions>
 					<execution>
-						<id>generate-metrics-metadata</id>
+						<id>generate-docs</id>
 						<phase>generate-resources</phase>
 						<goals>
 							<goal>java</goal>
 						</goals>
 						<configuration>
-							<mainClass>io.micrometer.docs.metrics.DocsFromSources</mainClass>
-						</configuration>
-					</execution>
-					<execution>
-						<id>generate-tracing-metadata</id>
-						<phase>generate-resources</phase>
-						<goals>
-							<goal>java</goal>
-						</goals>
-						<configuration>
-							<mainClass>io.micrometer.docs.spans.DocsFromSources</mainClass>
+							<mainClass>io.micrometer.docs.DocsGeneratorCommand</mainClass>
+							<includePluginDependencies>true</includePluginDependencies>
+							<arguments>
+								<argument>${micrometer-docs-generator.inputPath}</argument>
+								<argument>${micrometer-docs-generator.inclusionPattern}</argument>
+								<argument>${micrometer-docs-generator.outputPath}</argument>
+							</arguments>
 						</configuration>
 					</execution>
 				</executions>
 				<dependencies>
 					<dependency>
 						<groupId>io.micrometer</groupId>
-						<artifactId>micrometer-docs-generator-spans</artifactId>
-						<version>${micrometer-docs-generator}</version>
-						<type>jar</type>
-					</dependency>
-					<dependency>
-						<groupId>io.micrometer</groupId>
-						<artifactId>micrometer-docs-generator-metrics</artifactId>
+						<artifactId>micrometer-docs-generator</artifactId>
 						<version>${micrometer-docs-generator}</version>
 						<type>jar</type>
 					</dependency>
 				</dependencies>
-				<configuration>
-					<includePluginDependencies>true</includePluginDependencies>
-					<arguments>
-						<argument>${micrometer-docs-generator.inputPath}</argument>
-						<argument>${micrometer-docs-generator.inclusionPattern}</argument>
-						<argument>${micrometer-docs-generator.outputPath}</argument>
-					</arguments>
-				</configuration>
 			</plugin>
 			<plugin>
 				<groupId>org.asciidoctor</groupId>

spring-data-cassandra/pom.xml

@@ -77,6 +77,7 @@
 			<artifactId>micrometer-observation</artifactId>
 			<optional>true</optional>
 		</dependency>
+
 		<dependency>
 			<groupId>io.micrometer</groupId>
 			<artifactId>micrometer-tracing</artifactId>
@@ -87,6 +88,12 @@
 			<groupId>io.micrometer</groupId>
 			<artifactId>micrometer-test</artifactId>
 			<scope>test</scope>
+			<exclusions>
+				<exclusion>
+					<groupId>com.github.tomakehurst</groupId>
+					<artifactId>wiremock-jre8-standalone</artifactId>
+				</exclusion>
+			</exclusions>
 		</dependency>
 
 		<dependency>

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/config/AbstractSessionConfiguration.java

@@ -256,13 +256,14 @@ protected Resource getDriverConfigurationResource() {
 	}
 
 	/**
-	 * Returns the list of CQL scripts to be run on startup after {@link #getKeyspaceCreations() Keyspace creations}
-	 * and after initialization of the {@literal System} Keyspace.
+	 * Returns the list of CQL scripts to be run on startup after {@link #getKeyspaceCreations() Keyspace creations} and
+	 * after initialization of the {@literal System} Keyspace. return super.getSessionBuilderConfigurer();
 	 *
-	 * @return the list of CQL scripts to be run on startup; may be {@link Collections#emptyList() empty}
-	 * but never {@literal null}.
+	 * @return the list of CQL scripts to be run on startup; may be {@link Collections#emptyList() empty} but never
+	 *         {@literal null}.
 	 * @deprecated since 3.0; Declare a
-	 * {@link org.springframework.data.cassandra.core.cql.session.init.SessionFactoryInitializer} bean instead.
+	 *             {@link org.springframework.data.cassandra.core.cql.session.init.SessionFactoryInitializer} bean
+	 *             instead.
 	 */
 	@Deprecated
 	protected List<String> getStartupScripts() {

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/observability/CassandraObservation.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2022 the original author or authors.
+ * Copyright 2022 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.
@@ -17,14 +17,15 @@
 
 import io.micrometer.common.docs.KeyName;
 import io.micrometer.observation.docs.ObservationDocumentation;
+import io.micrometer.tracing.docs.EventValue;
 
 /**
  * Cassandra-based implementation of {@link ObservationDocumentation}.
  *
  * @author Mark Paluch
  * @author Marcin Grzejszczak
  * @author Greg Turnquist
- * @since 4.0.0
+ * @since 4.0
  */
 enum CassandraObservation implements ObservationDocumentation {
 
@@ -101,6 +102,20 @@ public String asString() {
 			}
 		},
 
+	}
+
+	enum HighCardinalityKeyNames implements KeyName {
+
+		/**
+		 * A key-value containing Cassandra CQL.
+		 */
+		CQL_TAG {
+			@Override
+			public String asString() {
+				return "spring.data.cassandra.cql";
+			}
+		},
+
 		/**
 		 * A tag containing error that occurred for the given node.
 		 */
@@ -110,18 +125,30 @@ public String asString() {
 				return "spring.data.cassandra.node[%s].error";
 			}
 		}
+
 	}
 
-	enum HighCardinalityKeyNames implements KeyName {
+	enum Events implements EventValue {
 
 		/**
-		 * A key-value containing Cassandra CQL.
+		 * Set whenever an error occurred for the given node.
 		 */
-		CQL_TAG {
+		NODE_ERROR {
 			@Override
-			public String asString() {
-				return "spring.data.cassandra.cql";
+			public String getValue() {
+				return "cassandra.node.error";
+			}
+		},
+
+		/**
+		 * Set when a success occurred for the session processing.
+		 */
+		NODE_SUCCESS {
+			@Override
+			public String getValue() {
+				return "cassandra.node.success";
 			}
 		}
+
 	}
 }

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/observability/CassandraObservationConfiguration.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2022 the original author or authors.
+ * Copyright 2022 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.
@@ -15,43 +15,60 @@
  */
 package org.springframework.data.cassandra.observability;
 
-import io.micrometer.observation.Observation;
-
-import org.springframework.lang.Nullable;
-
 import com.datastax.oss.driver.api.core.CqlSession;
 import com.datastax.oss.driver.api.core.cql.Statement;
 
+import io.micrometer.observation.Observation;
+import io.micrometer.observation.transport.Kind;
+import io.micrometer.observation.transport.SenderContext;
+
 /**
  * A {@link Observation.Context} for {@link CqlSession}.
  *
  * @author Greg Turnquist
- * @since 4.0.0
+ * @author Mark Paluch
+ * @since 4.0
  */
-public class CqlSessionContext extends Observation.Context {
+public class CassandraObservationContext extends SenderContext<Object> {
+
+	private final Statement<?> statement;
 
-	private final @Nullable Statement<?> statement;
+	private final boolean prepare;
 	private final String methodName;
-	private final @Nullable CqlSession delegateSession;
+	private final String sessionName;
+	private final String keyspaceName;
 
-	public CqlSessionContext(@Nullable Statement<?> statement, String methodName, @Nullable CqlSession delegateSession) {
+	public CassandraObservationContext(Statement<?> statement, String remoteServiceName, boolean prepare,
+			String methodName, String sessionName, String keyspaceName) {
+
+		super((carrier, key, value) -> {}, Kind.CLIENT);
 
 		this.statement = statement;
+		this.prepare = prepare;
 		this.methodName = methodName;
-		this.delegateSession = delegateSession;
+		this.sessionName = sessionName;
+		this.keyspaceName = keyspaceName;
+
+		setRemoteServiceName(remoteServiceName);
 	}
 
-	@Nullable
 	public Statement<?> getStatement() {
 		return statement;
 	}
 
+	public boolean isPrepare() {
+		return prepare;
+	}
+
 	public String getMethodName() {
 		return methodName;
 	}
 
-	@Nullable
-	public CqlSession getDelegateSession() {
-		return delegateSession;
+	public String getSessionName() {
+		return sessionName;
+	}
+
+	public String getKeyspaceName() {
+		return keyspaceName;
 	}
 }

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/observability/CqlSessionContext.java renamed to spring-data-cassandra/src/main/java/org/springframework/data/cassandra/observability/CassandraObservationContext.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2022 the original author or authors.
+ * Copyright 2022 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.
@@ -22,12 +22,12 @@
  * {@link ObservationConvention} for Cassandra.
  *
  * @author Greg Turnquist
- * @since 4.0.0
+ * @since 4.0
  */
-public interface CqlSessionObservationConvention extends ObservationConvention<CqlSessionContext> {
+public interface CassandraObservationConvention extends ObservationConvention<CassandraObservationContext> {
 
 	@Override
 	default boolean supportsContext(Observation.Context context) {
-		return context instanceof CqlSessionContext;
+		return context instanceof CassandraObservationContext;
 	}
 }

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/observability/CqlSessionObservationConvention.java renamed to spring-data-cassandra/src/main/java/org/springframework/data/cassandra/observability/CassandraObservationConvention.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2013-2022 the original author or authors.
+ * Copyright 2022 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.
@@ -15,20 +15,20 @@
  */
 package org.springframework.data.cassandra.observability;
 
-import java.lang.annotation.*;
-
-import org.springframework.context.annotation.Import;
+import io.micrometer.observation.Observation;
 
 /**
- * Annotation to enable Cassandra observability.
+ * Returns the Cassandra Observation. Used internally - do not implement.
  *
- * @author Greg Turnquist
- * @since 4.0.0
+ * @author Mark Paluch
+ * @author Marcin Grzejszczak
+ * @since 4.0
  */
-@Inherited
-@Documented
-@Target(ElementType.TYPE)
-@Retention(RetentionPolicy.RUNTIME)
-@Import(CassandraObservationConfiguration.class)
-public @interface EnableCassandraObservability {
+interface CassandraObservationSupplier {
+
+	/**
+	 * @return the observation
+	 */
+	Observation getObservation();
+
 }