net.croz.nrich.logging.api.service.LoggingService Maven / Gradle / Ivy
/*
* Copyright 2020-2023 CROZ d.o.o, 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
*
* https://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 net.croz.nrich.logging.api.service;
import java.util.Map;
/**
* Performs logging of exceptions at specified verbosity level and logging level (can be configured for each exception).
*/
public interface LoggingService {
/**
* Logs exception. Exception verbosity and logging level are resolved from configuration.
* If no exception or verbosity level is defined defaults are used (LoggingLevel.ERROR and LoggingVerbosityLevel.FULL).
*
* @param exception exception to log
* @param exceptionAuxiliaryData additional data that should be logged
*/
void logInternalException(Exception exception, Map exceptionAuxiliaryData);
/**
* Logs exception on compact verbosity level. Logging level is resolved from configuration for exception or LoggingLevel.ERROR is used.
*
* @param exception exception to log
* @param exceptionAuxiliaryData additional data that should be logged
*/
void logInternalExceptionAtCompactVerbosityLevel(Exception exception, Map exceptionAuxiliaryData);
/**
* Logs exception on full verbosity level. Logging level is resolved from configuration for exception or LoggingLevel.ERROR is used.
*
* @param exception exception to log
* @param exceptionAuxiliaryData additional data that should be logged
*/
void logInternalExceptionAtFullVerbosityLevel(Exception exception, Map exceptionAuxiliaryData);
/**
* Logs external exception (i.e. exceptions for which a class is not on classpath).
*
* @param exceptionClassName class name of exception
* @param exceptionMessage exception message
* @param exceptionAuxiliaryData additional data that should be logged
*/
void logExternalException(String exceptionClassName, String exceptionMessage, Map exceptionAuxiliaryData);
}