Metadata-Version: 2.1
Name: mongo-system-log
Version: 0.1.2
Summary: A log package that works with MongoDB.
Home-page: https://github.com/ronaldodduarte/mongo_system_log
Author: Ronaldo Duarte
Author-email: ronaldoduarte@globo.com
License: GNU
Description: The idea behind this package is possibility to you use some client or something like the Metabase for collect and analyse logs of your application.  
        Its return **mongodb_id** or **None** on exception case.
        
        Its need two environments variables:  
        * MONGO_DB  
        * MONGO_URL      
        
        Its works with three collections:  
        * error  
        * info  
        * critical
        
        Arguments:
        * msg - Required
            * The message to log;
        * payload - Default is None
            * If need to log a payload that make a some request;
        * result - Default is None
            * If need to log a request result;
        * log_console - boolean default is True
            * Enable or disable log console view;
        * log_detail - boolean default is True
            * If disabled show only mongo_id and message.
        
        Sample:
        ~~~python
        from mongo_system_log import *
        log = LogThis(get_module_name())
        log.info('error message', payload='payload', result='result', log_console=False, log_detail=False)
        log.error('error message', payload='payload', result='result')
        log.critical('error message', payload='payload', result='result')
        ~~~
        get_module_name()  
        * This function gets module and file name that called it. Must be called on instantiate the LogThis class.  
        The arguments **payload** and **result** has default value None.
        
        The table fields are:  
        * Ip
        * HostName
        * App - File name that was executed;
        * ModuleCalled - Module name where methods was called;
        * Date -  Date Time on format 2010-12-12 11:41:42,612;
        * Severity -  INFO, ERROR or CRITICAL;
        * Message - The message that want be logged;
        * Payload - A dict that used to call a request for example;
        * Result - A request result.
        
        I suggest that You use the Metabase:  
        https://www.metabase.com/
        
        It is amazing to analyze logs.
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
