Logs in program
Logs are mainly used to trace user/admin input and activities.
Log files are .txt files stored in the logs directory.
Logs cannot be viewed and deleted by user/administrator in the program. (Of course, no one can stop you from deleting them manually.)
It is expected that log files can:
- help back-end staff to analyze user/administrator behaviors (for marketing research and other things); and
- help system maintainer to debug and improve this program (for improving UI/UX for example).
Log files in this program rarely show user inputs directly. It is intended to keep our focus of the log file to the two purposes above. Plus, recording and tracking every single user input is very creepy.
LOG FILES ARE NOT DATABASE, THEY SHOULD NOT BE USED TO CHECK OR REVIEW LARGE AMOUNTS OF INFORMATION/DATA (SUCH AS HOUSES AND TICKETS INFORMATION).
About the log messages
The name of the log files is the time of starting the program.
The format of a log message is:
%(asctime)s --> %(levelname)s @%(name)s --> %(message)s
Where %(asctime)s is the time, %(levelname)s is the log level, %(name)s is where the log
message was sent, %(message)s is the log message.
Most of the log messages should be, and are designed to be, very intuitive and straight forward.
(P.S. In most of the circumstances, %(name)s is the function / method name where the log
message was sent.)
The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “NOT RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here.
Copyright © 2023 Joe Chau, Licensed under the Apache License, Version 2.0.