org.apache.kafka.common.metrics.stats.WindowedCount Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kafka-clients Show documentation

There is a newer version: 3.9.0

/*
 * 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.kafka.common.metrics.stats;

import org.apache.kafka.common.metrics.MetricConfig;

/**
 * A {@link SampledStat} that maintains a simple count of what it has seen.
 * This is a special kind of {@link WindowedSum} that always records a value of {@code 1} instead of the provided value.
 * In other words, it counts the number of
 * {@link WindowedCount#record(MetricConfig, double, long)} invocations,
 * instead of summing the recorded values.
 *
 * See also {@link CumulativeCount} for a non-sampled version of this metric.
 */
public class WindowedCount extends WindowedSum {
    @Override
    protected void update(Sample sample, MetricConfig config, double value, long now) {
        super.update(sample, config, 1.0, now);
    }
}