Logger Module¶
logger.logger¶
TcEx Framework Logger module
-
class
tcex.logger.logger.
Logger
(tcex, logger_name)[source]¶ Bases:
object
Framework logger module.
-
add_api_handler
(name='api', level=None)[source]¶ Add API logging handler.
Parameters: name (str, optional) – The name of the handler. Defaults to ‘api’.
-
add_cache_handler
(name)[source]¶ Add cache logging handler.
Parameters: name (str) – The name of the handler.
-
add_rotating_file_handler
(name, filename, path, backup_count, max_bytes, level, formatter=None, mode='a')[source]¶ Add a rotating file handler
Parameters: - name (str, optional) – The name of the handler. Defaults to ‘rfh’.
- filename (str) – The name of the logfile.
- path (str) – The path for the logfile.
- backup_count (int, optional) – The maximum # of backup files. Defaults to 0.
- max_bytes (int) – The max file size before rotating. Defaults to 0.
- level (str) – The logging level. Defaults to None.
- formatter (str, optional) – The logging formatter to use. Defaults to None.
- mode (str, optional) – The write mode for the file. Defaults to ‘a’.
-
add_stream_handler
(name='sh', formatter=None, level=None)[source]¶ Return stream logging handler.
Parameters: - name (str, optional) – The name of the handler. Defaults to ‘sh’.
- formatter (str, optional) – The logging formatter to use. Defaults to None.
- level (int, optional) – The logging level. Defaults to None.
-
add_thread_file_handler
(name, filename, level, path, formatter=None)[source]¶ Add File logging handler.
Parameters: - name (str) – The name of the handler.
- filename (str) – The name of the logfile.
- level (int, optional) – The logging level. Defaults to None.
- path (str) – The path for the logfile.
- formatter (str, optional) – The logging formatter to use. Defaults to None.
-
log
¶ Return logger.
-
static
log_level
(level)[source]¶ Return proper level from string.
Parameters: level (str) – The logging level. Default to ‘debug’.
-
logger.api_handler¶
API Handler Class
-
class
tcex.logger.api_handler.
ApiHandler
(session, flush_limit=100)[source]¶ Bases:
logging.Handler
Logger handler for ThreatConnect Exchange API logging.
-
entries
¶ Return a copy and clear self._entries.
-
logger.cache_handler¶
Cache Handler Class
logger.rotating_file_handler_custom¶
API Handler Class
logger.thread_file_handler¶
API Handler Class
logger.trace_logger¶
Trace Logger Class
-
class
tcex.logger.trace_logger.
TraceLogger
(name, level=0)[source]¶ Bases:
logging.Logger
Add trace level to logging