Field Detail

• public static final int MAX_ELEMENTS

  The maximum elements to be printed in the string representation of a list. (Value: 20)

• public static final int MAX_ELEMENT_SIZE

  The maximum size of an element to be printed in the string representation of a list. (Value: 40)

Property Detail

• private static java.util.Map<Level, groovy.lang.Range> clientLevelMap

  Maps the client logging framework's level number ranges with the server-side levels.

• private static boolean disableStackTraceLogging

  If true, then the stack trace logging is disabled. Only use for unit testing.

Constructor Detail

• LogUtils()

Method Detail

• static ch.qos.logback.classic.Level convertClientLevelToServerLevel(java.lang.Integer clientLevel)

  Converts a client-side trace level number to a server-side trace level. (e.g. 2000 -> Level.DEBUG). If a client level is not found, then the next lowest value is returned.

  Parameters:

  level - The client-side level number.

  Returns:

  The server-side trace level.

• static java.lang.Integer convertLevelToClientLogSetting(ch.qos.logback.classic.Level level)

  Converts a server-side trace level to a client-side trace level number. (e.g. Level.ERROR -> 5000).

  Parameters:

  level - The server-side level.

  Returns:

  The client-side trace level.

• static java.lang.String convertPageToClientLoggerName(java.lang.String page)

  Converts a page URI to a server-side logger name for use with client-side logging. For example, converts '/order/show' to 'client.order.show'.

  Parameters:

  page - The URI of the page to convert to a logger name.

  Returns:

  The client-side logger name.

• static java.lang.String extractImportantMethodsFromStackTrace()

• static org.slf4j.Logger getLogger(java.lang.String loggerID)

  Finds the logger for the given logging ID (e.g. package/class name).

  Parameters:

  loggerID - The logger ID (full class name).

• static org.slf4j.Logger getLogger(java.lang.Class clazz)

  Finds the logger for the given class.

  Parameters:

  clazz - The class.

• static java.lang.String limitedLengthList(java.util.List list)

  Build a string representation of the list of objects with limits on the size of each object and number of objects. If the string or count exceeds the limits, place holders are printed (... and '10 more...').

  Parameters:

  list - The list of objects to print strings for.

  Returns:

  The string representation (with limits).

• static java.lang.String limitedLengthString(java.lang.String s)

  Trims the given string if it exceeds the MAX_ELEMENT_SIZE (40).

  Parameters:

  s - The string to (maybe) trim.

  Returns:

  The possibly trimmed string. Notes how many characters were trimmed.

• static java.lang.String limitedLengthString(java.lang.String s, int maxLength)

  Trims the given string if it exceeds the MAX_ELEMENT_SIZE (default: 40).

  Parameters:

  s - The string to (maybe) trim.

  maxLength - The max length.

  Returns:

  The possibly trimmed string. Notes how many characters were trimmed.

• static void logClientMessage(java.util.Map json, java.util.Map params)

  Logs the given client-side message to the standard logger. The input JSON is provided by the client logging framework.

  Parameters:

  json - The content of the logging request from the client framework. This contains an array ('lg') or maps. The maps contain two important elements: 'l' (level as int), 'm' (the message text).

  params - The HTTP request parameters (uses 'logger' as the name of the server-side logger).

  Returns:

  The client-side logger name.

• static void logStackTrace(org.slf4j.Logger logger, java.lang.Throwable e, java.lang.Object source)

  Logs a given stack trace for safety. Does not log BusinessException since those are mostly expected exceptions.

  Parameters:

  logger - The logger to use.

  e - The exception.

  source - The source (optional). Logged with the message.

• static java.lang.Object toLevel(java.lang.String level)

  Converts the given string Level to the correct logger Level.

  Parameters:

  level - The level string to convert.