0
0
Fork 0
mirror of https://github.com/go-gitea/gitea synced 2024-12-25 02:04:25 +01:00
gitea/modules
wxiaoguang 4647660776
Rewrite logger system (#24726)
## ⚠️ Breaking

The `log.<mode>.<logger>` style config has been dropped. If you used it,
please check the new config manual & app.example.ini to make your
instance output logs as expected.

Although many legacy options still work, it's encouraged to upgrade to
the new options.

The SMTP logger is deleted because SMTP is not suitable to collect logs.

If you have manually configured Gitea log options, please confirm the
logger system works as expected after upgrading.

## Description

Close #12082 and maybe more log-related issues, resolve some related
FIXMEs in old code (which seems unfixable before)

Just like rewriting queue #24505 : make code maintainable, clear legacy
bugs, and add the ability to support more writers (eg: JSON, structured
log)

There is a new document (with examples): `logging-config.en-us.md`

This PR is safer than the queue rewriting, because it's just for
logging, it won't break other logic.

## The old problems

The logging system is quite old and difficult to maintain:
* Unclear concepts: Logger, NamedLogger, MultiChannelledLogger,
SubLogger, EventLogger, WriterLogger etc
* Some code is diffuclt to konw whether it is right:
`log.DelNamedLogger("console")` vs `log.DelNamedLogger(log.DEFAULT)` vs
`log.DelLogger("console")`
* The old system heavily depends on ini config system, it's difficult to
create new logger for different purpose, and it's very fragile.
* The "color" trick is difficult to use and read, many colors are
unnecessary, and in the future structured log could help
* It's difficult to add other log formats, eg: JSON format
* The log outputer doesn't have full control of its goroutine, it's
difficult to make outputer have advanced behaviors
* The logs could be lost in some cases: eg: no Fatal error when using
CLI.
* Config options are passed by JSON, which is quite fragile.
* INI package makes the KEY in `[log]` section visible in `[log.sub1]`
and `[log.sub1.subA]`, this behavior is quite fragile and would cause
more unclear problems, and there is no strong requirement to support
`log.<mode>.<logger>` syntax.


## The new design

See `logger.go` for documents.


## Screenshot

<details>


![image](https://github.com/go-gitea/gitea/assets/2114189/4462d713-ba39-41f5-bb08-de912e67e1ff)


![image](https://github.com/go-gitea/gitea/assets/2114189/b188035e-f691-428b-8b2d-ff7b2199b2f9)


![image](https://github.com/go-gitea/gitea/assets/2114189/132e9745-1c3b-4e00-9e0d-15eaea495dee)

</details>

## TODO

* [x] add some new tests
* [x] fix some tests
* [x] test some sub-commands (manually ....)

---------

Co-authored-by: Jason Song <i@wolfogre.com>
Co-authored-by: delvh <dev.lh@web.de>
Co-authored-by: Giteabot <teabot@gitea.io>
2023-05-21 22:35:11 +00:00
..
actions show workflow config error on file view also (#24267) 2023-04-22 22:16:54 -04:00
activitypub
analyze
assetfs
auth
avatar Improve avatar uploading / resizing / compressing, remove Fomantic card module (#24653) 2023-05-13 20:59:11 +02:00
base
cache
charset Update go tool dependencies, restructure lint targets (#24239) 2023-04-22 14:53:00 -04:00
container
context Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
csv Refactor locale number (#24134) 2023-04-17 11:37:23 +08:00
doctor Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
emoji
eventsource
generate
git Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
gitgraph
graceful Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
hcaptcha
highlight
hostmatcher
html
httpcache Use standard HTTP library to serve files (#24693) 2023-05-13 16:04:57 +02:00
httplib Use standard HTTP library to serve files (#24693) 2023-05-13 16:04:57 +02:00
indexer Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
issue/template
json
label
lfs Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
log Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
markup Fix video width overflow in markdown, and other changes to match img (#24834) 2023-05-21 21:19:37 +00:00
mcaptcha
metrics
migration
mirror Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
nosql
notification Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
options
packages Add Go package registry (#24687) 2023-05-14 23:38:40 +08:00
paginator Use more specific test methods (#24265) 2023-04-22 17:56:27 -04:00
pprof
private Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
process
proxy
proxyprotocol
public Use standard HTTP library to serve files (#24693) 2023-05-13 16:04:57 +02:00
queue Improve queue & process & stacktrace (#24636) 2023-05-11 07:45:47 +00:00
recaptcha
references
regexplru
repository Improve avatar uploading / resizing / compressing, remove Fomantic card module (#24653) 2023-05-13 20:59:11 +02:00
secret Improve decryption failure message (#24573) 2023-05-07 19:29:43 +08:00
session
setting Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
sitemap
ssh Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
storage Implement actions artifacts (#22738) 2023-05-19 21:37:57 +08:00
structs Make repo migration cancelable and fix various bugs (#24605) 2023-05-11 08:25:46 +00:00
svg
sync
system
templates Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
test Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
testlogger Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
timeutil Fix incorrect webhook time and use relative-time to display it (#24477) 2023-05-03 19:53:43 -04:00
translation Decouple the different contexts from each other (#24786) 2023-05-21 09:50:53 +08:00
turnstile
typesniffer
updatechecker
upload
uri
user
util Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
validation
web Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
webhook