forgejo/modules/git
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
..
foreachref
internal Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
pipeline Refactor and tidy-up the merge/update branch code (#22568) 2023-03-07 15:07:35 -05:00
tests/repos Fix commit retrieval by tag (#21804) 2023-03-02 13:32:21 +08:00
url
batch_reader.go
blame.go Fix blame view missing lines (#22826) 2023-02-09 11:51:02 +08:00
blame_test.go Fix blame view missing lines (#22826) 2023-02-09 11:51:02 +08:00
blob.go
blob_gogit.go
blob_nogogit.go
blob_test.go
command.go Allow adding new files to an empty repo (#24164) 2023-04-19 21:40:42 +08:00
command_race_test.go
command_test.go Improve git log for debugging (#24095) 2023-04-13 19:17:27 -04:00
commit.go Pass 'not' to commit count (#24473) 2023-05-08 07:10:53 +00:00
commit_convert_gogit.go
commit_info.go
commit_info_gogit.go
commit_info_nogogit.go
commit_info_test.go
commit_reader.go
commit_test.go Pass 'not' to commit count (#24473) 2023-05-08 07:10:53 +00:00
diff.go
diff_test.go
error.go
git.go Support reflogs (#22451) 2023-03-13 15:51:07 +08:00
git_test.go Rewrite logger system (#24726) 2023-05-21 22:35:11 +00:00
hook.go
last_commit_cache.go Use minio/sha256-simd for accelerated SHA256 (#23052) 2023-02-22 14:21:46 -05:00
last_commit_cache_gogit.go
last_commit_cache_nogogit.go
log_name_status.go Handle files starting with colons in WalkGitLog (#22935) 2023-03-16 11:03:04 -05:00
notes.go
notes_gogit.go
notes_nogogit.go
notes_test.go
parse_gogit.go
parse_gogit_test.go
parse_nogogit.go
parse_nogogit_test.go
README.md
ref.go
remote.go
repo.go Faster git.GetDivergingCommits (#24482) 2023-05-04 05:08:41 +00:00
repo_archive.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_attribute.go Refactor legacy strange git operations (#22756) 2023-02-06 10:23:17 +08:00
repo_attribute_test.go Use more specific test methods (#24265) 2023-04-22 17:56:27 -04:00
repo_base.go
repo_base_gogit.go
repo_base_nogogit.go Allow adding new files to an empty repo (#24164) 2023-04-19 21:40:42 +08:00
repo_blame.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_blob.go
repo_blob_gogit.go
repo_blob_nogogit.go
repo_blob_test.go
repo_branch.go Add status indicator on main home screen for each repo (#24638) 2023-05-13 21:59:01 +00:00
repo_branch_gogit.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_branch_nogogit.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_branch_test.go
repo_commit.go Pass 'not' to commit count (#24473) 2023-05-08 07:10:53 +00:00
repo_commit_gogit.go Fix commit retrieval by tag (#21804) 2023-03-02 13:32:21 +08:00
repo_commit_nogogit.go Fix commit retrieval by tag (#21804) 2023-03-02 13:32:21 +08:00
repo_commit_test.go Use more specific test methods (#24265) 2023-04-22 17:56:27 -04:00
repo_commitgraph.go
repo_commitgraph_gogit.go
repo_compare.go Add git dashes separator to some "log" and "diff" commands (#23606) 2023-03-26 19:31:21 +01:00
repo_compare_test.go
repo_gpg.go
repo_hook.go
repo_index.go Use complete SHA to create and query commit status (#22244) 2022-12-27 21:12:49 +08:00
repo_language_stats.go
repo_language_stats_gogit.go
repo_language_stats_nogogit.go
repo_language_stats_test.go
repo_object.go
repo_ref.go
repo_ref_gogit.go
repo_ref_nogogit.go
repo_ref_test.go Fix commit retrieval by tag (#21804) 2023-03-02 13:32:21 +08:00
repo_stats.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_stats_test.go Fix commit retrieval by tag (#21804) 2023-03-02 13:32:21 +08:00
repo_tag.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_tag_gogit.go
repo_tag_nogogit.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_tag_test.go Use more specific test methods (#24265) 2023-04-22 17:56:27 -04:00
repo_test.go Faster git.GetDivergingCommits (#24482) 2023-05-04 05:08:41 +00:00
repo_tree.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
repo_tree_gogit.go Use complete SHA to create and query commit status (#22244) 2022-12-27 21:12:49 +08:00
repo_tree_nogogit.go Use complete SHA to create and query commit status (#22244) 2022-12-27 21:12:49 +08:00
sha1.go Use complete SHA to create and query commit status (#22244) 2022-12-27 21:12:49 +08:00
sha1_gogit.go
sha1_nogogit.go
sha1_test.go
signature.go
signature_gogit.go
signature_nogogit.go
submodule.go
submodule_test.go
tag.go
tag_test.go
tree.go
tree_blob.go
tree_blob_gogit.go
tree_blob_nogogit.go
tree_entry.go Remember to attach the parent tree when converting TreeEntry() -> Tree() (#22902) 2023-02-14 21:23:04 +00:00
tree_entry_gogit.go
tree_entry_mode.go
tree_entry_nogogit.go
tree_entry_test.go
tree_gogit.go
tree_nogogit.go Refactor git command package to improve security and maintainability (#22678) 2023-02-04 10:30:43 +08:00
utils.go
utils_test.go

Git Module

This module is merged from https://github.com/go-gitea/git which is a Go module to access Git through shell commands. Now it's a part of gitea's main repository for easier pull request.