Developers of Sympa

[IKEDA Soji <address@concealed>]

Hi,

Currently, "err" and "notice", or "info" and "notice" levels are
sometimes confused.  And, "err" level outputs traceback to syslog
even when the error was caused by user.

So I wish to clarify the purpose of each log level.


Summary of proposal:

* Add "alert" and "crit" levels for fault on the system.

* "err" level will be used for information caused by users' action.
  "alert", "crit" and "notice" levels will be used for the system.

* "info" level will be used for successful result.

* "debug*" levels will be used for things not corresponding to any
  levels above.

Detailed description of each level follows.

"alert": Program cannot continue processing

e.g.:
- Mandatory file or directory does not exist, cannot be open or not
  be writable.
- Unrecoverable errors in sympa.conf or robot.conf.
- Program unexpectedly dies.
- and other failure to prevent running the program.

n.b. This level outputs traceback to log and STDERR.


"crit": Unexpected situation

e.g.:
- Sending one or more messages failed.
- Logging failed.
- Database server is (temporarily or permanently) gone.
- Query is denied by SQL or LDAP server.
- DNS returned malformed response (DKIM etc.).
- OAuth server unexpectedly denied assertion.
- Synchronization of list members unexpectedly failed.
- ... and other errors caused by foreign components.

n.b. This level outputs traceback to log.


"err": Errors caused by messages, user or user agent

e.g.:
- Errors in list config file (list does not have owners etc.).
- Errors in TT2 template.
- Mail loop is detected.
- Cannot parse MIME.
- Cannot verify signature or cannot decrypt message.
- Authentication failed.
- Specified entity (robot, list, family, user, ...) is not found.
- Incorrect command in the message.
- Command failed.
- Incorrect parameter(s) in request from user agent, or mandatory
  parameters does not be given.
- Other action by user is inhibited or failed (e.g. by scenario).
- Message was ignored by other reason (e.g. No senders).
- ... and other errors caused by inputs from outside of Sympa.

n.b. This level DOES NOT output traceback.


"notice": Epochal events on the system

e.g.:
- Program starts, forks or expectedly stops.
- Data structure was successfully updated.
- Temporary failure is solved (database connection restored etc.)
- List is created, instantiated, closed, restored or purged.
- ... and so on.


"info": Other successful information

e.g.:
- New message was fetched from spool.
- Message was added into spool.
- Message was sent successfully.
- Authentication suceeds.
- List member(s) are added, deleted or successfully synchronized.
- Command succeeds.
- Action by user (partially or completely) succeeds.
- Statistical information.
- ... and other information not related to error nor debugging.


"debug", "debug2", "debug3": Debugging information

e.g.:
- Information for tracing or profiling.
- AND, everything not corresponding to other log levels.


Regards,

--- Soji


-- 
IKEDA Soji <address@concealed>