org.apache.flink.runtime.checkpoint.CompletedCheckpointStatsSummary Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-runtime Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 org.apache.flink.runtime.checkpoint;

import java.io.Serializable;

import static org.apache.flink.util.Preconditions.checkNotNull;

/** Summary over all completed checkpoints. */
public class CompletedCheckpointStatsSummary implements Serializable {

    private static final long serialVersionUID = 5784360461635814038L;

    private static final int HISTOGRAM_WINDOW_SIZE = 10_000; // ~300Kb per job with four histograms

    /** State size statistics for all completed checkpoints. */
    private final StatsSummary stateSize;

    private final StatsSummary checkpointedSize;

    /** Duration statistics for all completed checkpoints. */
    private final StatsSummary duration;

    private final StatsSummary processedData;

    private final StatsSummary persistedData;

    CompletedCheckpointStatsSummary() {
        this(
                new StatsSummary(HISTOGRAM_WINDOW_SIZE),
                new StatsSummary(HISTOGRAM_WINDOW_SIZE),
                new StatsSummary(HISTOGRAM_WINDOW_SIZE),
                new StatsSummary(HISTOGRAM_WINDOW_SIZE),
                new StatsSummary(HISTOGRAM_WINDOW_SIZE));
    }

    private CompletedCheckpointStatsSummary(
            StatsSummary stateSize,
            StatsSummary checkpointedSize,
            StatsSummary duration,
            StatsSummary processedData,
            StatsSummary persistedData) {

        this.stateSize = checkNotNull(stateSize);
        this.checkpointedSize = checkNotNull(checkpointedSize);
        this.duration = checkNotNull(duration);
        this.processedData = checkNotNull(processedData);
        this.persistedData = checkNotNull(persistedData);
    }

    /**
     * Updates the summary with the given completed checkpoint.
     *
     * @param completed Completed checkpoint to update the summary with.
     */
    void updateSummary(CompletedCheckpointStats completed) {
        stateSize.add(completed.getStateSize());
        checkpointedSize.add(completed.getCheckpointedSize());
        duration.add(completed.getEndToEndDuration());
        processedData.add(completed.getProcessedData());
        persistedData.add(completed.getPersistedData());
    }

    /**
     * Creates a snapshot of the current state.
     *
     * @return A snapshot of the current state.
     */
    CompletedCheckpointStatsSummarySnapshot createSnapshot() {
        return new CompletedCheckpointStatsSummarySnapshot(
                duration.createSnapshot(),
                processedData.createSnapshot(),
                persistedData.createSnapshot(),
                stateSize.createSnapshot(),
                checkpointedSize.createSnapshot());
    }

    /**
     * Returns the summary stats for the state size of completed checkpoints.
     *
     * @return Summary stats for the state size.
     */
    public StatsSummary getStateSizeStats() {
        return stateSize;
    }

    /**
     * Returns the summary stats for the duration of completed checkpoints.
     *
     * @return Summary stats for the duration.
     */
    public StatsSummary getEndToEndDurationStats() {
        return duration;
    }

    public StatsSummary getProcessedDataStats() {
        return processedData;
    }

    public StatsSummary getPersistedDataStats() {
        return persistedData;
    }
}