com.palantir.atlasdb.logging.LoggingArgs Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of atlasdb-client Show documentation
Palantir open source project
There is a newer version: 0.1152.0
/*
 * (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.logging;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Stopwatch;
import com.google.common.collect.Collections2;
import com.google.common.collect.Iterables;
import com.palantir.atlasdb.encoding.PtBytes;
import com.palantir.atlasdb.keyvalue.api.BatchColumnRangeSelection;
import com.palantir.atlasdb.keyvalue.api.ColumnRangeSelection;
import com.palantir.atlasdb.keyvalue.api.ColumnSelection;
import com.palantir.atlasdb.keyvalue.api.RangeRequest;
import com.palantir.atlasdb.keyvalue.api.TableReference;
import com.palantir.atlasdb.keyvalue.impl.AbstractKeyValueService;
import com.palantir.logsafe.Arg;
import com.palantir.logsafe.SafeArg;
import com.palantir.logsafe.Unsafe;
import com.palantir.logsafe.UnsafeArg;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.concurrent.TimeUnit;
import org.immutables.value.Value;

/**
 * Includes utilities for generating logging args that may be safe or unsafe, depending on table metadata.
 *
 * Always returns unsafe, until hydrated.
 *
 * Note that many methods of this class return {@link Arg} objects that may or may not be safe for logging. Some of
 * these are annotated as {@link Unsafe} (which prevents users from wrapping these Args in a {@link SafeArg}), though
 * users should generally just use the Arg object directly.
 */
public final class LoggingArgs {

    private static final String PLACEHOLDER_TABLE_NAME = "{table}";

    public static final TableReference PLACEHOLDER_TABLE_REFERENCE =
            TableReference.createWithEmptyNamespace(PLACEHOLDER_TABLE_NAME);

    @Unsafe
    @Value.Immutable
    public interface SafeAndUnsafeTableReferences {
        SafeArg> safeTableRefs();

        UnsafeArg> unsafeTableRefs();
    }

    private static volatile KeyValueServiceLogArbitrator logArbitrator = KeyValueServiceLogArbitrator.ALL_UNSAFE;
    private static Optional allSafeForLogging = Optional.empty();

    private LoggingArgs() {
        // no
    }

    public static synchronized void hydrate(Map tableRefToMetadata) {
        logArbitrator = SafeLoggableDataUtils.fromTableMetadata(tableRefToMetadata);
    }

    public static synchronized void combineAndSetNewAllSafeForLoggingFlag(
            boolean isNewKeyValueServiceAllSafeForLogging) {
        if (!allSafeForLogging.isPresent()) {
            // if allSafeForLogging is never set, set it to the new keyValueService's allSafeForLogging setting
            allSafeForLogging = Optional.of(isNewKeyValueServiceAllSafeForLogging);
        } else {
            // if allSafeForLogging is currently safe, but the newKeyValueService is not allSafeForLogging by default
            // set the global allSafeForLogging flag to false
            if (!isNewKeyValueServiceAllSafeForLogging) {
                allSafeForLogging = Optional.of(isNewKeyValueServiceAllSafeForLogging);
            }
        }

        if (allSafeForLogging.get()) {
            logArbitrator = KeyValueServiceLogArbitrator.ALL_SAFE;
        }
    }

    @VisibleForTesting
    static synchronized void setLogArbitrator(KeyValueServiceLogArbitrator arbitrator) {
        logArbitrator = arbitrator;
    }

    @Unsafe
    public static Arg internalTableName(TableReference tableReference) {
        return safeInternalTableName(AbstractKeyValueService.internalTableName(tableReference));
    }

    public static SafeAndUnsafeTableReferences tableRefs(Collection tableReferences) {
        List safeTableRefs = new ArrayList<>();
        List unsafeTableRefs = new ArrayList<>();

        for (TableReference tableRef : tableReferences) {
            if (logArbitrator.isTableReferenceSafe(tableRef)) {
                safeTableRefs.add(tableRef);
            } else {
                unsafeTableRefs.add(tableRef);
            }
        }

        return ImmutableSafeAndUnsafeTableReferences.builder()
                .safeTableRefs(SafeArg.of("safeTableRefs", safeTableRefs))
                .unsafeTableRefs(UnsafeArg.of("unsafeTableRefs", unsafeTableRefs))
                .build();
    }

    public static Iterable safeTablesOrPlaceholder(Collection tables) {
        //noinspection StaticPseudoFunctionalStyleMethod - Use lazy iterator.
        return Collections2.transform(tables, LoggingArgs::safeTableOrPlaceholder);
    }

    /**
     * Returns a safe or unsafe arg corresponding to the supplied table reference, with name "tableRef".
     */
    @Unsafe
    public static Arg tableRef(TableReference tableReference) {
        return tableRef("tableRef", tableReference);
    }

    public static boolean isSafe(TableReference tableReference) {
        return logArbitrator.isTableReferenceSafe(tableReference);
    }

    /**
     * If table is safe, returns the table. If unsafe, returns a placeholder.
     */
    public static TableReference safeTableOrPlaceholder(TableReference tableReference) {
        if (logArbitrator.isTableReferenceSafe(tableReference)) {
            return tableReference;
        } else {
            return PLACEHOLDER_TABLE_REFERENCE;
        }
    }

    /**
     * If table is safe, returns the table. If unsafe, returns a placeholder name.
     */
    public static String safeInternalTableNameOrPlaceholder(String internalTableReference) {
        if (logArbitrator.isInternalTableReferenceSafe(internalTableReference)) {
            return internalTableReference;
        } else {
            return PLACEHOLDER_TABLE_NAME;
        }
    }

    @Unsafe
    public static Arg safeInternalTableName(String internalTableReference) {
        if (logArbitrator.isInternalTableReferenceSafe(internalTableReference)) {
            return SafeArg.of("tableRef", internalTableReference);
        } else {
            return UnsafeArg.of("unsafeTableRef", internalTableReference);
        }
    }

    @Unsafe
    public static Arg tableRef(String argName, TableReference tableReference) {
        return getArg(argName, tableReference.toString(), logArbitrator.isTableReferenceSafe(tableReference));
    }

    @Unsafe
    public static Arg customTableName(TableReference tableReference, String tableName) {
        return getArg("tableName", tableName, logArbitrator.isTableReferenceSafe(tableReference));
    }

    @Unsafe
    public static Arg durationMillis(Stopwatch stopwatch) {
        return getArg("durationMillis", stopwatch.elapsed(TimeUnit.MILLISECONDS), true);
    }

    @Unsafe
    public static Arg startTimeMillis(long startTime) {
        return getArg("startTimeMillis", startTime, true);
    }

    @Unsafe
    public static Arg method(String method) {
        return getArg("method", method, true);
    }

    @Unsafe
    public static Arg cellCount(int cellCount) {
        return getArg("cellCount", cellCount, true);
    }

    @Unsafe
    public static Arg tableCount(int tableCount) {
        return getArg("tableCount", tableCount, true);
    }

    @Unsafe
    public static Arg keyCount(int keyCount) {
        return getArg("keyCount", keyCount, true);
    }

    @Unsafe
    public static Arg rowCount(int rowCount) {
        return getArg("rowCount", rowCount, true);
    }

    @Unsafe
    public static Arg sizeInBytes(long sizeInBytes) {
        return getArg("sizeInBytes", sizeInBytes, true);
    }

    @Unsafe
    public static Arg columnCount(ColumnSelection columnSelection) {
        return getArg(
                "columnCount",
                columnSelection.allColumnsSelected() ? "all" : Iterables.size(columnSelection.getSelectedColumns()),
                true);
    }

    @Unsafe
    public static Arg columnCount(int numberOfColumns) {
        return getArg("columnCount", numberOfColumns == Integer.MAX_VALUE ? "all" : numberOfColumns, true);
    }

    @Unsafe
    public static Arg batchHint(int batchHint) {
        return getArg("batchHint", batchHint, true);
    }

    @Unsafe
    public static Arg range(TableReference tableReference, RangeRequest range) {
        return getArg(
                "range",
                range,
                range.getColumnNames().stream()
                        .allMatch(columnName ->
                                logArbitrator.isColumnNameSafe(tableReference, PtBytes.toString(columnName))));
    }

    @Unsafe
    public static Arg batchColumnRangeSelection(
            BatchColumnRangeSelection batchColumnRangeSelection) {
        return getArg("batchColumnRangeSelection", batchColumnRangeSelection, false);
    }

    @Unsafe
    public static Arg columnRangeSelection(ColumnRangeSelection columnRangeSelection) {
        return getArg("columnRangeSelection", columnRangeSelection, false);
    }

    @Unsafe
    private static  Arg getArg(String name, T value, boolean safe) {
        return safe ? SafeArg.of(name, value) : UnsafeArg.of(name, value);
    }
}