1
1
mirror of https://github.com/go-gitea/gitea synced 2024-12-23 09:04:26 +00:00
gitea/routers/web/repo
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 Implement actions artifacts (#22738) 2023-05-19 21:37:57 +08:00
setting Move secrets and runners settings to actions settings (#24200) 2023-04-27 20:08:47 -04:00
activity.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
attachment.go Decouple the different contexts from each other (#24786) 2023-05-21 09:50:53 +08:00
blame.go Sort repo topic labels by name (#24123) 2023-04-14 15:29:05 -04:00
branch.go Improve RSS (#24335) 2023-04-25 22:53:44 -04:00
cherry_pick.go Rename almost all Ctx functions (#22071) 2022-12-10 10:46:31 +08:00
commit.go Pass 'not' to commit count (#24473) 2023-05-08 07:10:53 +00:00
compare.go Don't list root repository on compare page if pulls not allowed (#24183) 2023-04-19 11:16:46 -04:00
download.go Decouple the different contexts from each other (#24786) 2023-05-21 09:50:53 +08:00
editor_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
editor.go Allow adding new files to an empty repo (#24164) 2023-04-19 21:40:42 +08:00
find.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
helper_test.go Refactor authors dropdown (send get request from frontend to avoid long wait time) (#23890) 2023-04-07 08:11:02 +08:00
helper.go Refactor authors dropdown (send get request from frontend to avoid long wait time) (#23890) 2023-04-07 08:11:02 +08:00
http_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
http.go Decouple the different contexts from each other (#24786) 2023-05-21 09:50:53 +08:00
issue_content_history.go Move helpers to be prefixed with gt- (#22879) 2023-02-13 17:59:59 +00:00
issue_dependency.go Add API to manage issue dependencies (#17935) 2023-03-28 13:23:25 -04:00
issue_label_test.go Make label templates have consistent behavior and priority (#23749) 2023-04-10 16:44:02 +08:00
issue_label.go Make label templates have consistent behavior and priority (#23749) 2023-04-10 16:44:02 +08:00
issue_lock.go Fix improper HTMLURL usages in Go code (#22839) 2023-02-11 14:34:11 +08:00
issue_stopwatch.go Speed up HasUserStopwatch & GetActiveStopwatch (#23051) 2023-02-27 13:46:00 -05:00
issue_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
issue_timetrack.go Fix improper HTMLURL usages in Go code (#22839) 2023-02-11 14:34:11 +08:00
issue_watch.go Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
issue.go Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
lfs.go Introduce path Clean/Join helper functions (#23495) 2023-03-21 16:02:49 -04:00
main_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
middlewares.go Use graceful editorconfig loader to reduce errors when loading malformed editorconfigs (#21257) 2023-04-06 16:01:20 -04:00
migrate.go Make repo migration cancelable and fix various bugs (#24605) 2023-05-11 08:25:46 +00:00
milestone.go Improve Gitea's web context, decouple "issue template" code into service package (#24590) 2023-05-09 01:30:14 +02:00
packages.go Use dynamic package type list (#22263) 2022-12-29 00:31:54 +01:00
patch.go Redirect to the commit page after applying patch (#23056) 2023-02-24 16:56:41 +00:00
projects_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
projects.go Add unset default project column (#23531) 2023-04-19 10:28:28 -04:00
pull_review.go Make Ctrl+Enter submit a pending comment (starting review) instead of submitting a single comment (#23245) 2023-03-04 02:13:37 -05:00
pull.go Support for status check pattern (#24633) 2023-05-17 16:11:13 +08:00
release_test.go fix: release page for empty or non-existing target (#24470) 2023-05-10 11:43:55 +08:00
release.go fix: release page for empty or non-existing target (#24470) 2023-05-10 11:43:55 +08:00
render.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo.go Remove the parallelizing when loading repo for dashboard (#24705) 2023-05-14 21:45:47 +08:00
search.go Fix improper HTMLURL usages in Go code (#22839) 2023-02-11 14:34:11 +08:00
setting_protected_branch.go Support for status check pattern (#24633) 2023-05-17 16:11:13 +08:00
setting.go Refactor Pull Mirror and fix out-of-sync bugs (#24732) 2023-05-15 19:02:10 +00:00
settings_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
tag.go Add main landmark to templates and adjust titles (#22670) 2023-02-01 22:56:10 +00:00
topic.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
treelist.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
view_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
view.go Improve Gitea's web context, decouple "issue template" code into service package (#24590) 2023-05-09 01:30:14 +02:00
webhook.go Reenable creating default webhooks. (#24626) 2023-05-11 10:10:57 +08:00
wiki_test.go Make wiki title supports dashes and improve wiki name related features (#24143) 2023-04-19 13:50:10 -04:00
wiki.go Decouple the different contexts from each other (#24786) 2023-05-21 09:50:53 +08:00