Align tracing tag names with OpenTelemetry spec.

See #1321
Original pull request: #1322

Author: mp911de

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

@@ -39,11 +39,6 @@ public String getName() {
 			return "spring.data.cassandra.query";
 		}
 
-		@Override
-		public String getContextualName() {
-			return "query";
-		}
-
 		@Override
 		public KeyName[] getLowCardinalityKeyNames() {
 			return LowCardinalityKeyNames.values();
@@ -54,21 +49,77 @@ public KeyName[] getHighCardinalityKeyNames() {
 			return HighCardinalityKeyNames.values();
 		}
 
-		@Override
-		public String getPrefix() {
-			return "spring.data.cassandra.";
-		}
 	};
 
 	enum LowCardinalityKeyNames implements KeyName {
 
+		/**
+		 * Database system.
+		 */
+		DATABASE_SYSTEM {
+			@Override
+			public String asString() {
+				return "db.system";
+			}
+		},
+
+		/**
+		 * Network transport.
+		 */
+		NET_TRANSPORT {
+			@Override
+			public String asString() {
+				return "net.transport";
+			}
+		},
+
+		/**
+		 * Name of the database host.
+		 */
+		NET_PEER_NAME {
+			@Override
+			public String asString() {
+				return "net.peer.name";
+			}
+		},
+
+		/**
+		 * Logical remote port number.
+		 */
+		NET_PEER_PORT {
+			@Override
+			public String asString() {
+				return "net.peer.port";
+			}
+		},
+
+		/**
+		 * Cassandra peer address.
+		 */
+		NET_SOCK_PEER_ADDR {
+			@Override
+			public String asString() {
+				return "net.sock.peer.addr";
+			}
+		},
+
+		/**
+		 * Cassandra peer port.
+		 */
+		NET_SOCK_PEER_PORT {
+			@Override
+			public String asString() {
+				return "net.sock.peer.port";
+			}
+		},
+
 		/**
 		 * Name of the Cassandra keyspace.
 		 */
 		KEYSPACE_NAME {
 			@Override
 			public String asString() {
-				return "spring.data.cassandra.keyspace";
+				return "db.name";
 			}
 		},
 
@@ -93,26 +144,57 @@ public String asString() {
 		},
 
 		/**
-		 * Cassandra URL
+		 * The database operation.
 		 */
-		URL {
+		DB_OPERATION {
 			@Override
 			public String asString() {
-				return "spring.data.cassandra.url";
+				return "db.operation";
 			}
 		},
 
+		COORDINATOR {
+			@Override
+			public String asString() {
+				return "db.cassandra.coordinator.id";
+			}
+		},
+		COORDINATOR_DC {
+			@Override
+			public String asString() {
+				return "db.cassandra.coordinator.dc";
+			}
+		}
 	}
 
 	enum HighCardinalityKeyNames implements KeyName {
 
 		/**
 		 * A key-value containing Cassandra CQL.
 		 */
-		CQL_TAG {
+		DB_STATEMENT {
+			@Override
+			public String asString() {
+				return "db.statement";
+			}
+		},
+
+		PAGE_SIZE {
+			@Override
+			public String asString() {
+				return "db.cassandra.page_size";
+			}
+		},
+		CONSISTENCY_LEVEL {
+			@Override
+			public String asString() {
+				return "db.cassandra.consistency_level";
+			}
+		},
+		IDEMPOTENCE {
 			@Override
 			public String asString() {
-				return "spring.data.cassandra.cql";
+				return "db.cassandra.idempotence";
 			}
 		},
 

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

@@ -15,8 +15,11 @@
  */
 package org.springframework.data.cassandra.observability;
 
+import org.springframework.lang.Nullable;
+
 import com.datastax.oss.driver.api.core.CqlSession;
 import com.datastax.oss.driver.api.core.cql.Statement;
+import com.datastax.oss.driver.api.core.metadata.Node;
 
 import io.micrometer.observation.Observation;
 import io.micrometer.observation.transport.Kind;
@@ -38,6 +41,8 @@ public class CassandraObservationContext extends SenderContext<Object> {
 	private final String sessionName;
 	private final String keyspaceName;
 
+	private volatile @Nullable Node node;
+
 	public CassandraObservationContext(Statement<?> statement, String remoteServiceName, boolean prepare,
 			String methodName, String sessionName, String keyspaceName) {
 
@@ -71,4 +76,13 @@ public String getSessionName() {
 	public String getKeyspaceName() {
 		return keyspaceName;
 	}
+
+	public void setNode(Node node) {
+		this.node = node;
+	}
+
+	@Nullable
+	public Node getNode() {
+		return node;
+	}
 }

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/observability/CqlSessionObservationInterceptor.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.
@@ -39,7 +39,7 @@
  * @author Mark Paluch
  * @author Marcin Grzejszczak
  * @author Greg Turnquist
- * @since 4.0.0
+ * @since 4.0
  */
 final class CqlSessionObservationInterceptor implements MethodInterceptor {
 

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/observability/DefaultCassandraObservationConvention.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,17 +15,22 @@
  */
 package org.springframework.data.cassandra.observability;
 
+import java.net.InetSocketAddress;
 import java.util.StringJoiner;
 
 import org.springframework.data.cassandra.observability.CassandraObservation.HighCardinalityKeyNames;
 import org.springframework.data.cassandra.observability.CassandraObservation.LowCardinalityKeyNames;
+import org.springframework.lang.Nullable;
 import org.springframework.util.StringUtils;
 
+import com.datastax.oss.driver.api.core.ConsistencyLevel;
 import com.datastax.oss.driver.api.core.cql.BatchStatement;
 import com.datastax.oss.driver.api.core.cql.BatchableStatement;
 import com.datastax.oss.driver.api.core.cql.BoundStatement;
 import com.datastax.oss.driver.api.core.cql.SimpleStatement;
 import com.datastax.oss.driver.api.core.cql.Statement;
+import com.datastax.oss.driver.api.core.metadata.EndPoint;
+import com.datastax.oss.driver.api.core.metadata.Node;
 
 import io.micrometer.common.KeyValues;
 
@@ -41,26 +46,79 @@ class DefaultCassandraObservationConvention implements CassandraObservationConve
 	@Override
 	public KeyValues getLowCardinalityKeyValues(CassandraObservationContext context) {
 
-		KeyValues keyValues = KeyValues.of(LowCardinalityKeyNames.SESSION_NAME.withValue(context.getSessionName()),
+		String dbOperation = context.isPrepare() ? "PREPARE" : getOperationName(getCql(context.getStatement()), "");
+
+		KeyValues keyValues = KeyValues.of(LowCardinalityKeyNames.DATABASE_SYSTEM.withValue("cassandra"),
 				LowCardinalityKeyNames.KEYSPACE_NAME.withValue(context.getKeyspaceName()),
-				LowCardinalityKeyNames.METHOD_NAME.withValue(context.getMethodName()));
+				LowCardinalityKeyNames.SESSION_NAME.withValue(context.getSessionName()),
+				LowCardinalityKeyNames.METHOD_NAME.withValue(context.getMethodName()),
+				LowCardinalityKeyNames.DB_OPERATION.withValue(dbOperation));
+
+		Node node = context.getNode();
+
+		if (node == null) {
+			node = context.getStatement().getNode();
+		}
+
+		if (node != null) {
+
+			EndPoint endPoint = node.getEndPoint();
 
-		if (context.getStatement().getNode() != null) {
-			keyValues = keyValues.and(
-					LowCardinalityKeyNames.URL.withValue(context.getStatement().getNode().getEndPoint().resolve().toString()));
+			keyValues = keyValues.and(LowCardinalityKeyNames.COORDINATOR.withValue("" + node.getHostId()),
+					LowCardinalityKeyNames.COORDINATOR_DC.withValue("" + node.getDatacenter()));
+
+			keyValues.and(LowCardinalityKeyNames.NET_PEER_NAME.withValue(endPoint.toString()));
+			InetSocketAddress socketAddress = tryGetSocketAddress(endPoint);
+
+			if (socketAddress != null) {
+
+				keyValues = keyValues.and(LowCardinalityKeyNames.NET_TRANSPORT.withValue("IP.TCP"),
+						LowCardinalityKeyNames.NET_SOCK_PEER_ADDR.withValue(socketAddress.getHostString()),
+						LowCardinalityKeyNames.NET_SOCK_PEER_PORT.withValue("" + socketAddress.getPort()));
+			}
 		}
 
 		return keyValues;
 	}
 
 	@Override
 	public KeyValues getHighCardinalityKeyValues(CassandraObservationContext context) {
-		return KeyValues.of(HighCardinalityKeyNames.CQL_TAG.withValue(getCql(context.getStatement())));
+
+		Statement<?> statement = context.getStatement();
+
+		KeyValues keyValues = KeyValues.of(HighCardinalityKeyNames.DB_STATEMENT.withValue(getCql(statement)),
+				HighCardinalityKeyNames.PAGE_SIZE.withValue("" + statement.getPageSize()));
+
+		Boolean idempotent = statement.isIdempotent();
+		if (idempotent != null) {
+			keyValues = keyValues
+					.and(HighCardinalityKeyNames.IDEMPOTENCE.withValue(idempotent ? "idempotent" : "non-idempotent"));
+		}
+
+		ConsistencyLevel consistencyLevel = statement.getConsistencyLevel();
+		if (consistencyLevel != null) {
+			keyValues = keyValues.and(HighCardinalityKeyNames.CONSISTENCY_LEVEL.withValue("" + consistencyLevel.name()));
+		}
+
+		return keyValues;
+	}
+
+	@Nullable
+	private InetSocketAddress tryGetSocketAddress(EndPoint endPoint) {
+
+		try {
+			if (endPoint.resolve()instanceof InetSocketAddress inet) {
+				return inet;
+			}
+
+		} catch (RuntimeException e) {}
+
+		return null;
 	}
 
 	@Override
 	public String getContextualName(CassandraObservationContext context) {
-		return (context.isPrepare() ? "PREPARE: " : "") + getSpanName(getCql(context.getStatement()), "");
+		return (context.isPrepare() ? "PREPARE: " : "") + getOperationName(getCql(context.getStatement()), "");
 	}
 
 	/**
@@ -116,7 +174,7 @@ private static String getQuery(Statement<?> statement) {
 	 * @param defaultName if there's no query
 	 * @return span name
 	 */
-	public String getSpanName(String cql, String defaultName) {
+	public String getOperationName(String cql, String defaultName) {
 
 		if (StringUtils.hasText(cql) && cql.indexOf(' ') > -1) {
 			return cql.substring(0, cql.indexOf(' '));

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/observability/ObservableCqlSessionFactory.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.

spring-data-cassandra/src/main/java/org/springframework/data/cassandra/observability/ObservableReactiveSessionFactory.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.