You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
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>
1 year ago
..
actions Rewrite queue (#24505) 1 year ago
agit add user rename endpoint to admin api (#22789) 1 year ago
asymkey Add context cache as a request level cache (#22294) 1 year ago
attachment Preserve file size when creating attachments (#23406) 1 year ago
auth Decouple the different contexts from each other (#24786) 1 year ago
automerge Rewrite queue (#24505) 1 year ago
context Decouple the different contexts from each other (#24786) 1 year ago
convert Refactor Pull Mirror and fix out-of-sync bugs (#24732) 1 year ago
cron Add Cargo package registry (#21888) 1 year ago
externalaccount Implement FSFE REUSE for golang files (#21840) 2 years ago
forms Decouple the different contexts from each other (#24786) 1 year ago
gitdiff Simplify template helper functions (#24570) 1 year ago
issue Improve Gitea's web context, decouple "issue template" code into service package (#24590) 1 year ago
lfs Fix auth check bug (#24382) 1 year ago
mailer Rewrite queue (#24505) 1 year ago
markup Decouple the different contexts from each other (#24786) 1 year ago
migrations Rewrite logger system (#24726) 1 year ago
mirror Rewrite queue (#24505) 1 year ago
org Refactor rename user and rename organization (#24052) 1 year ago
packages Add Go package registry (#24687) 1 year ago
pull Support for status check pattern (#24633) 1 year ago
release Delete deleted release attachments immediately from storage (#23913) 1 year ago
repository Add status indicator on main home screen for each repo (#24638) 1 year ago
task Make repo migration cancelable and fix various bugs (#24605) 1 year ago
user Refactor rename user and rename organization (#24052) 1 year ago
webhook Rewrite queue (#24505) 1 year ago
wiki Improve wiki user title test (#24559) 1 year ago