forgejo/services
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 Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
agit add user rename endpoint to admin api (#22789) 2023-03-14 03:45:21 -04:00
asymkey Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
attachment Preserve file size when creating attachments (#23406) 2023-03-12 03:48:07 -04:00
auth Decouple the different contexts from each other (#24786) 2023-05-21 09:50:53 +08:00
automerge Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
context Decouple the different contexts from each other (#24786) 2023-05-21 09:50:53 +08:00
convert Refactor Pull Mirror and fix out-of-sync bugs (#24732) 2023-05-15 19:02:10 +00:00
cron Add Cargo package registry (#21888) 2023-02-05 18:12:31 +08:00
externalaccount Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
forms Decouple the different contexts from each other (#24786) 2023-05-21 09:50:53 +08:00
gitdiff Simplify template helper functions (#24570) 2023-05-07 09:49:46 +00:00
issue Improve Gitea's web context, decouple "issue template" code into service package (#24590) 2023-05-09 01:30:14 +02:00
lfs Fix auth check bug (#24382) 2023-04-27 22:43:27 +02:00
mailer Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
markup Decouple the different contexts from each other (#24786) 2023-05-21 09:50:53 +08:00
migrations Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
mirror Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
org Refactor rename user and rename organization (#24052) 2023-05-21 23:13:47 +08:00
packages Add Go package registry (#24687) 2023-05-14 23:38:40 +08:00
pull Support for status check pattern (#24633) 2023-05-17 16:11:13 +08:00
release Delete deleted release attachments immediately from storage (#23913) 2023-04-06 18:01:36 -04:00
repository Add status indicator on main home screen for each repo (#24638) 2023-05-13 21:59:01 +00:00
task Make repo migration cancelable and fix various bugs (#24605) 2023-05-11 08:25:46 +00:00
user Refactor rename user and rename organization (#24052) 2023-05-21 23:13:47 +08:00
webhook Rewrite queue (#24505) 2023-05-08 19:49:59 +08:00
wiki Improve wiki user title test (#24559) 2023-05-06 11:24:18 +00:00