[PATCH] Project identificator in Trac's log

[tomas.ruden@…]

It would be useful if the trac log contained a string identifying project. When directing log to syslog this would make it possible to distinguish log entries for different projects.

[Matthew Good]

#3657 has been marked as a duplicate.

[maz <mzizka@…>]

Add project path to log output

[maz <mzizka@…>]

I attached a simple patch against 10.3 that adds the (absolute) project path to the log output. Works for me, but feel free to use another format.

I'm taking the liberty of setting milestone to 0.10.4 but again, change this to whatever is most convenient.

[Christian Boos]

It's OK for me.

[Emmanuel Blot]

Replying to cboos:

It's OK for me.

Not to me.
This feature should be optional: when a log file contains the traces of a single project, this addition would add useless information, make the log file harder to read, and make it grow faster.

I think a better approach - in order to avoid several options to define the log format - would be to use a customizable string as Apache does. Define some magic characters that would be replaced with the actual content, such as:

• %P : project name
• %p : project path
• %t : time
• %s : the original log message
• …

and a single log format option:

[log]
format = [%t] Trac %p/%P %s

[Christian Boos]

OK, what about that log_format-r4543.diff​?

I prefer to use long names in the log format, instead of cryptic one-letter codes: not only is that clearer to someone reading the trac.ini file, but it allows to use the full range of keys supported by the logger, among which I find the "thread" one to be quite useful…

If you have an idea about how to circumvent the interpretation of "%(…)s" strings by the ConfigParser better than using "$(…)s" instead, let me know.

[Christian Boos]

Configurable format for the log messages.

[Emmanuel Blot]

Replying to cboos:

OK, what about that log_format-r4543.diff​?

I have not tried it, but the description seems great, thanks. Ok with the long name syntax.
I'm not sure to understand the choice of logid for the full environment path though.

[Christian Boos]

Well, simply there was already an argument called logid in the logger_factory function, used to provide an unique identifier for the logger. That happens to be the path name when called from env.py.

Makes me think that I should balance the code between env.py and log.py a bit differently…

[maz <mzizka@…>]

Nice work. This way the format doesn't change by default, and people who use scripts to parse the log will not have to change anything.

[Christian Boos]

Improved patch applied in r4546 (trunk) and r4547 (0.10-stable).

Oops, sorry maz, just realized I copy/pasted your name and your e-mail in the commit message…

[Christian Boos]

(and now forgot to close it… need a break ;) )