arkouda.logger

Module Contents

Classes

LogLevel

Generic enumeration.

Functions

disableVerbose(→ None)

Disables verbose logging (DEBUG log level) for all ArkoudaLoggers, setting

enableVerbose(→ None)

Enables verbose logging (DEBUG log level) for all ArkoudaLoggers

write_log(log_msg[, tag, log_lvl])

Allows the user to write custom logs.

class arkouda.logger.LogLevel[source]

Bases: enum.Enum

Generic enumeration.

Derive from this class to define new enumerations.

CRITICAL = 'CRITICAL'
DEBUG = 'DEBUG'
ERROR = 'ERROR'
INFO = 'INFO'
WARN = 'WARN'
arkouda.logger.disableVerbose(logLevel: LogLevel = LogLevel.INFO) None[source]

Disables verbose logging (DEBUG log level) for all ArkoudaLoggers, setting the log level for each to the logLevel parameter

Parameters:

logLevel (LogLevel) – The new log level, defaultts to LogLevel.INFO

Raises:

TypeError – Raised if logLevel is not a LogLevel enum

arkouda.logger.enableVerbose() None[source]

Enables verbose logging (DEBUG log level) for all ArkoudaLoggers

arkouda.logger.write_log(log_msg: str, tag: str = 'ClientGeneratedLog', log_lvl: LogLevel = LogLevel.INFO)[source]

Allows the user to write custom logs.

Parameters:
  • log_msg (str) – The message to be added to the server log

  • tag (str) – The tag to use in the log. This takes the place of the server function name. Allows for easy identification of custom logs. Defaults to “ClientGeneratedLog”

  • log_lvl (LogLevel) – The type of log to be written Defaults to LogLevel.INFO

See also

LogLevel