Skip to content

Commit d9ed584

Browse files
committed
Added logging facility, ColorStreamHandler, and updated .gitignore
1 parent 5db8daf commit d9ed584

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,22 @@ Setup
44
- DATABASE_ENGINE can either be "mysql" or "sqlite"
55
- For sqlite only DATABASE_HOST is used, and it should begin with a '/'
66
- All other DATABASE_* settings are required for mysql
7-
- VERBOSE mode causes the crawler to output some stats that are generated as it goes
7+
- DEBUG mode causes the crawler to output some stats that are generated as it goes, and other debug messages
8+
- LOGGING is a dictConfig dictionary to log output to the console and a rotating file, and works out-of-the-box, but can be modified
89

910

1011
Current State
1112
=============
1213
- mysql engine untested
13-
- Lots of debug prints
1414
- Issue in some situations where the database is locked and queries cannot execute. Presumably an issue only with sqlite's file-based approach
1515

16+
Logging
17+
=======
18+
- DEBUG+ level messages are logged to the console, and INFO+ level messages are logged to a file.
19+
- By default, the file for logging uses a TimedRotatingFileHandler that rolls over at midnight
20+
- Setting DEBUG in the settings toggles wether or not DEBUG level messages are output at all
21+
- Setting USE_COLORS in the settings toggles whether or not messages output to the console use colors depending on the level.
22+
1623
Misc
1724
====
1825
- Designed to be able to run on multiple machines and work together to collect info in central DB

0 commit comments

Comments
 (0)