/*
|
* CDDL HEADER START
|
*
|
* The contents of this file are subject to the terms of the
|
* Common Development and Distribution License, Version 1.0 only
|
* (the "License"). You may not use this file except in compliance
|
* with the License.
|
*
|
* You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
|
* or http://forgerock.org/license/CDDLv1.0.html.
|
* See the License for the specific language governing permissions
|
* and limitations under the License.
|
*
|
* When distributing Covered Code, include this CDDL HEADER in each
|
* file and include the License file at legal-notices/CDDLv1_0.txt.
|
* If applicable, add the following below this CDDL HEADER, with the
|
* fields enclosed by brackets "[]" replaced with your own identifying
|
* information:
|
* Portions Copyright [yyyy] [name of copyright owner]
|
*
|
* CDDL HEADER END
|
*
|
*
|
* Copyright 2006-2009 Sun Microsystems, Inc.
|
* Portions Copyright 2014 ForgeRock AS
|
*/
|
package org.opends.server.loggers.debug;
|
|
import org.opends.server.api.DebugLogPublisher;
|
import org.opends.server.types.DebugLogCategory;
|
import org.opends.server.types.DebugLogLevel;
|
import org.opends.server.loggers.LogLevel;
|
import org.opends.server.loggers.LogCategory;
|
|
import java.util.Map;
|
|
/**
|
* Class for source-code tracing at the method level.
|
*
|
* One DebugTracer instance exists for each Java class using tracing.
|
* Tracer must be registered with the DebugLogger.
|
*
|
* Logging is always done at a level basis, with debug log messages
|
* exceeding the trace threshold being traced, others being discarded.
|
*/
|
|
public class DebugTracer
|
{
|
/** The class this aspect traces. */
|
private String className;
|
|
/**
|
* A class that represents a settings cache entry.
|
*/
|
private class PublisherSettings
|
{
|
DebugLogPublisher debugPublisher;
|
TraceSettings classSettings;
|
Map<String, TraceSettings> methodSettings;
|
}
|
|
private PublisherSettings[] publisherSettings;
|
|
/**
|
* Construct a new DebugTracer object with cached settings obtained from
|
* the provided array of publishers.
|
*
|
* @param className The classname to use as category for logging.
|
* @param publishers The array of publishers to obtain the settings from.
|
*/
|
@SuppressWarnings({ "unchecked", "rawtypes" })
|
DebugTracer(String className, DebugLogPublisher[] publishers)
|
{
|
this.className = className;
|
publisherSettings = new PublisherSettings[publishers.length];
|
|
// Get the settings from all publishers.
|
for(int i = 0; i < publishers.length; i++)
|
{
|
DebugLogPublisher publisher = publishers[i];
|
PublisherSettings settings = new PublisherSettings();
|
|
settings.debugPublisher = publisher;
|
settings.classSettings = publisher.getClassSettings(className);
|
|
// For some reason, the compiler doesn't see that
|
// debugLogPublihser.getMethodSettings returns a parameterized Map.
|
// This problem goes away if a parameterized verson of DebugLogPublisher
|
// is used. However, we can't not use reflection to instantiate a generic
|
// DebugLogPublisher<? extends DebugLogPublisherCfg> type. The only thing
|
// we can do is to just supress the compiler warnings.
|
settings.methodSettings = publisher.getMethodSettings(className);
|
|
publisherSettings[i] = settings;
|
}
|
}
|
|
/**
|
* Log an arbitrary event at the verbose level.
|
* Same as debugMessage(DebugLogLevel.ERROR, msg)
|
*
|
* @param msg message to format and log.
|
*/
|
public void debugVerbose(String msg)
|
{
|
debugMessage(DebugLogLevel.VERBOSE, msg, new Object[]{});
|
}
|
|
/**
|
* Log an arbitrary event at the verbose level.
|
* Same as debugMessage(DebugLogLevel.ERROR, msg, msgArgs...)
|
*
|
* @param msg message to format and log.
|
* @param msgArgs arguments to place into the format string.
|
*/
|
public void debugVerbose(String msg, Object... msgArgs)
|
{
|
debugMessage(DebugLogLevel.VERBOSE, msg, msgArgs);
|
}
|
|
/**
|
* Log an arbitrary event at the info level.
|
* Same as debugMessage(DebugLogLevel.ERROR, msg)
|
*
|
* @param msg message to format and log.
|
*/
|
public void debugInfo(String msg)
|
{
|
debugMessage(DebugLogLevel.INFO, msg, new Object[]{});
|
}
|
|
/**
|
* Log an arbitrary event at the info level.
|
* Same as debugMessage(DebugLogLevel.ERROR, msg, msgArgs...)
|
*
|
* @param msg message to format and log.
|
* @param msgArgs arguments to place into the format string.
|
*/
|
public void debugInfo(String msg, Object... msgArgs)
|
{
|
debugMessage(DebugLogLevel.INFO, msg, msgArgs);
|
}
|
|
/**
|
* Log an arbitrary event at the warning level.
|
* Same as debugMessage(DebugLogLevel.ERROR, msg)
|
*
|
* @param msg message to format and log.
|
*/
|
public void debugWarning(String msg)
|
|
{
|
debugMessage(DebugLogLevel.WARNING, msg, new Object[]{});
|
}
|
|
/**
|
* Log an arbitrary event at the warning level.
|
* Same as debugMessage(DebugLogLevel.ERROR, msg, msgArgs...)
|
*
|
* @param msg message to format and log.
|
* @param msgArgs arguments to place into the format string.
|
*/
|
public void debugWarning(String msg, Object... msgArgs)
|
{
|
debugMessage(DebugLogLevel.WARNING, msg, msgArgs);
|
}
|
|
/**
|
* Log an arbitrary event at the error level.
|
* Same as debugMessage(DebugLogLevel.ERROR, msg)
|
*
|
* @param msg message to format and log.
|
*/
|
public void debugError(String msg)
|
|
{
|
debugMessage(DebugLogLevel.ERROR, msg, new Object[]{});
|
}
|
|
/**
|
* Log an arbitrary event at the error level.
|
* Same as debugMessage(DebugLogLevel.ERROR, msg, msgArgs...)
|
*
|
* @param msg message to format and log.
|
* @param msgArgs arguments to place into the format string.
|
*/
|
public void debugError(String msg, Object... msgArgs)
|
{
|
debugMessage(DebugLogLevel.ERROR, msg, msgArgs);
|
}
|
|
/**
|
* Log an arbitrary event.
|
*
|
* @param level the level of the log message.
|
* @param msg message to format and log.
|
*/
|
public void debugMessage(LogLevel level, String msg)
|
{
|
debugMessage(level, msg, new Object[]{});
|
}
|
|
/**
|
* Log an arbitrary event.
|
*
|
* @param level the level of the log message.
|
* @param msg message to format and log.
|
* @param msgArgs arguments to place into the format string.
|
*/
|
public void debugMessage(LogLevel level, String msg, Object... msgArgs)
|
{
|
if(DebugLogger.debugEnabled())
|
{
|
StackTraceElement[] stackTrace = null;
|
StackTraceElement[] filteredStackTrace = null;
|
StackTraceElement callerFrame = null;
|
for (PublisherSettings settings : publisherSettings)
|
{
|
TraceSettings activeSettings = settings.classSettings;
|
Map<String, TraceSettings> methodSettings = settings.methodSettings;
|
|
if (shouldLog(DebugLogCategory.MESSAGE, activeSettings) || methodSettings != null)
|
{
|
if(stackTrace == null)
|
{
|
stackTrace = Thread.currentThread().getStackTrace();
|
}
|
if (callerFrame == null)
|
{
|
callerFrame = getCallerFrame(stackTrace);
|
}
|
|
String signature = callerFrame.getMethodName();
|
|
// Specific method settings still could exist. Try getting
|
// the settings for this method.
|
if(methodSettings != null)
|
{
|
TraceSettings mSettings = methodSettings.get(signature);
|
|
if (mSettings == null)
|
{
|
// Try looking for an undecorated method name
|
int idx = signature.indexOf('(');
|
if (idx != -1)
|
{
|
mSettings =
|
methodSettings.get(signature.substring(0, idx));
|
}
|
}
|
|
// If this method does have a specific setting and it is not
|
// suppose to be logged, continue.
|
if (mSettings != null)
|
{
|
if(!shouldLog(DebugLogCategory.MESSAGE, mSettings))
|
{
|
continue;
|
}
|
else
|
{
|
activeSettings = mSettings;
|
}
|
}
|
}
|
|
String sl = callerFrame.getFileName() + ":" +
|
callerFrame.getLineNumber();
|
|
if(msgArgs != null && msgArgs.length > 0)
|
{
|
msg = String.format(msg, msgArgs);
|
}
|
|
if (filteredStackTrace == null && activeSettings.stackDepth > 0)
|
{
|
filteredStackTrace =
|
DebugStackTraceFormatter.SMART_FRAME_FILTER.
|
getFilteredStackTrace(stackTrace);
|
}
|
|
settings.debugPublisher.traceMessage(activeSettings, signature, sl,
|
msg, filteredStackTrace);
|
}
|
}
|
}
|
}
|
|
/**
|
* Log a caught exception.
|
*
|
* @param level the level of the log message.
|
* @param ex the exception caught.
|
*/
|
public void debugCaught(LogLevel level, Throwable ex)
|
{
|
debugCaught("", ex);
|
}
|
|
/**
|
* Log a caught exception.
|
*
|
* @param msg the message
|
* @param ex the exception caught.
|
*/
|
public void debugCaught(String msg, Throwable ex)
|
{
|
if(DebugLogger.debugEnabled())
|
{
|
StackTraceElement[] stackTrace = null;
|
StackTraceElement[] filteredStackTrace = null;
|
StackTraceElement callerFrame = null;
|
for (PublisherSettings settings : publisherSettings)
|
{
|
TraceSettings activeSettings = settings.classSettings;
|
Map<String, TraceSettings> methodSettings = settings.methodSettings;
|
|
if (shouldLog(DebugLogCategory.CAUGHT, activeSettings) || methodSettings != null)
|
{
|
if(stackTrace == null)
|
{
|
stackTrace = Thread.currentThread().getStackTrace();
|
}
|
if (callerFrame == null)
|
{
|
callerFrame = getCallerFrame(stackTrace);
|
}
|
|
String signature = callerFrame.getMethodName();
|
|
// Specific method settings still could exist. Try getting
|
// the settings for this method.
|
if(methodSettings != null)
|
{
|
TraceSettings mSettings = methodSettings.get(signature);
|
|
if (mSettings == null)
|
{
|
// Try looking for an undecorated method name
|
int idx = signature.indexOf('(');
|
if (idx != -1)
|
{
|
mSettings =
|
methodSettings.get(signature.substring(0, idx));
|
}
|
}
|
|
// If this method does have a specific setting and it is not
|
// suppose to be logged, continue.
|
if (mSettings != null)
|
{
|
if(!shouldLog(DebugLogCategory.CAUGHT, mSettings))
|
{
|
continue;
|
}
|
else
|
{
|
activeSettings = mSettings;
|
}
|
}
|
}
|
|
String sl = callerFrame.getFileName() + ":" +
|
callerFrame.getLineNumber();
|
|
if (filteredStackTrace == null && activeSettings.stackDepth > 0)
|
{
|
filteredStackTrace =
|
DebugStackTraceFormatter.SMART_FRAME_FILTER.
|
getFilteredStackTrace(ex.getStackTrace());
|
}
|
|
settings.debugPublisher.traceCaught(activeSettings, signature, sl,
|
msg, ex, filteredStackTrace);
|
}
|
}
|
}
|
}
|
|
/**
|
* Gets the name of the class this tracer traces.
|
*
|
* @return The name of the class this tracer traces.
|
*/
|
public String getTracedClassName()
|
{
|
return className;
|
}
|
|
/**
|
* Indicates if logging is enabled for the provided debug log
|
* category.
|
*
|
* @param logCategory
|
* Log category to check
|
* @return {@code true} if logging is enabled, false otherwise.
|
*/
|
public boolean enabledFor(LogCategory logCategory)
|
{
|
for (PublisherSettings settings : publisherSettings)
|
{
|
TraceSettings activeSettings = settings.classSettings;
|
Map<String, TraceSettings> methodSettings = settings.methodSettings;
|
|
if (shouldLog(logCategory, activeSettings)
|
|| methodSettings != null)
|
{
|
return true;
|
}
|
}
|
return false;
|
}
|
|
/**
|
* Indicates if logging is enabled for at least one category
|
* in a publisher.
|
*
|
* @return {@code true} if logging is enabled, false otherwise.
|
*/
|
public boolean enabled()
|
{
|
for (PublisherSettings settings : publisherSettings)
|
{
|
TraceSettings activeSettings = settings.classSettings;
|
Map<String, TraceSettings> methodSettings = settings.methodSettings;
|
|
if (shouldLog(activeSettings) || methodSettings != null)
|
{
|
return true;
|
}
|
}
|
return false;
|
}
|
|
/**
|
* Update the cached settings of the tracer with the settings from the
|
* provided publishers.
|
*
|
* @param publishers The array of publishers to obtain the settings from.
|
*/
|
@SuppressWarnings({ "unchecked", "rawtypes" })
|
void updateSettings(DebugLogPublisher[] publishers)
|
{
|
PublisherSettings[] newSettings =
|
new PublisherSettings[publishers.length];
|
|
// Get the settings from all publishers.
|
for(int i = 0; i < publishers.length; i++)
|
{
|
DebugLogPublisher publisher = publishers[i];
|
PublisherSettings settings = new PublisherSettings();
|
|
settings.debugPublisher = publisher;
|
settings.classSettings = publisher.getClassSettings(className);
|
|
// For some reason, the compiler doesn't see that
|
// debugLogPublihser.getMethodSettings returns a parameterized Map.
|
// This problem goes away if a parameterized verson of DebugLogPublisher
|
// is used. However, we can't not use reflection to instantiate a generic
|
// DebugLogPublisher<? extends DebugLogPublisherCfg> type. The only thing
|
// we can do is to just supress the compiler warnings.
|
settings.methodSettings = publisher.getMethodSettings(className);
|
|
newSettings[i] = settings;
|
}
|
|
publisherSettings = newSettings;
|
}
|
|
/**
|
* Return the caller stack frame.
|
*
|
* @param stackTrace The entrie stack trace frames.
|
* @return the caller stack frame or null if none is found on the
|
* stack trace.
|
*/
|
private StackTraceElement getCallerFrame(StackTraceElement[] stackTrace)
|
{
|
if (stackTrace != null && stackTrace.length > 0)
|
{
|
// Skip leading frames debug logging classes and getStackTrace
|
// method call frame if any.
|
for (StackTraceElement aStackTrace : stackTrace)
|
{
|
if(aStackTrace.getClassName().startsWith("java.lang.Thread"))
|
{
|
continue;
|
}
|
|
if (!aStackTrace.getClassName().startsWith(
|
"org.opends.server.loggers.debug"))
|
{
|
return aStackTrace;
|
}
|
}
|
}
|
|
return null;
|
}
|
|
private boolean shouldLog(LogCategory messageCategory, TraceSettings activeSettings)
|
{
|
return activeSettings.includeCategories != null &&
|
activeSettings.includeCategories.contains(messageCategory);
|
}
|
|
/** Indicates if at least one category is active for logging. */
|
private boolean shouldLog(TraceSettings settings)
|
{
|
return settings.includeCategories != null && !settings.includeCategories.isEmpty();
|
}
|
}
|
