RateLogger.java

/*
 * 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.zookeeper.server;

import java.util.Objects;
import org.apache.zookeeper.common.Time;
import org.slf4j.Logger;

/**
 * This logs the message once in the beginning and once every LOG_INTERVAL.
 */
public class RateLogger {

    private final long LOG_INTERVAL; // Duration is in ms

    public RateLogger(Logger log) {
        this(log, 100);
    }

    public RateLogger(Logger log, long interval) {
        LOG = log;
        LOG_INTERVAL = interval;
    }

    private final Logger LOG;
    private String msg = null;
    private long timestamp;
    private int count = 0;
    private String value = null;

    public void flush() {
        if (msg != null && count > 0) {
            // Optimized logging using parameterized messages to reduce string concatenation overhead
            if (count > 1) {
                if (value != null) {
                    LOG.warn("[{} times] Message: {} Last value:{}", count, msg, value);
                } else {
                    LOG.warn("[{} times] Message: {}", count, msg);
                }
            } else {
                if (value != null) {
                    LOG.warn("Message: {} Value:{}", msg, value);
                } else {
                    LOG.warn("Message: {}", msg);
                }
            }
        }
        msg = null;
        value = null;
        count = 0;
    }

    public void rateLimitLog(String newMsg) {
        rateLimitLog(newMsg, null);
    }

    /**
     * In addition to the message, it also takes a value.
     */
    public void rateLimitLog(String newMsg, String newValue) {
        long now = Time.currentElapsedTime();
        // Optimized string comparison: use reference equality first for constant strings
        if (newMsg == msg || Objects.equals(newMsg, msg)) {
            ++count;
            value = newValue;
            if (now - timestamp >= LOG_INTERVAL) {
                flush();
                msg = newMsg;
                timestamp = now;
                value = newValue;
            }
        } else {
            flush();
            msg = newMsg;
            value = newValue;
            timestamp = now;
            LOG.warn("Message:{} Value:{}", msg, value);
        }
    }

}