com.veeva.vault.sdk.api.core

Interface LogService

All Superinterfaces:

Service

public interface LogService
extends Service

Send messages to the Vault Java SDK Logs, available in Admin > Logs > Vault Java SDK Logs.

Vault Java SDK Logs

Viewing these logs must be enabled per user with the Logs: Vault Java SDK permission.

Vault Java SDK log messages can be static Strings or constructed with a template. It is best practice to use message templates over String concatenation because templates are more efficient and produce neater, easier to read code. Strings for message templates are only constructed if logging is enabled, whereas String concatenation must be wrapped in an if statement to check enablement.

For example:

logService.info("Exceeded the {} limit of {}.", limitType, count);

Is equivalent to:

if (log.isInfoEnabled()){ logService.info("Exceeded the " + limitType + " limit of " + count + "."); }

There are two configurable log types available for the Vault Java SDK Logs:

• Debug Log
• Runtime Log

isDebugEnabled(), isInfoEnabled(), isWarnEnabled() and isErrorEnabled() returns true if logging will occur in either the Debug Log or the Runtime Log. It returns false if logging will not occur in any of the Vault Java SDK Logs.

Debug Log

The debug log must be enabled per user with the Logs: Vault Java SDK permission to output messages. Each log file contains all errors and messages for a given request. Learn more about Debug Logs in the Developer Portal.

You can choose between the DEBUG, INFO, ERROR, and WARN types to categorize your debug log messages.

Runtime Log

Log entries will aggregate over each day and are available for download through the UI or API. Learn more about Runtime Logs in the Developer Portal.

You can choose between the DISABLED, EXCEPTIONS, ERROR, WARN, and INFO types to customize the granularity of these log entries, available in Admin > Settings > General Settings. The ability to update the granularity of log levels must be enabled per user with the Settings: General Configuration permission. Changing the log level only impacts new entries added to the log.

Method Summary

Modifier and Type	Method and Description
void	debug(String message) Outputs a DEBUG type message to the Debug Log.
void	debug(String messageTemplate, Object... args) Outputs the templated DEBUG type message to the Debug Log.
void	debug(Supplier<String> messageSupplier) Output the String returned from a single call to messageSupplier.get() to the Debug Log.
void	error(String message) Outputs an ERROR type message to the Debug Log and Runtime Log.
void	error(String messageTemplate, Object... args) Outputs the templated ERROR type message to the Debug Log and Runtime Log.
void	error(Supplier<String> messageSupplier) Output the String returned from a single call to messageSupplier.get() to the Debug Log and Runtime Log.
void	info(String message) Outputs an INFO type message to the Debug Log and Runtime Log.
void	info(String messageTemplate, Object... args) Outputs the templated INFO type message to the Debug Log and Runtime Log.
void	info(Supplier<String> messageSupplier) Output the String returned from a single call to messageSupplier.get() to the Debug Log and Runtime Log.
boolean	isDebugEnabled() Checks if the Debug Log is enabled.
boolean	isErrorEnabled() Checks if the Debug Log or Runtime Log is enabled.
boolean	isInfoEnabled() Checks if the Debug Log or Runtime Log is enabled.
boolean	isWarnEnabled() Checks if the Debug Log or Runtime Log is enabled.
void	logResourceUsage(String message) Outputs current resource usage for elapsed time (milliseconds), memory (bytes), and CPU time (nanoseconds) to the Debug Log.
void	warn(String message) Outputs an WARN type message to the Debug Log and Runtime Log.
void	warn(String messageTemplate, Object... args) Outputs the templated WARN type message to the Debug Log and Runtime Log.
void	warn(Supplier<String> messageSupplier) Output the String returned from a single call to messageSupplier.get() to the Debug Log and Runtime Log.

Method Detail

isDebugEnabled

boolean isDebugEnabled()

Checks if the Debug Log is enabled.

Returns:

true if the Debug Log is enabled.

isInfoEnabled

boolean isInfoEnabled()

Checks if the Debug Log or Runtime Log is enabled.

Returns:

true if the Debug Log or Runtime Log is enabled.

isWarnEnabled

boolean isWarnEnabled()

Checks if the Debug Log or Runtime Log is enabled.

Returns:

true if the Debug Log or Runtime Log is enabled.

isErrorEnabled

boolean isErrorEnabled()

Checks if the Debug Log or Runtime Log is enabled.

Returns:

true if the Debug Log or Runtime Log is enabled.

debug

void debug(String message)

Outputs a DEBUG type message to the Debug Log.

Parameters:

message - message to output

info

void info(String message)

Outputs an INFO type message to the Debug Log and Runtime Log.

Parameters:

message - message to output

warn

void warn(String message)

Outputs an WARN type message to the Debug Log and Runtime Log.

Parameters:

message - message to output

error

void error(String message)

Outputs an ERROR type message to the Debug Log and Runtime Log.

Parameters:

message - message to output

logResourceUsage

void logResourceUsage(String message)

Outputs current resource usage for elapsed time (milliseconds), memory (bytes), and CPU time (nanoseconds) to the Debug Log.

For example:

"message": elapsed(ms)=35 memory(b)=25744 CPU(ns)=28831998

Parameters:

message - message to output in addition to resource usage

debug

void debug(String messageTemplate,
           Object... args)

Outputs the templated DEBUG type message to the Debug Log.

The messageTemplate may contain the template variable {}. The number of template variables must match the number of arguments passed to the method. Arguments are converted to Strings with toString() for Object arguments and String.valueOf(_) for primitive arguments. Instances of {} in the message template are replaced, in order, with the converted String values of the arguments.

For example:

logService.debug("The {} limit of {} has been reached.", limitType, count);

Parameters:

messageTemplate - message template

args - arguments to replace the {} variables in the template

info

void info(String messageTemplate,
          Object... args)

Outputs the templated INFO type message to the Debug Log and Runtime Log.

The messageTemplate may contain the template variable {}. The number of template variables must match the number of arguments passed to the method. Arguments are converted to Strings with toString() for Object arguments and String.valueOf(_) for primitive arguments. Instances of {} in the message template are replaced, in order, with the converted String value of the arguments.

For example:

logService.debug("The {} limit of {} has been reached.", limitType, count);

Parameters:

messageTemplate - message template

args - arguments to replace the {} variables in the template

warn

void warn(String messageTemplate,
          Object... args)

Outputs the templated WARN type message to the Debug Log and Runtime Log.

The messageTemplate may contain the template variable {}. The number of template variables must match the number of arguments passed to the method. Arguments are converted to Strings with toString() for Object arguments and String.valueOf(_) for primitive arguments. Instances of {} in the message template are replaced, in order, with the converted String values of the arguments.

For example:

logService.debug("The {} limit of {} has been reached.", limitType, count);

Parameters:

messageTemplate - message template

args - arguments to replace the {} variables in the template

error

void error(String messageTemplate,
           Object... args)

Outputs the templated ERROR type message to the Debug Log and Runtime Log.

The messageTemplate may contain the template variable {}. The number of template variables must match the number of arguments passed to the method. Arguments are converted to Strings with toString() for Object arguments and String.valueOf(_) for primitive arguments. Instances of {} in the message template are replaced, in order, with the converted String values of the arguments.

For example:

logService.debug("The {} limit of {} has been reached.", limitType, count);

Parameters:

messageTemplate - message template

args - arguments to replace the {} variables in the template

debug

void debug(Supplier<String> messageSupplier)

Output the String returned from a single call to messageSupplier.get() to the Debug Log.

Parameters:

messageSupplier - supplier providing a message to output

info

void info(Supplier<String> messageSupplier)

Output the String returned from a single call to messageSupplier.get() to the Debug Log and Runtime Log.

Parameters:

messageSupplier - supplier providing a message to output

warn

void warn(Supplier<String> messageSupplier)

Output the String returned from a single call to messageSupplier.get() to the Debug Log and Runtime Log.

Parameters:

messageSupplier - supplier providing a message to output

error

void error(Supplier<String> messageSupplier)

Output the String returned from a single call to messageSupplier.get() to the Debug Log and Runtime Log.

Parameters:

messageSupplier - supplier providing a message to output