Enable Debug Logging / Carepackage generation

Information and Tutorials on features in Mylar and how to use it
Locked
User avatar
evilhero
Site Admin
Posts: 2883
Joined: Sat Apr 20, 2013 3:43 pm
Contact:

Enable Debug Logging / Carepackage generation

Post by evilhero »

DEBUG LOGGING

Debug (sometimes we call it Verbose) logging logs more detailed information to the log files from the point of activation. The point of activation is either on startup, or while Mylar is running.

There are 3 ways to enable debug logging:

1) [Activation: startup] Use the -v switch on the command line when you execute Mylar (ie. python Mylar.py -v)

2) [Activation: startup] In the config.ini file, change the log_level to a value of 2 (ie. log_level = 2)

3) [Activation: running] In the GUI, go to the History tab / View Logs button / Toggle Debug Logging ON. You'll get a brief message in the logs (on that same page) indicating that verbose/debug logging has been enabled for the session.

Keep in mind that options 1 & 2 are persistent thru restarts of Mylar. Option 3 will revert back to whatever you have started Mylar with on the next restart.

Also, if you use the command line option that will over-ride whatever value you have in the config.ini.


CAREPACKAGE

Normally the whole point in debug logging is that you can send us the carepackage. A carepackage is just a snapshot of your Mylar configuration / logs / database / environment (all apikeys, usernames, etc are stripped from the logs and config.ini files during carepackage generation - the db does not contain any keys).

Here's how to go about generating a carepackage - after you get the debug log enabled, and you're able to repeat any workflow problem that's occuring and it's trapped:

- go to the Configuration page.
- click on the CarePackage button in the upper right corner.
- your browser will download the carepackage.zip file after a few moments.
- the carepackage.zip file is also stored in the cache folder, by default within the mylar program directory.
- upload the carepackage.zip file to some 3rd party storage that will provide you with a shareable link (mega, dropbox, dropapk are some examples).
- paste the link in your forum post (or github issue depending on where you logged your concern).
Locked