Skip to main content

Create tree structures for your logs

Project description

Treelogger

This package adds structure to your application logs by creating a tree structure for functions that execute within functions.

These nested functions can be very troublesome to troubleshoot using a regular logger, but by using the tree logger, you can easily see the chain of events and drill down to where the error occurs.

Below is an example of what the tree would look like. The example shows how output of a function can be nested to the appropriate level.

Function Stand_Up 
-"Begin Standing Up" 
--Function Move_Legs
---"Moving Legs" 
----Function Check_Balance
-----"Balance is Good"
----Finish Check_Balance
---"Leg Movement Sucessful"
-- Finish Move_Legs 
-"Stand Up took 1 Second(s)" 
Finish Stand_up

To begin tree logging, import the tree object and treewrap decorator into your modules.

#test.py 

from treelogger import tree, treewrap 


@treewrap()
def showthis(value):
    tree.log(value)

    return

@treewrap()
def nest(value):

    tree.log('Nesting a value of %i' % value)

    showthis(value)

    tree.log('Nesting a value of %i + 1' % value)

    showthis(value + 1)

You can then import things from your modules into one or more main modules. In the main module, use the tree = TreeLogger() form to create a logging instance.

The TreeLogger class instance is a global instance (kind of like sys.stdout) and all of your modules that imported tree will send their logs to the global tree. When defining the global tree, it has 2 default outputs: stdout and text file.

#main.py
from test import showthis, nest
from treelogger import tree, TreeLogger

tree = TreeLogger()
nest(123)

tree.close_log()

Running main.py would give you the output below.


<?xml version="1.0" ?>
<log>
	<nest>
		<msg>  Nesting a value of 123  </msg>
		<showthis>
			<msg>  123  </msg>
		</showthis>
		<msg>  Nesting a value of 123 + 1  </msg>
		<showthis>
			<msg>  124  </msg>
        </showthis>
	</nest>
</log>


As you can see, functions become nested and so do the logging messages for the functions. The resulting XML file can be searched using Xpath or visualized using an XML visualizer.

A common mistake is to use the treewrap without the (). Unlike other decorators, the brackets are necessary for properly returning values from the decorated function.

Project details


Download files

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

Source Distribution

treelogger-0.15.tar.gz (3.7 kB view details)

Uploaded Source

Built Distribution

treelogger-0.15-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file treelogger-0.15.tar.gz.

File metadata

  • Download URL: treelogger-0.15.tar.gz
  • Upload date:
  • Size: 3.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.4

File hashes

Hashes for treelogger-0.15.tar.gz
Algorithm Hash digest
SHA256 fbfbeb495adf44d591f018e86094121fd2cd84ee9115b729fd50dd6c01f213dd
MD5 90ab985a24af2aa6cd9f1cab47c95978
BLAKE2b-256 7450e6423854475aed245e5794cafed84679496cd84adf6a51e11fd2098b7705

See more details on using hashes here.

File details

Details for the file treelogger-0.15-py3-none-any.whl.

File metadata

  • Download URL: treelogger-0.15-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.4

File hashes

Hashes for treelogger-0.15-py3-none-any.whl
Algorithm Hash digest
SHA256 68e124176db64f17bdde7a0c0e62b7ed46d095dc66ea413d868d2377552ccb14
MD5 6a6069e7bbd25a47a5b2a3cd00fb1fff
BLAKE2b-256 9c746841c46d33f90f431aabad65a533260614c594a5d7b0cc3bbf0e3861b7d1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page