org.glowroot.agent.util.RateLimitedLogger Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of glowroot-agent-it-harness Show documentation
Glowroot Agent Integration Test Harness
There is a newer version: 0.14.0-beta.3
Show newest version
/*
 * Copyright 2016-2018 the original author or authors.
 *
 * 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 org.glowroot.agent.util;

import org.glowroot.agent.shaded.org.glowroot.agent.it.harness.shaded.javax.annotation.concurrent.GuardedBy;

import org.glowroot.agent.shaded.org.glowroot.agent.it.harness.shaded.com.google.common.annotations.VisibleForTesting;
import org.glowroot.agent.shaded.org.glowroot.agent.it.harness.shaded.com.google.common.util.concurrent.RateLimiter;
import org.glowroot.agent.shaded.org.checkerframework.checker.nullness.qual.Nullable;
import org.glowroot.agent.shaded.org.glowroot.agent.shaded.org.slf4j.Logger;
import org.glowroot.agent.shaded.org.glowroot.agent.shaded.org.slf4j.LoggerFactory;

public class RateLimitedLogger {

    private final Logger logger;

    private final boolean willKeepTrying;

    private final RateLimiter warningRateLimiter = RateLimiter.create(1.0 / 60);

    @GuardedBy("warningRateLimiter")
    private int countSinceLastWarning;

    public RateLimitedLogger(Class clazz) {
        this(clazz, false);
    }

    public RateLimitedLogger(Class clazz, boolean willKeepTrying) {
        logger = LoggerFactory.getLogger(clazz);
        this.willKeepTrying = willKeepTrying;
    }

    public void warn(String format, /*@Nullable*/ Object... args) {
        int countSinceLastWarning = 0;
        boolean logWarning = false;
        synchronized (warningRateLimiter) {
            if (warningRateLimiter.tryAcquire()) {
                logWarning = true;
                countSinceLastWarning = this.countSinceLastWarning;
                this.countSinceLastWarning = 0;
            } else {
                this.countSinceLastWarning++;
            }
        }
        if (logWarning) {
            // it is important not to perform logging under the above synchronized lock in order to
            // eliminate possibility of deadlock
            if (willKeepTrying) {
                logger.warn(format, args);
            } else if (countSinceLastWarning == 0) {
                logger.warn(format + " (this warning will be logged at most once a minute)",
                        args);
            } else {
                @Nullable
                Object[] argsPlus = newArgsWithCountSinceLastWarning(args, countSinceLastWarning);
                logger.warn(format + " (this warning will be logged at most once a minute, {}"
                        + " warnings were suppressed since it was last logged)", argsPlus);
            }
        }
    }

    @VisibleForTesting
    static @Nullable Object[] newArgsWithCountSinceLastWarning(/*@Nullable*/ Object[] args,
            int countSinceLastWarning) {
        if (args.length == 0) {
            return new Object[] {countSinceLastWarning};
        }
        @Nullable
        Object[] argsPlus = new Object[args.length + 1];
        if (args[args.length - 1] instanceof Throwable) {
            System.arraycopy(args, 0, argsPlus, 0, args.length - 1);
            argsPlus[args.length - 1] = countSinceLastWarning;
            argsPlus[args.length] = args[args.length - 1];
            return argsPlus;
        } else {
            System.arraycopy(args, 0, argsPlus, 0, args.length);
            argsPlus[args.length] = countSinceLastWarning;
            return argsPlus;
        }
    }
}