com.palantir.atlasdb.config.SweepConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of atlasdb-config 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.config;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import com.palantir.atlasdb.AtlasDbConstants;
import com.palantir.atlasdb.sweep.priority.SweepPriorityOverrideConfig;
import com.palantir.logsafe.Preconditions;
import java.util.Optional;
import org.immutables.value.Value;

@JsonDeserialize(as = ImmutableSweepConfig.class)
@JsonSerialize(as = ImmutableSweepConfig.class)
@Value.Immutable
public abstract class SweepConfig {
    /**
     * If true, a background thread will periodically delete cells that have been overwritten or deleted. This differs
     * from scrubbing because it is an untargeted cleaning process that scans all data looking for cells to delete.
     *
     * If unspecified, AtlasDB will decide whether to run the background sweeper or not. This may depend on factors
     * elsewhere in configuration.
     */
    @Value.Default
    public boolean enabled() {
        return false;
    }

    // TODO handle live reload
    /**
     * The number of background sweep threads to run.
     */
    @Value.Default
    public int sweepThreads() {
        return 1;
    }

    /**
     * The number of milliseconds to wait between each batch of cells processed by the background sweeper.
     */
    @Value.Default
    public long pauseMillis() {
        return AtlasDbConstants.DEFAULT_SWEEP_PAUSE_MILLIS;
    }

    /**
     * The target number of (cell, timestamp) pairs to examine in a single run of the background sweeper.
     */
    @Value.Default
    public Integer readLimit() {
        return AtlasDbConstants.DEFAULT_SWEEP_READ_LIMIT;
    }

    /**
     * The target number of candidate (cell, timestamp) pairs to load per batch while sweeping.
     */
    public abstract Optional candidateBatchHint();

    /**
     * The target number of (cell, timestamp) pairs to delete at once while sweeping.
     */
    @Value.Default
    public Integer deleteBatchHint() {
        return AtlasDbConstants.DEFAULT_SWEEP_DELETE_BATCH_HINT;
    }

    /**
     * The number of cells to be written before information on write patterns to a given table is flushed into
     * the sweep priority table (thus increasing the probability that the background sweeper selects it).
     */
    @Value.Default
    public Integer writeThreshold() {
        return AtlasDbConstants.DEFAULT_SWEEP_WRITE_THRESHOLD;
    }

    /**
     * The number of bytes to be written before information on write patterns to a given table is flushed into
     * the sweep priority table (thus increasing the probability that the background sweeper selects it).
     */
    @Value.Default
    public Long writeSizeThreshold() {
        return AtlasDbConstants.DEFAULT_SWEEP_WRITE_SIZE_THRESHOLD;
    }

    @Value.Default
    public SweepPriorityOverrideConfig sweepPriorityOverrides() {
        return SweepPriorityOverrideConfig.defaultConfig();
    }

    @Value.Check
    public void check() {
        Preconditions.checkState(
                sweepThreads() > 0,
                "Must have a positive number of threads! "
                        + "If your intention was to disable sweep, please set enabled to false.");
    }

    public static SweepConfig defaultSweepConfig() {
        return ImmutableSweepConfig.builder().build();
    }

    public static SweepConfig disabled() {
        return ImmutableSweepConfig.builder().enabled(false).build();
    }
}