Spring/spring-data-cassandra
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATACASS-808 - Fix CQL statement logging.

Browse Source 
We now attempt to extract the CQL query from various Statement and CqlProvider objects to log the CQL query.

Previously, the logger used the statement object with didn't render the query.
This commit is contained in:
Mark Paluch
2020-09-30 15:56:36 +02:00
parent 244f4f9a00
commit 4f332dc5ac
7 changed files with 148 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/cql/AsyncCqlTemplate.java
View File

@@ -163,7 +163,7 @@ public class AsyncCqlTemplate extends CassandraAccessor implements AsyncCqlOpera
try {
if (logger.isDebugEnabled()) {
logger.debug("Executing CQL Statement [{}]", cql);
logger.debug("Executing CQL statement [{}]", cql);
}
CompletionStage<T> results = getCurrentSession().executeAsync(applyStatementSettings(newStatement(cql)))
@@ -285,7 +285,7 @@ public class AsyncCqlTemplate extends CassandraAccessor implements AsyncCqlOpera
try {
if (logger.isDebugEnabled()) {
logger.debug("Executing CQL Statement [{}]", statement);
logger.debug("Executing statement [{}]", QueryExtractorDelegate.getCql(statement));
}
CompletionStage<T> results = getCurrentSession() //
@@ -525,7 +525,7 @@ public class AsyncCqlTemplate extends CassandraAccessor implements AsyncCqlOpera
ListenableFuture<Statement<?>> statementFuture = new MappingListenableFutureAdapter<>(
preparedStatementCreator.createPreparedStatement(session), preparedStatement -> {
if (logger.isDebugEnabled()) {
logger.debug("Executing prepared statement [{}]", preparedStatement);
logger.debug("Executing prepared statement [{}]", QueryExtractorDelegate.getCql(preparedStatement));
}
return applyStatementSettings(psb != null ? psb.bindValues(preparedStatement) : preparedStatement.bind());

8
spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/cql/CassandraAccessor.java
View File

@@ -16,7 +16,6 @@
package org.springframework.data.cassandra.core.cql;
import java.util.Map;
import java.util.Optional;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
@@ -464,11 +463,6 @@ public class CassandraAccessor implements InitializingBean {
*/
@Nullable
protected static String toCql(@Nullable Object cqlProvider) {
return Optional.ofNullable(cqlProvider) //
.filter(o -> o instanceof CqlProvider) //
.map(o -> (CqlProvider) o) //
.map(CqlProvider::getCql) //
.orElse(null);
return QueryExtractorDelegate.getCql(cqlProvider);
}
}

6
spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/cql/CqlTemplate.java
View File

@@ -162,7 +162,7 @@ public class CqlTemplate extends CassandraAccessor implements CqlOperations {
try {
if (logger.isDebugEnabled()) {
logger.debug("Executing CQL Statement [{}]", cql);
logger.debug("Executing CQL statement [{}]", cql);
}
Statement<?> statement = applyStatementSettings(newStatement(cql));
@@ -288,7 +288,7 @@ public class CqlTemplate extends CassandraAccessor implements CqlOperations {
try {
if (logger.isDebugEnabled()) {
logger.debug("Executing CQL Statement [{}]", statement);
logger.debug("Executing statement [{}]", QueryExtractorDelegate.getCql(statement));
}
return resultSetExtractor.extractData(getCurrentSession().execute(applyStatementSettings(statement)));
@@ -507,7 +507,7 @@ public class CqlTemplate extends CassandraAccessor implements CqlOperations {
PreparedStatement preparedStatement = preparedStatementCreator.createPreparedStatement(session);
if (logger.isDebugEnabled()) {
logger.debug("Executing prepared statement [{}]", preparedStatement);
logger.debug("Executing prepared statement [{}]", QueryExtractorDelegate.getCql(preparedStatement));
}
Statement<?> boundStatement = applyStatementSettings(

79
spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/cql/QueryExtractorDelegate.java Normal file
View File

@@ -0,0 +1,79 @@
/*
* Copyright 2020 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.cassandra.core.cql;
import org.springframework.lang.Nullable;
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.PreparedStatement;
import com.datastax.oss.driver.api.core.cql.SimpleStatement;
import com.datastax.oss.driver.api.core.cql.Statement;
/**
* Utility to extract CQL queries from a {@link Statement}.
*
* @author Mark Paluch
* @since 3.0.5
*/
public class QueryExtractorDelegate {
/**
* Try to extract the {@link SimpleStatement#getQuery() CQL query} from a statement object.
*
* @param statement the statement object.
* @return the CQL query when {@code statement} is not {@code null}.
*/
@Nullable
public static String getCql(@Nullable Object statement) {
if (statement == null) {
return null;
}
if (statement instanceof CqlProvider) {
return ((CqlProvider) statement).getCql();
}
if (statement instanceof SimpleStatement) {
return ((SimpleStatement) statement).getQuery();
}
if (statement instanceof PreparedStatement) {
return ((PreparedStatement) statement).getQuery();
}
if (statement instanceof BoundStatement) {
return getCql(((BoundStatement) statement).getPreparedStatement());
}
if (statement instanceof BatchStatement) {
StringBuilder builder = new StringBuilder();
for (BatchableStatement<?> batchableStatement : ((BatchStatement) statement)) {
String query = getCql(batchableStatement);
builder.append(query).append(query.endsWith(";") ? "" : ";");
}
return builder.toString();
}
return String.format("Unknown: %s", statement);
}
}

23
spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/cql/ReactiveCqlTemplate.java
View File

@@ -440,7 +440,7 @@ public class ReactiveCqlTemplate extends ReactiveCassandraAccessor implements Re
return createFlux(statement, (session, stmt) -> {
if (logger.isDebugEnabled()) {
logger.debug("Executing CQL Statement [{}]", statement);
logger.debug("Executing statement [{}]", QueryExtractorDelegate.getCql(statement));
}
return session.execute(applyStatementSettings(statement)).flatMapMany(rse::extractData);
@@ -507,8 +507,7 @@ public class ReactiveCqlTemplate extends ReactiveCassandraAccessor implements Re
return createMono(statement, (session, executedStatement) -> {
if (logger.isDebugEnabled()) {
logger.debug("Executing CQL [{}]", executedStatement);
logger.debug("Executing statement [{}]", QueryExtractorDelegate.getCql(statement));
}
return session.execute(applyStatementSettings(executedStatement));
@@ -568,14 +567,15 @@ public class ReactiveCqlTemplate extends ReactiveCassandraAccessor implements Re
Assert.notNull(psc, "ReactivePreparedStatementCreator must not be null");
Assert.notNull(rse, "ReactiveResultSetExtractor object must not be null");
return execute(psc, (session, ps) -> Mono.just(ps).flatMapMany(pps -> {
return execute(psc, (session, preparedStatement) -> Mono.just(preparedStatement).flatMapMany(pps -> {
if (logger.isDebugEnabled()) {
logger.debug("Executing Prepared CQL Statement [{}]", ps.getQuery());
logger.debug("Executing prepared statement [{}]", QueryExtractorDelegate.getCql(preparedStatement));
}
BoundStatement boundStatement = (preparedStatementBinder != null ? preparedStatementBinder.bindValues(ps)
: ps.bind());
BoundStatement boundStatement = (preparedStatementBinder != null
? preparedStatementBinder.bindValues(preparedStatement)
: preparedStatement.bind());
return session.execute(applyStatementSettings(boundStatement));
}).flatMap(rse::extractData)).onErrorMap(translateException("Query", getCql(psc)));
@@ -738,7 +738,7 @@ public class ReactiveCqlTemplate extends ReactiveCassandraAccessor implements Re
return execute(newReactivePreparedStatementCreator(cql), (session, ps) -> Flux.from(args).flatMap(objects -> {
if (logger.isDebugEnabled()) {
logger.debug("Executing Prepared CQL Statement [{}]", cql);
logger.debug("Executing prepared CQL statement [{}]", cql);
}
BoundStatement boundStatement = newArgPreparedStatementBinder(objects).bindValues(ps);
@@ -918,12 +918,7 @@ public class ReactiveCqlTemplate extends ReactiveCassandraAccessor implements Re
*/
@Nullable
private static String getCql(@Nullable Object cqlProvider) {
return Optional.ofNullable(cqlProvider) //
.filter(o -> o instanceof CqlProvider) //
.map(o -> (CqlProvider) o) //
.map(CqlProvider::getCql) //
.orElse(null);
return QueryExtractorDelegate.getCql(cqlProvider);
}
static class SimpleReactivePreparedStatementCreator implements ReactivePreparedStatementCreator, CqlProvider {

60
spring-data-cassandra/src/main/java/org/springframework/data/cassandra/core/cql/session/DefaultBridgedReactiveSession.java
View File

@@ -15,30 +15,35 @@
*/
package org.springframework.data.cassandra.core.cql.session;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.core.publisher.MonoProcessor;
import reactor.core.scheduler.Scheduler;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletionStage;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.data.cassandra.ReactiveResultSet;
import org.springframework.data.cassandra.ReactiveSession;
import org.springframework.util.Assert;
import com.datastax.oss.driver.api.core.CqlSession;
import com.datastax.oss.driver.api.core.context.DriverContext;
import com.datastax.oss.driver.api.core.cql.AsyncResultSet;
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.ColumnDefinitions;
import com.datastax.oss.driver.api.core.cql.ExecutionInfo;
import com.datastax.oss.driver.api.core.cql.PreparedStatement;
import com.datastax.oss.driver.api.core.cql.Row;
import com.datastax.oss.driver.api.core.cql.SimpleStatement;
import com.datastax.oss.driver.api.core.cql.Statement;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import reactor.core.publisher.Flux;
import reactor.core.publisher.Mono;
import reactor.core.publisher.MonoProcessor;
import reactor.core.scheduler.Scheduler;
import org.springframework.data.cassandra.ReactiveResultSet;
import org.springframework.data.cassandra.ReactiveSession;
import org.springframework.util.Assert;
/**
* Default implementation of a {@link ReactiveSession}. This implementation bridges asynchronous {@link CqlSession}
@@ -142,7 +147,7 @@ public class DefaultBridgedReactiveSession implements ReactiveSession {
return Mono.fromCompletionStage(() -> {
if (logger.isDebugEnabled()) {
logger.debug("Executing Statement [{}]", statement);
logger.debug("Executing statement [{}]", getCql(statement));
}
return this.session.executeAsync(statement);
@@ -171,13 +176,43 @@ public class DefaultBridgedReactiveSession implements ReactiveSession {
return Mono.fromCompletionStage(() -> {
if (logger.isDebugEnabled()) {
logger.debug("Preparing Statement [{}]", statement);
logger.debug("Preparing statement [{}]", getCql(statement));
}
return this.session.prepareAsync(statement);
});
}
private static String getCql(Object statement) {
if (statement instanceof SimpleStatement) {
return ((SimpleStatement) statement).getQuery();
}
if (statement instanceof PreparedStatement) {
return ((PreparedStatement) statement).getQuery();
}
if (statement instanceof BoundStatement) {
return getCql(((BoundStatement) statement).getPreparedStatement());
}
if (statement instanceof BatchStatement) {
StringBuilder builder = new StringBuilder();
for (BatchableStatement<?> batchableStatement : ((BatchStatement) statement)) {
String query = getCql(batchableStatement);
builder.append(query).append(query.endsWith(";") ? "" : ";");
}
return builder.toString();
}
return String.format("Unknown: %s", statement);
}
/* (non-Javadoc)
* @see org.springframework.data.cassandra.ReactiveSession#close()
*/
@@ -291,4 +326,5 @@ public class DefaultBridgedReactiveSession implements ReactiveSession {
return Collections.singletonList(getExecutionInfo());
}
}
}

9
spring-data-cassandra/src/main/java/org/springframework/data/cassandra/repository/query/QueryStatementCreator.java
View File

@@ -23,6 +23,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.data.cassandra.core.StatementFactory;
import org.springframework.data.cassandra.core.cql.QueryExtractorDelegate;
import org.springframework.data.cassandra.core.cql.QueryOptions;
import org.springframework.data.cassandra.core.cql.QueryOptionsUtil;
import org.springframework.data.cassandra.core.mapping.CassandraPersistentEntity;
@@ -115,7 +116,7 @@ class QueryStatementCreator {
SimpleStatement statement = statementFactory.count(query, getPersistentEntity()).build();
if (LOG.isDebugEnabled()) {
LOG.debug(String.format("Created query [%s].", statement));
LOG.debug(String.format("Created query [%s].", QueryExtractorDelegate.getCql(statement)));
}
return statement;
@@ -142,7 +143,7 @@ class QueryStatementCreator {
SimpleStatement statement = statementFactory.delete(query, getPersistentEntity()).build();
if (LOG.isDebugEnabled()) {
LOG.debug(String.format("Created query [%s].", statement));
LOG.debug(String.format("Created query [%s].", QueryExtractorDelegate.getCql(statement)));
}
return statement;
@@ -169,7 +170,7 @@ class QueryStatementCreator {
SimpleStatement statement = statementFactory.select(query.limit(1), getPersistentEntity()).build();
if (LOG.isDebugEnabled()) {
LOG.debug(String.format("Created query [%s].", statement));
LOG.debug(String.format("Created query [%s].", QueryExtractorDelegate.getCql(statement)));
}
return statement;
@@ -254,7 +255,7 @@ class QueryStatementCreator {
}
if (LOG.isDebugEnabled()) {
LOG.debug(String.format("Created query [%s].", queryToUse));
LOG.debug(String.format("Created query [%s].", QueryExtractorDelegate.getCql(queryToUse)));
}
return queryToUse;