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/cmd
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.go Merge setting.InitXXX into one function with options (#24389) 1 year ago
admin.go Handle OpenID discovery URL errors a little nicer when creating/editing sources (#23397) 1 year ago
admin_auth_ldap.go Implement FSFE REUSE for golang files (#21840) 2 years ago
admin_auth_ldap_test.go Implement FSFE REUSE for golang files (#21840) 2 years ago
admin_user.go Add command to bulk set must-change-password (#22823) 1 year ago
admin_user_change_password.go Provide the ability to set password hash algorithm parameters (#22942) 1 year ago
admin_user_create.go Provide the ability to set password hash algorithm parameters (#22942) 1 year ago
admin_user_delete.go Add context cache as a request level cache (#22294) 1 year ago
admin_user_generate_access_token.go Add command to bulk set must-change-password (#22823) 1 year ago
admin_user_list.go Add command to bulk set must-change-password (#22823) 1 year ago
admin_user_must_change_password.go Add command to bulk set must-change-password (#22823) 1 year ago
cert.go Implement FSFE REUSE for golang files (#21840) 2 years ago
cmd.go Rewrite logger system (#24726) 1 year ago
convert.go Support converting varchar to nvarchar for mssql database (#24105) 1 year ago
docs.go Implement FSFE REUSE for golang files (#21840) 2 years ago
doctor.go Rewrite logger system (#24726) 1 year ago
dump.go Rewrite logger system (#24726) 1 year ago
dump_repo.go Refactor the setting to make unit test easier (#22405) 1 year ago
embedded.go Rewrite logger system (#24726) 1 year ago
generate.go Implement FSFE REUSE for golang files (#21840) 2 years ago
hook.go Rewrite queue (#24505) 1 year ago
hook_test.go Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 1 year ago
keys.go Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 1 year ago
mailer.go Merge setting.InitXXX into one function with options (#24389) 1 year ago
main_test.go Merge setting.InitXXX into one function with options (#24389) 1 year ago
manager.go Refactor internal API for git commands, use meaningful messages instead of "Internal Server Error" (#23687) 1 year ago
manager_logging.go Rewrite logger system (#24726) 1 year ago
migrate.go Refactor the setting to make unit test easier (#22405) 1 year ago
migrate_storage.go Support migrating storage for actions log via command line (#24679) 1 year ago
migrate_storage_test.go Add Debian package registry (#24426) 1 year ago
restore_repo.go Merge setting.InitXXX into one function with options (#24389) 1 year ago
serv.go Rewrite logger system (#24726) 1 year ago
web.go Rewrite logger system (#24726) 1 year ago
web_acme.go Implement FSFE REUSE for golang files (#21840) 2 years ago
web_graceful.go Implement FSFE REUSE for golang files (#21840) 2 years ago
web_https.go Implement FSFE REUSE for golang files (#21840) 2 years ago