hazelcast-master/hazelcast/src/main/java/com/hazelcast/internal/monitor/LocalFlakeIdGeneratorStats.java
/*
 * Copyright (c) 2008-2023, Hazelcast, 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.hazelcast.internal.monitor;

import com.hazelcast.instance.LocalInstanceStats;

/**
 * local flake ID statistics to be used by {@link MemberState} implementations.
 */
public interface LocalFlakeIdGeneratorStats extends LocalInstanceStats {

    /**
     * The average batch size can be calculated by dividing {@link #getIdCount()} by
     * {@code getBatchCount()}.
     *
     * @return the total number of times the ID generator has been used to generate
     * a new ID batch since its {@link #getCreationTime()}.
     */
    long getBatchCount();

    /**
     * Note that the ID count returned is the number of generated IDs not the number
     * of consumed IDs.
     *
     * @return the total number of IDs generated (the sum of IDs for all batches)
     * since its {@link #getCreationTime()}.
     */
    long getIdCount();
}
