trackinglog 0.1.9.1

A logging package for tracing function calls with error handling and email notification

TrackLogging

TrackLogging is a logging package for tracing function calls with error handling and email notification.

Installation

You can install TrackingLog using pip:

pip install trackinglog

Github URL

https://github.com/shiyi-yinghao/trackinglog

PyPi URL

https://pypi.org/project/trackinglog/

version History

0.1.0 Package Draft created

0.1.1 Decorator get_log and directly object creator get_logger created. Added setup check decorator. Added p-functions(print and log).

0.1.2 Added error handling. Added verbose option for decorator. Added called function name.

0.1.3 Added profiler for both function level and line level. Updated error handling logic: reset verbose to False, but it will now raise error instead. Added class name to log. Added dependency pakages. Added resource performance tracking.

0.1.4 Formatted the logging message with indentation. Add print to log feature. Refactor the get_log function.

0.1.5 Added cache log cleaner.

0.1.6 Updated Log config to Parameter config. Added inline log usage.

0.1.6.2 Fix several bugs.

0.1.7 Add Error Handling message merchanism.

0.1.8 Embed Task Manager; Optimized cache log logic.

0.1.8.3 Enhanced task manager with new task param, introduced finish token.

0.1.8.4 Enhanced task manager with finish, inprogress, fail status; Add root folder path; Bug fix.

0.1.8.5 Enhanced task manager with new resume task mechanism. Now new task == True (must be new task); None (new or resume); False (resume only).

0.1.8.6 Now resume_task support True which would resume latest task. Bug fix.

0.1.9 Optimize Log logic. Bug Fix.

0.1.9.1 Set Default task name and root_folder_path. Allow usage without setup. Increase default task num limit to 500.

Feature in developing

Add public and private log

Add Added email notification.

Add Kafka message notification

Add Inherit Merchanism

Add debug suggestion message

Uaage for function and quick settings:

import logging
import trackinglog
import inspect

# Setup the LogManager with root logging path
trackinglog.logger.setup(root_task_path='./logs')

@trackinglog.logger.get_log('my_logger', verbose=1, enable_profiling="line")
def my_function(log=None):  # Notice how the log parameter is expected
    log.info("This function does something important.")
    print("Function is executing...")
    # assert False, "This function is broken!"
    
my_function()  # Running the function will log start and end, using the specific logger

Comprehensive Config with Task Management setup

trackinglog.logger.setup(task_name = "Tak1",
                         root_folder_path='./tasks',  # default ./cache/__trackinglog__
                         task_config={"task_num_limit":3, "task_expiration_date":3},
                         log_config={'root_log_path':"./logs", '_cache_log_path':"./logs/cache", 'cache_log_num_limit':10, '_cache_log_day_limit':7},
                         email_credential={'username':"PLACEHOLDER", 'password':"PLACEHOLDER",  'root_emails_folder':"./logs/emails"},
                         lock_config={"lock_folder_path":"./logs/locks"})
                         

Usage for class and comprehensive settings:

import logging
import trackinglog
import inspect

trackinglog.logger.setup(root_task_path='./logs', log_config={'root_log_path':"./logs", '_cache_log_path':"./logs/cache", 'cache_log_num_limit':10, '_cache_log_day_limit':7},
                                                    email_credential={'username':"PLACEHOLDER", 'password':"PLACEHOLDER",  'root_emails_folder':"./logs/emails"},
                                                    lock_config={"lock_folder_path":"./logs/locks"})

@trackinglog.logger.get_log('my_logger_cls', verbose=1, enable_profiling="line", print2log=True)
class testclass:
    def __init__(self, a: int):
        self.a=a
    def p(self):
        self.log.info("class log")
        # assert False , "This function is broken!"

    def count(self, n: int):
        for i in range(n):
            print(i)
    

t=testclass(2.2)
t.p()
t.count(3)

Usage inside a function:

trackinglog.logger.setup(root_task_path='./logs')

def my_function():
    log=trackinglog.logger.get_logger('my_logger_func')
    log.info("This function does something important.")
    print("Function is executed")

my_function() 

Configuration and Parameters:

trackinglog.logger.setup(root_log_path='./logs') @trackinglog.logger.get_log('my_logger_cls', verbose=1, enable_profiling="function", print2log=True)