com.palantir.atlasdb.keyvalue.cassandra.CqlQuery Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of atlasdb-cassandra Show documentation
Palantir open source project
The newest version!
/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * 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
 *
 *     http://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 com.palantir.atlasdb.keyvalue.cassandra;

import com.google.common.base.Stopwatch;
import com.palantir.atlasdb.logging.KvsProfilingLogger;
import com.palantir.atlasdb.logging.LoggingArgs;
import com.palantir.logsafe.Arg;
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.UnsafeArg;
import java.util.List;
import org.immutables.value.Value;

@Value.Immutable
public abstract class CqlQuery {
    public abstract String safeQueryFormat();

    public abstract List> args();

    @Override
    public String toString() {
        return String.format(safeQueryFormat(), args().toArray());
    }

    public static ImmutableCqlQuery.Builder builder() {
        return ImmutableCqlQuery.builder();
    }

    public void logSlowResult(KvsProfilingLogger.LoggingFunction log, Stopwatch timer) {
        Object[] allArgs = new Object[args().size() + 3];
        allArgs[0] = SafeArg.of("queryFormat", safeQueryFormat());
        allArgs[1] = UnsafeArg.of("fullQuery", toString());
        allArgs[2] = LoggingArgs.durationMillis(timer);
        System.arraycopy(args().toArray(), 0, allArgs, 3, args().size());

        log.log("A CQL query was slow: queryFormat = [{}], fullQuery = [{}], durationMillis = {}", allArgs);
    }

    /**
     * Returns safe string representation of the query.
     */
    public String getSafeLog() {
        StringBuilder buffer = new StringBuilder().append(safeQueryFormat()).append(": ");
        boolean first = true;
        for (Arg arg : args()) {
            if (arg.isSafeForLogging()) {
                if (!first) {
                    buffer.append(", ");
                }
                first = false;
                buffer.append(arg.getName()).append(" = ").append(arg.getValue());
            }
        }
        return buffer.toString();
    }
}