net.openhft.chronicle.core.onoes

Class RecordingExceptionHandler

java.lang.Object

net.openhft.chronicle.core.onoes.RecordingExceptionHandler

All Implemented Interfaces:

ExceptionHandler

public class RecordingExceptionHandler
extends Object
implements ExceptionHandler

Records each exception by incrementing a count in a provided map keyed by ExceptionKey.

The supplied exceptionKeyCountMap must be thread-safe - for example a ConcurrentHashMap. The handler itself is thread-safe.

The map may grow without bound if unique keys keep being added. Periodically evict infrequently used entries to control memory usage.

Constructor Summary

Constructors

Constructor and Description
RecordingExceptionHandler(LogLevel level, Map<ExceptionKey,Integer> exceptionKeyCountMap, boolean exceptionsOnly) Creates a handler that records exceptions in the supplied map.

Method Summary

Modifier and Type	Method and Description
void	on(@NotNull Class<?> clazz, @Nullable String message, Throwable thrown) Records an exception by incrementing the count of its corresponding ExceptionKey in the map.
void	on(@NotNull org.slf4j.Logger logger, @Nullable String message, Throwable thrown) Records an exception by incrementing the count of its corresponding ExceptionKey in the map.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.core.onoes.ExceptionHandler

defaultHandler, ignoresEverything, isEnabled, on, on, on

Constructor Detail

RecordingExceptionHandler

public RecordingExceptionHandler(LogLevel level,
                                 Map<ExceptionKey,Integer> exceptionKeyCountMap,
                                 boolean exceptionsOnly)

Creates a handler that records exceptions in the supplied map.

Parameters:

level - the LogLevel used in the ExceptionKey.

exceptionKeyCountMap - thread-safe map where counts are stored, for example a ConcurrentHashMap.

exceptionsOnly - when true, only errors with a Throwable are recorded.

Method Detail

on

public void on(@NotNull
               @NotNull Class<?> clazz,
               @Nullable
               @Nullable String message,
               Throwable thrown)

Records an exception by incrementing the count of its corresponding ExceptionKey in the map.

Specified by:

on in interface ExceptionHandler

Parameters:

clazz - the class where the exception occurred. Must not be null.

message - a custom message detailing the error, or null.

thrown - the throwable instance representing the error, or null.

on

public void on(@NotNull
               @NotNull org.slf4j.Logger logger,
               @Nullable
               @Nullable String message,
               Throwable thrown)

Records an exception by incrementing the count of its corresponding ExceptionKey in the map.

Specified by:

on in interface ExceptionHandler

Parameters:

logger - the logger instance. Must not be null.

message - a custom message detailing the error, or null.

thrown - the throwable instance representing the error, or null.