1
1
mirror of https://github.com/go-gitea/gitea synced 2024-11-14 14:14:25 +00:00
gitea/models/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
..
archiver.go Display when a repo was archived (#22664) 2023-04-26 10:46:26 -04:00
attachment_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
attachment.go Make Release Download URLs predictable (#23891) 2023-04-12 17:05:23 +08:00
avatar.go Add context cache as a request level cache (#22294) 2023-02-15 21:37:34 +08:00
collaboration_test.go Rename almost all Ctx functions (#22071) 2022-12-10 10:46:31 +08:00
collaboration.go Always reuse transaction (#22362) 2023-01-08 09:34:58 +08:00
fork_test.go refactor some functions to support ctx as first parameter (#21878) 2022-12-03 10:48:26 +08:00
fork.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
git.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
issue.go Rename almost all Ctx functions (#22071) 2022-12-10 10:46:31 +08:00
language_stats.go Round language stats percentage using largest remainder (#22026) 2022-12-08 10:47:47 +08:00
main_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
mirror.go Use ErrInvalidArgument in packages (#22268) 2022-12-31 12:49:37 +01:00
pushmirror_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
pushmirror.go Use ErrInvalidArgument in packages (#22268) 2022-12-31 12:49:37 +01:00
redirect_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
redirect.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
release.go fix: release page for empty or non-existing target (#24470) 2023-05-10 11:43:55 +08:00
repo_indexer.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
repo_list_test.go fix calReleaseNumCommitsBehind (#24148) 2023-04-18 21:11:17 +02:00
repo_list.go Use context for RepositoryList.LoadAttributes (#23435) 2023-03-13 11:31:41 +00:00
repo_test.go Set repository link based on the url in package.json for npm packages (#20379) 2023-03-28 13:55:03 -04:00
repo_unit.go Pull Requests: setting to allow edits by maintainers by default, tweak UI (#22862) 2023-02-13 14:09:52 +08:00
repo.go Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
search.go Split "modules/context.go" to separate files (#24569) 2023-05-08 17:36:54 +08:00
star_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
star.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
topic_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
topic.go Fix topics deleted via API not being deleted in org page (#24825) 2023-05-21 11:03:20 +02:00
update.go Fix unclear IsRepositoryExist logic (#24374) 2023-04-28 14:14:26 -04:00
upload.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
user_repo_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
user_repo.go Refactor authors dropdown (send get request from frontend to avoid long wait time) (#23890) 2023-04-07 08:11:02 +08:00
watch_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
watch.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
wiki_test.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00
wiki.go Implement FSFE REUSE for golang files (#21840) 2022-11-27 18:20:29 +00:00