org.opensearch.index.SlowLogLevel Maven / Gradle / Ivy

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * The OpenSearch Contributors require contributions made to
 * this file be licensed under the Apache-2.0 license or a
 * compatible open source license.
 */

/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch 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.
 */
/*
 * Modifications Copyright OpenSearch Contributors. See
 * GitHub history for details.
 */

package org.opensearch.index;

import java.util.Locale;

public enum SlowLogLevel {
    WARN(3), // most specific - little logging
    INFO(2),
    DEBUG(1),
    TRACE(0); // least specific - lots of logging

    private final int specificity;

    SlowLogLevel(int specificity) {
        this.specificity = specificity;
    }

    public static SlowLogLevel parse(String level) {
        return valueOf(level.toUpperCase(Locale.ROOT));
    }

    boolean isLevelEnabledFor(SlowLogLevel levelToBeUsed) {
        // example: this.info(2) tries to log with levelToBeUsed.warn(3) - should allow
        return this.specificity <= levelToBeUsed.specificity;
    }
}