Skip to main content

Your project description goes here

Project description

https://badge.fury.io/py/frame_logging.svg https://travis-ci.org/ItsfBisounours/frame_logging.svg?branch=master https://codecov.io/gh/ItsfBisounours/frame_logging/branch/master/graph/badge.svg

Your project description goes here

Documentation

The full documentation is at https://frame_logging.readthedocs.io.

Quickstart

  1. Install Frame Logging:

    pip install frame_logging
    
  2. Add it to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'frame_logging.apps.FrameLoggingConfig',
    ...
)
  1. Create a class to format your extra logging kwargs
#

class FrameFormatterExample(FrameFormatter):

    # format methods

    @classmethod
    def get_format_behaviour(cls):
        return OrderedDict([
            ('customer_id', cls.format_customer_id),
        ])

    @classmethod
    def format_customer_id(cls, customer_id):
        return "customer_id={}".format(customer_id)

    # then if you need to, you can add new method to transform extra kwargs
    # transform methods

    @classmethod
    def get_transform_kwargs_methods(cls):
        return   {
            'order': cls.transform_order,
        }

    @classmethod
    def transform_order(cls, order, **kwargs):
        kwargs['customer_id'] = order.customer['id']
        return kwargs
  1. Configure frame loggin in your settings.py
# mandatory, if you do not priovide a formatter the app will crash
FRAME_FORMATTER=FrameFormatterExample()

# optionnal, default = ' - '
FRAME_SEPARATOR='+'
  1. Use it:
import frame_logging.log as log

class Order(object):
    def __init__(self):
        self.customer = {'id': 1}

log.info('Renewed contract %s', 'test', order=order)
# 'Renewed contract test - customer_id=1'))

Features

  • TODO

Running Tests

Does the code actually work?

source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox

Credits

Tools used in rendering this package:

History

0.1.0 (2017-10-26)

  • First release on PyPI.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
frame_logging-0.2.1-py2.py3-none-any.whl (7.1 kB) Copy SHA256 hash SHA256 Wheel 2.7
frame_logging-0.2.1.tar.gz (6.9 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page