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>
</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-22 06:35:11 +08:00
|
|
|
// Copyright 2019 The Gitea Authors. All rights reserved.
|
|
|
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
|
|
|
|
|
|
package setting
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"path/filepath"
|
|
|
|
|
"strings"
|
|
|
|
|
"testing"
|
|
|
|
|
|
2025-03-27 19:40:14 +00:00
|
|
|
"forgejo.org/modules/json"
|
|
|
|
|
"forgejo.org/modules/log"
|
2025-07-30 15:40:12 +02:00
|
|
|
"forgejo.org/modules/test"
|
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>
</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-22 06:35:11 +08:00
|
|
|
|
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
|
)
|
|
|
|
|
|
|
|
|
|
func initLoggersByConfig(t *testing.T, config string) (*log.LoggerManager, func()) {
|
2025-07-30 15:40:12 +02:00
|
|
|
defer test.MockVariableValue(&Log, LogGlobalConfig{})()
|
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>
</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-22 06:35:11 +08:00
|
|
|
|
|
|
|
|
cfg, err := NewConfigProviderFromData(config)
|
2024-07-30 19:41:10 +00:00
|
|
|
require.NoError(t, err)
|
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>
</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-22 06:35:11 +08:00
|
|
|
|
|
|
|
|
manager := log.NewManager()
|
|
|
|
|
initManagedLoggers(manager, cfg)
|
|
|
|
|
return manager, manager.Close
|
|
|
|
|
}
|
|
|
|
|
|
2025-07-30 15:40:12 +02:00
|
|
|
func initLoggerConfig(t *testing.T, config string) ConfigProvider {
|
|
|
|
|
defer test.MockVariableValue(&Log, LogGlobalConfig{})()
|
|
|
|
|
|
|
|
|
|
cfg, err := NewConfigProviderFromData(config)
|
|
|
|
|
require.NoError(t, err)
|
|
|
|
|
|
|
|
|
|
prepareLoggerConfig(cfg)
|
|
|
|
|
|
|
|
|
|
return cfg
|
|
|
|
|
}
|
|
|
|
|
|
2023-07-04 20:36:08 +02:00
|
|
|
func toJSON(v any) string {
|
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>
</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-22 06:35:11 +08:00
|
|
|
b, _ := json.MarshalIndent(v, "", "\t")
|
|
|
|
|
return string(b)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestLogConfigDefault(t *testing.T) {
|
|
|
|
|
manager, managerClose := initLoggersByConfig(t, ``)
|
|
|
|
|
defer managerClose()
|
|
|
|
|
|
|
|
|
|
writerDump := `
|
|
|
|
|
{
|
|
|
|
|
"console": {
|
|
|
|
|
"BufferLen": 10000,
|
|
|
|
|
"Colorize": false,
|
|
|
|
|
"Expression": "",
|
2025-07-04 00:08:23 +02:00
|
|
|
"Exclusion": "",
|
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>
</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-22 06:35:11 +08:00
|
|
|
"Flags": "stdflags",
|
|
|
|
|
"Level": "info",
|
|
|
|
|
"Prefix": "",
|
|
|
|
|
"StacktraceLevel": "none",
|
|
|
|
|
"WriterOption": {
|
|
|
|
|
"Stderr": false
|
|
|
|
|
},
|
|
|
|
|
"WriterType": "console"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
`
|
|
|
|
|
|
|
|
|
|
dump := manager.GetLogger(log.DEFAULT).DumpWriters()
|
|
|
|
|
require.JSONEq(t, writerDump, toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("access").DumpWriters()
|
|
|
|
|
require.JSONEq(t, "{}", toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("router").DumpWriters()
|
|
|
|
|
require.JSONEq(t, writerDump, toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("xorm").DumpWriters()
|
|
|
|
|
require.JSONEq(t, writerDump, toJSON(dump))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestLogConfigDisable(t *testing.T) {
|
|
|
|
|
manager, managerClose := initLoggersByConfig(t, `
|
|
|
|
|
[log]
|
|
|
|
|
logger.router.MODE =
|
|
|
|
|
logger.xorm.MODE =
|
|
|
|
|
`)
|
|
|
|
|
defer managerClose()
|
|
|
|
|
|
|
|
|
|
writerDump := `
|
|
|
|
|
{
|
|
|
|
|
"console": {
|
|
|
|
|
"BufferLen": 10000,
|
|
|
|
|
"Colorize": false,
|
|
|
|
|
"Expression": "",
|
2025-07-04 00:08:23 +02:00
|
|
|
"Exclusion": "",
|
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>
</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-22 06:35:11 +08:00
|
|
|
"Flags": "stdflags",
|
|
|
|
|
"Level": "info",
|
|
|
|
|
"Prefix": "",
|
|
|
|
|
"StacktraceLevel": "none",
|
|
|
|
|
"WriterOption": {
|
|
|
|
|
"Stderr": false
|
|
|
|
|
},
|
|
|
|
|
"WriterType": "console"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
`
|
|
|
|
|
|
|
|
|
|
dump := manager.GetLogger(log.DEFAULT).DumpWriters()
|
|
|
|
|
require.JSONEq(t, writerDump, toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("access").DumpWriters()
|
|
|
|
|
require.JSONEq(t, "{}", toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("router").DumpWriters()
|
|
|
|
|
require.JSONEq(t, "{}", toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("xorm").DumpWriters()
|
|
|
|
|
require.JSONEq(t, "{}", toJSON(dump))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestLogConfigLegacyDefault(t *testing.T) {
|
|
|
|
|
manager, managerClose := initLoggersByConfig(t, `
|
|
|
|
|
[log]
|
|
|
|
|
MODE = console
|
|
|
|
|
`)
|
|
|
|
|
defer managerClose()
|
|
|
|
|
|
|
|
|
|
writerDump := `
|
|
|
|
|
{
|
|
|
|
|
"console": {
|
|
|
|
|
"BufferLen": 10000,
|
|
|
|
|
"Colorize": false,
|
|
|
|
|
"Expression": "",
|
2025-07-04 00:08:23 +02:00
|
|
|
"Exclusion": "",
|
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>
</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-22 06:35:11 +08:00
|
|
|
"Flags": "stdflags",
|
|
|
|
|
"Level": "info",
|
|
|
|
|
"Prefix": "",
|
|
|
|
|
"StacktraceLevel": "none",
|
|
|
|
|
"WriterOption": {
|
|
|
|
|
"Stderr": false
|
|
|
|
|
},
|
|
|
|
|
"WriterType": "console"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
`
|
|
|
|
|
|
|
|
|
|
dump := manager.GetLogger(log.DEFAULT).DumpWriters()
|
|
|
|
|
require.JSONEq(t, writerDump, toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("access").DumpWriters()
|
|
|
|
|
require.JSONEq(t, "{}", toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("router").DumpWriters()
|
|
|
|
|
require.JSONEq(t, writerDump, toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("xorm").DumpWriters()
|
|
|
|
|
require.JSONEq(t, writerDump, toJSON(dump))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestLogConfigLegacyMode(t *testing.T) {
|
|
|
|
|
tempDir := t.TempDir()
|
|
|
|
|
|
|
|
|
|
tempPath := func(file string) string {
|
|
|
|
|
return filepath.Join(tempDir, file)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
manager, managerClose := initLoggersByConfig(t, `
|
|
|
|
|
[log]
|
|
|
|
|
ROOT_PATH = `+tempDir+`
|
|
|
|
|
MODE = file
|
|
|
|
|
ROUTER = file
|
|
|
|
|
ACCESS = file
|
|
|
|
|
`)
|
|
|
|
|
defer managerClose()
|
|
|
|
|
|
|
|
|
|
writerDump := `
|
|
|
|
|
{
|
|
|
|
|
"file": {
|
|
|
|
|
"BufferLen": 10000,
|
|
|
|
|
"Colorize": false,
|
|
|
|
|
"Expression": "",
|
2025-07-04 00:08:23 +02:00
|
|
|
"Exclusion": "",
|
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>
</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-22 06:35:11 +08:00
|
|
|
"Flags": "stdflags",
|
|
|
|
|
"Level": "info",
|
|
|
|
|
"Prefix": "",
|
|
|
|
|
"StacktraceLevel": "none",
|
|
|
|
|
"WriterOption": {
|
|
|
|
|
"Compress": true,
|
|
|
|
|
"CompressionLevel": -1,
|
|
|
|
|
"DailyRotate": true,
|
|
|
|
|
"FileName": "$FILENAME",
|
|
|
|
|
"LogRotate": true,
|
|
|
|
|
"MaxDays": 7,
|
|
|
|
|
"MaxSize": 268435456
|
|
|
|
|
},
|
|
|
|
|
"WriterType": "file"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
`
|
|
|
|
|
writerDumpAccess := `
|
|
|
|
|
{
|
|
|
|
|
"file.access": {
|
|
|
|
|
"BufferLen": 10000,
|
|
|
|
|
"Colorize": false,
|
|
|
|
|
"Expression": "",
|
2025-07-04 00:08:23 +02:00
|
|
|
"Exclusion": "",
|
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>
</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-22 06:35:11 +08:00
|
|
|
"Flags": "none",
|
|
|
|
|
"Level": "info",
|
|
|
|
|
"Prefix": "",
|
|
|
|
|
"StacktraceLevel": "none",
|
|
|
|
|
"WriterOption": {
|
|
|
|
|
"Compress": true,
|
|
|
|
|
"CompressionLevel": -1,
|
|
|
|
|
"DailyRotate": true,
|
|
|
|
|
"FileName": "$FILENAME",
|
|
|
|
|
"LogRotate": true,
|
|
|
|
|
"MaxDays": 7,
|
|
|
|
|
"MaxSize": 268435456
|
|
|
|
|
},
|
|
|
|
|
"WriterType": "file"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
`
|
|
|
|
|
dump := manager.GetLogger(log.DEFAULT).DumpWriters()
|
|
|
|
|
require.JSONEq(t, strings.ReplaceAll(writerDump, "$FILENAME", tempPath("gitea.log")), toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("access").DumpWriters()
|
|
|
|
|
require.JSONEq(t, strings.ReplaceAll(writerDumpAccess, "$FILENAME", tempPath("access.log")), toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("router").DumpWriters()
|
|
|
|
|
require.JSONEq(t, strings.ReplaceAll(writerDump, "$FILENAME", tempPath("gitea.log")), toJSON(dump))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestLogConfigLegacyModeDisable(t *testing.T) {
|
|
|
|
|
manager, managerClose := initLoggersByConfig(t, `
|
|
|
|
|
[log]
|
|
|
|
|
ROUTER = file
|
|
|
|
|
ACCESS = file
|
|
|
|
|
DISABLE_ROUTER_LOG = true
|
|
|
|
|
ENABLE_ACCESS_LOG = false
|
|
|
|
|
`)
|
|
|
|
|
defer managerClose()
|
|
|
|
|
|
|
|
|
|
dump := manager.GetLogger("access").DumpWriters()
|
|
|
|
|
require.JSONEq(t, "{}", toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("router").DumpWriters()
|
|
|
|
|
require.JSONEq(t, "{}", toJSON(dump))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestLogConfigNewConfig(t *testing.T) {
|
|
|
|
|
manager, managerClose := initLoggersByConfig(t, `
|
|
|
|
|
[log]
|
2025-08-01 10:55:05 +02:00
|
|
|
LOGGER_ACCESS_MODE = console
|
|
|
|
|
LOGGER_XORM_MODE = console, console-1
|
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>
</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-22 06:35:11 +08:00
|
|
|
|
|
|
|
|
[log.console]
|
|
|
|
|
LEVEL = warn
|
|
|
|
|
|
|
|
|
|
[log.console-1]
|
|
|
|
|
MODE = console
|
|
|
|
|
LEVEL = error
|
|
|
|
|
STDERR = true
|
|
|
|
|
`)
|
|
|
|
|
defer managerClose()
|
|
|
|
|
|
|
|
|
|
writerDump := `
|
|
|
|
|
{
|
|
|
|
|
"console": {
|
|
|
|
|
"BufferLen": 10000,
|
|
|
|
|
"Colorize": false,
|
|
|
|
|
"Expression": "",
|
2025-07-04 00:08:23 +02:00
|
|
|
"Exclusion": "",
|
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>
</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-22 06:35:11 +08:00
|
|
|
"Flags": "stdflags",
|
|
|
|
|
"Level": "warn",
|
|
|
|
|
"Prefix": "",
|
|
|
|
|
"StacktraceLevel": "none",
|
|
|
|
|
"WriterOption": {
|
|
|
|
|
"Stderr": false
|
|
|
|
|
},
|
|
|
|
|
"WriterType": "console"
|
|
|
|
|
},
|
|
|
|
|
"console-1": {
|
|
|
|
|
"BufferLen": 10000,
|
|
|
|
|
"Colorize": false,
|
|
|
|
|
"Expression": "",
|
2025-07-04 00:08:23 +02:00
|
|
|
"Exclusion": "",
|
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>
</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-22 06:35:11 +08:00
|
|
|
"Flags": "stdflags",
|
|
|
|
|
"Level": "error",
|
|
|
|
|
"Prefix": "",
|
|
|
|
|
"StacktraceLevel": "none",
|
|
|
|
|
"WriterOption": {
|
|
|
|
|
"Stderr": true
|
|
|
|
|
},
|
|
|
|
|
"WriterType": "console"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
`
|
|
|
|
|
writerDumpAccess := `
|
|
|
|
|
{
|
|
|
|
|
"console.access": {
|
|
|
|
|
"BufferLen": 10000,
|
|
|
|
|
"Colorize": false,
|
|
|
|
|
"Expression": "",
|
2025-07-04 00:08:23 +02:00
|
|
|
"Exclusion": "",
|
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>
</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-22 06:35:11 +08:00
|
|
|
"Flags": "none",
|
|
|
|
|
"Level": "warn",
|
|
|
|
|
"Prefix": "",
|
|
|
|
|
"StacktraceLevel": "none",
|
|
|
|
|
"WriterOption": {
|
|
|
|
|
"Stderr": false
|
|
|
|
|
},
|
|
|
|
|
"WriterType": "console"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
`
|
|
|
|
|
dump := manager.GetLogger("xorm").DumpWriters()
|
|
|
|
|
require.JSONEq(t, writerDump, toJSON(dump))
|
|
|
|
|
|
|
|
|
|
dump = manager.GetLogger("access").DumpWriters()
|
|
|
|
|
require.JSONEq(t, writerDumpAccess, toJSON(dump))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func TestLogConfigModeFile(t *testing.T) {
|
|
|
|
|
tempDir := t.TempDir()
|
|
|
|
|
|
|
|
|
|
tempPath := func(file string) string {
|
|
|
|
|
return filepath.Join(tempDir, file)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
manager, managerClose := initLoggersByConfig(t, `
|
|
|
|
|
[log]
|
|
|
|
|
ROOT_PATH = `+tempDir+`
|
|
|
|
|
BUFFER_LEN = 10
|
|
|
|
|
MODE = file, file1
|
|
|
|
|
|
|
|
|
|
[log.file1]
|
|
|
|
|
MODE = file
|
|
|
|
|
LEVEL = error
|
|
|
|
|
STACKTRACE_LEVEL = fatal
|
|
|
|
|
EXPRESSION = filter
|
2025-07-04 00:08:23 +02:00
|
|
|
EXCLUSION = not
|
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>
</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-22 06:35:11 +08:00
|
|
|
FLAGS = medfile
|
|
|
|
|
PREFIX = "[Prefix] "
|
|
|
|
|
FILE_NAME = file-xxx.log
|
|
|
|
|
LOG_ROTATE = false
|
|
|
|
|
MAX_SIZE_SHIFT = 1
|
|
|
|
|
DAILY_ROTATE = false
|
|
|
|
|
MAX_DAYS = 90
|
|
|
|
|
COMPRESS = false
|
|
|
|
|
COMPRESSION_LEVEL = 4
|
|
|
|
|
`)
|
|
|
|
|
defer managerClose()
|
|
|
|
|
|
|
|
|
|
writerDump := `
|
|
|
|
|
{
|
|
|
|
|
"file": {
|
|
|
|
|
"BufferLen": 10,
|
|
|
|
|
"Colorize": false,
|
|
|
|
|
"Expression": "",
|
2025-07-04 00:08:23 +02:00
|
|
|
"Exclusion": "",
|
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>
</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-22 06:35:11 +08:00
|
|
|
"Flags": "stdflags",
|
|
|
|
|
"Level": "info",
|
|
|
|
|
"Prefix": "",
|
|
|
|
|
"StacktraceLevel": "none",
|
|
|
|
|
"WriterOption": {
|
|
|
|
|
"Compress": true,
|
|
|
|
|
"CompressionLevel": -1,
|
|
|
|
|
"DailyRotate": true,
|
|
|
|
|
"FileName": "$FILENAME-0",
|
|
|
|
|
"LogRotate": true,
|
|
|
|
|
"MaxDays": 7,
|
|
|
|
|
"MaxSize": 268435456
|
|
|
|
|
},
|
|
|
|
|
"WriterType": "file"
|
|
|
|
|
},
|
|
|
|
|
"file1": {
|
|
|
|
|
"BufferLen": 10,
|
|
|
|
|
"Colorize": false,
|
|
|
|
|
"Expression": "filter",
|
2025-07-04 00:08:23 +02:00
|
|
|
"Exclusion": "not",
|
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>
</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-22 06:35:11 +08:00
|
|
|
"Flags": "medfile",
|
|
|
|
|
"Level": "error",
|
|
|
|
|
"Prefix": "[Prefix] ",
|
|
|
|
|
"StacktraceLevel": "fatal",
|
|
|
|
|
"WriterOption": {
|
|
|
|
|
"Compress": false,
|
|
|
|
|
"CompressionLevel": 4,
|
|
|
|
|
"DailyRotate": false,
|
|
|
|
|
"FileName": "$FILENAME-1",
|
|
|
|
|
"LogRotate": false,
|
|
|
|
|
"MaxDays": 90,
|
|
|
|
|
"MaxSize": 2
|
|
|
|
|
},
|
|
|
|
|
"WriterType": "file"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
`
|
|
|
|
|
|
|
|
|
|
dump := manager.GetLogger(log.DEFAULT).DumpWriters()
|
|
|
|
|
expected := writerDump
|
|
|
|
|
expected = strings.ReplaceAll(expected, "$FILENAME-0", tempPath("gitea.log"))
|
|
|
|
|
expected = strings.ReplaceAll(expected, "$FILENAME-1", tempPath("file-xxx.log"))
|
|
|
|
|
require.JSONEq(t, expected, toJSON(dump))
|
|
|
|
|
}
|
2025-07-30 15:40:12 +02:00
|
|
|
|
|
|
|
|
func TestLegacyLoggerMigrations(t *testing.T) {
|
|
|
|
|
type Cases = []struct {
|
|
|
|
|
name string
|
|
|
|
|
cfg string
|
|
|
|
|
exp string
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
runCases := func(t *testing.T, key string, cases Cases) {
|
|
|
|
|
for _, c := range cases {
|
|
|
|
|
t.Run(c.name, func(t *testing.T) {
|
|
|
|
|
cfg := initLoggerConfig(t, c.cfg)
|
|
|
|
|
require.Equal(t, c.exp, cfg.Section("log").Key(key).String())
|
|
|
|
|
})
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
t.Run("default", func(t *testing.T) {
|
2025-08-01 10:55:05 +02:00
|
|
|
runCases(t, "LOGGER_DEFAULT_MODE", Cases{
|
2025-07-30 15:40:12 +02:00
|
|
|
{
|
|
|
|
|
"uses default value for default logger",
|
|
|
|
|
"",
|
|
|
|
|
",",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"uses logger.default.MODE for default logger",
|
|
|
|
|
`[log]
|
|
|
|
|
logger.default.MODE = file
|
|
|
|
|
`,
|
|
|
|
|
"file",
|
|
|
|
|
},
|
|
|
|
|
})
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
t.Run("access", func(t *testing.T) {
|
2025-08-01 10:55:05 +02:00
|
|
|
runCases(t, "LOGGER_ACCESS_MODE", Cases{
|
2025-07-30 15:40:12 +02:00
|
|
|
{
|
|
|
|
|
"uses default value for access logger",
|
|
|
|
|
"",
|
|
|
|
|
"",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"uses ACCESS for access logger",
|
|
|
|
|
`[log]
|
|
|
|
|
ACCESS = file
|
|
|
|
|
`,
|
|
|
|
|
"file",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"ENABLE_ACCESS_LOG=true doesn't change access logger",
|
|
|
|
|
`[log]
|
|
|
|
|
ENABLE_ACCESS_LOG = true
|
|
|
|
|
logger.access.MODE = console
|
|
|
|
|
`,
|
|
|
|
|
"console",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"ENABLE_ACCESS_LOG=false disables access logger",
|
|
|
|
|
`[log]
|
|
|
|
|
ENABLE_ACCESS_LOG = false
|
|
|
|
|
logger.access.MODE = console
|
|
|
|
|
`,
|
|
|
|
|
"",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"logger.access.MODE has precedence over ACCESS for access logger",
|
|
|
|
|
`[log]
|
|
|
|
|
ACCESS = file
|
|
|
|
|
logger.access.MODE = console
|
|
|
|
|
`,
|
|
|
|
|
"console",
|
|
|
|
|
},
|
2025-08-01 10:55:05 +02:00
|
|
|
{
|
|
|
|
|
"LOGGER_ACCESS_MODE has precedence over logger.access.MODE for access logger",
|
|
|
|
|
`[log]
|
|
|
|
|
LOGGER_ACCESS_MODE = file
|
|
|
|
|
logger.access.MODE = console
|
|
|
|
|
`,
|
|
|
|
|
"file",
|
|
|
|
|
},
|
2025-07-30 15:40:12 +02:00
|
|
|
{
|
|
|
|
|
"ENABLE_ACCESS_LOG doesn't enable access logger",
|
|
|
|
|
`[log]
|
|
|
|
|
ENABLE_ACCESS_LOG = true
|
|
|
|
|
`,
|
|
|
|
|
"", // should be `,`
|
|
|
|
|
},
|
|
|
|
|
})
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
t.Run("router", func(t *testing.T) {
|
2025-08-01 10:55:05 +02:00
|
|
|
runCases(t, "LOGGER_ROUTER_MODE", Cases{
|
2025-07-30 15:40:12 +02:00
|
|
|
{
|
|
|
|
|
"uses default value for router logger",
|
|
|
|
|
"",
|
|
|
|
|
",",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"uses ROUTER for router logger",
|
|
|
|
|
`[log]
|
|
|
|
|
ROUTER = file
|
|
|
|
|
`,
|
|
|
|
|
"file",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"DISABLE_ROUTER_LOG=false doesn't change router logger",
|
|
|
|
|
`[log]
|
|
|
|
|
ROUTER = file
|
|
|
|
|
DISABLE_ROUTER_LOG = false
|
|
|
|
|
`,
|
|
|
|
|
"file",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"DISABLE_ROUTER_LOG=true disables router logger",
|
|
|
|
|
`[log]
|
|
|
|
|
DISABLE_ROUTER_LOG = true
|
|
|
|
|
logger.router.MODE = console
|
|
|
|
|
`,
|
|
|
|
|
"",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"logger.router.MODE as precedence over ROUTER for router logger",
|
|
|
|
|
`[log]
|
|
|
|
|
ROUTER = file
|
|
|
|
|
logger.router.MODE = console
|
|
|
|
|
`,
|
|
|
|
|
"console",
|
|
|
|
|
},
|
2025-08-01 10:55:05 +02:00
|
|
|
{
|
|
|
|
|
"LOGGER_ROUTER_MODE has precedence over logger.router.MODE for router logger",
|
|
|
|
|
`[log]
|
|
|
|
|
LOGGER_ROUTER_MODE = file
|
|
|
|
|
logger.router.MODE = console
|
|
|
|
|
`,
|
|
|
|
|
"file",
|
|
|
|
|
},
|
2025-07-30 15:40:12 +02:00
|
|
|
})
|
|
|
|
|
})
|
|
|
|
|
|
|
|
|
|
t.Run("xorm", func(t *testing.T) {
|
2025-08-01 10:55:05 +02:00
|
|
|
runCases(t, "LOGGER_XORM_MODE", Cases{
|
2025-07-30 15:40:12 +02:00
|
|
|
{
|
|
|
|
|
"uses default value for xorm logger",
|
|
|
|
|
"",
|
|
|
|
|
",",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"uses XORM for xorm logger",
|
|
|
|
|
`[log]
|
|
|
|
|
XORM = file
|
|
|
|
|
`,
|
|
|
|
|
"file",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"ENABLE_XORM_LOG=true doesn't change xorm logger",
|
|
|
|
|
`[log]
|
|
|
|
|
ENABLE_XORM_LOG = true
|
|
|
|
|
logger.xorm.MODE = console
|
|
|
|
|
`,
|
|
|
|
|
"console",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"ENABLE_XORM_LOG=false disables xorm logger",
|
|
|
|
|
`[log]
|
|
|
|
|
ENABLE_XORM_LOG = false
|
|
|
|
|
logger.xorm.MODE = console
|
|
|
|
|
`,
|
|
|
|
|
"",
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"logger.xorm.MODE has precedence over XORM for xorm logger",
|
|
|
|
|
`[log]
|
|
|
|
|
XORM = file
|
|
|
|
|
logger.xorm.MODE = console
|
|
|
|
|
`,
|
|
|
|
|
"console",
|
|
|
|
|
},
|
2025-08-01 10:55:05 +02:00
|
|
|
{
|
|
|
|
|
"LOGGER_XORM_MODE has precedence over logger.xorm.MODE for xorm logger",
|
|
|
|
|
`[log]
|
|
|
|
|
LOGGER_XORM_MODE = file
|
|
|
|
|
logger.xorm.MODE = console
|
|
|
|
|
`,
|
|
|
|
|
"file",
|
|
|
|
|
},
|
2025-07-30 15:40:12 +02:00
|
|
|
})
|
|
|
|
|
})
|
|
|
|
|
}
|
