Skip to content

Latest commit

 

History

History
81 lines (58 loc) · 3.76 KB

logging.md

File metadata and controls

81 lines (58 loc) · 3.76 KB
Raw

Logging in cjapy

The loggin capability enables you to log the activity of the module in a file.

At the moment, it is only capturing the activity done via the main class instance CJA, not the Workspace or the RequestCreator modules.

Configuration

You can enable logging capability when instanciating the different class:

  • CJA

It requires to pass an object during the class instanciation process, to the parameter loggingObject.
A template of the object can be created via the generateLoggingObject method.
This method takes no argument and returns the following object:

{'level': 'WARNING',
 'stream': True,
 'file': False,
 'format': '%(asctime)s::%(name)s::%(funcName)s::%(levelname)s::%(message)s::%(lineno)d',
 'filename': 'cjapy.log'}

Here are some description of the different keys:

  • level : Level of the logger to display information (NOTSET, DEBUG,INFO,WARNING,EROR,CRITICAL)
  • stream : If the logger should display print statements
  • file : If the logger should write the messages to a file
  • filename : name of the file where log are written
  • format : format of the logs.

As pythonista may have realized, the logging capability has been created based on the native logging module of python.
Documentation can be found here.
It also means that it doesn't require any new module import.

Example of instanciation of a class with the logging object:

import cjapy
cjapy.importConfigFile('myconfig.json')
myLogging = cjapy.generateLoggingObject()

mycompany = cjapy.CJA(loggingObject=myLogging)

Capabilities

The new functionality can either:

  • Stream data to the console. In that case, it will progressively replace some of the verbose option.

  • Write data to a log file. In that case, the default name of the log file will be cjapy.log. You can change that in the config object.

Be careful at which level you are instanciating the logging capability. The default level is WARNING.

Format of the logs

Here is the possible options for the format of the logs.
Copy of the table available here

Attribute name Format Description
asctime %(asctime)s Human-readable time when the LogRecord was created. By default this is of the form ‘2003-07-08 16:49:45,896’
created %(created)f Time when the LogRecord was created (as returned by time.time()).
filename %(filename)s Filename portion of pathname.
funcName %(funcName)s Name of function containing the logging call.
levelname %(levelname)s Text logging level for the message ('DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL').
levelno %(levelno)s Numeric logging level for the message (DEBUG, INFO, WARNING, ERROR, CRITICAL).
lineno %(lineno)d Source line number where the logging call was issued (if available).
message %(message)s The logged message, computed as msg % args. This is set when Formatter.format() is invoked.
module %(module)s Module (name portion of filename).
msecs %(name)s Millisecond portion of the time when the LogRecord was created.
name %(pathname)s Name of the logger used to log the call.
process %(process)d Process ID (if available).
processName %(processName)s Process name (if available).
relativeCreated %(relativeCreated)d Time in milliseconds when the LogRecord was created, relative to the time the logging module was loaded.
thread %(thread)d Thread ID (if available).
threadName %(threadName)s Thread name (if available).