Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/moul/zapfilter
⚡💊 advanced filtering for uber's zap logger
https://github.com/moul/zapfilter
debug logger logging zap
Last synced: 21 days ago
JSON representation
⚡💊 advanced filtering for uber's zap logger
- Host: GitHub
- URL: https://github.com/moul/zapfilter
- Owner: moul
- License: other
- Created: 2020-09-02T11:15:25.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-05T23:38:16.000Z (about 2 months ago)
- Last Synced: 2024-12-18T05:06:58.775Z (about 1 month ago)
- Topics: debug, logger, logging, zap
- Language: Go
- Homepage: https://manfred.life/golang
- Size: 108 KB
- Stars: 16
- Watchers: 4
- Forks: 2
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
- Support: .github/SUPPORT.md
- Authors: AUTHORS
Awesome Lists containing this project
README
# zapfilter
⚡💊 advanced filtering for uber's zap logger
[](https://pkg.go.dev/moul.io/zapfilter)
[](https://github.com/moul/zapfilter/blob/master/COPYRIGHT)
[](https://github.com/moul/zapfilter/releases)
[](https://manfred.life/)
[](https://github.com/moul/zapfilter/actions?query=workflow%3AGo)
[](https://github.com/moul/zapfilter/actions?query=workflow%3ARelease)
[](https://github.com/moul/zapfilter/actions?query=workflow%3APR)
[](https://golangci.com/r/github.com/moul/zapfilter)
[](https://codecov.io/gh/moul/zapfilter)
[](https://goreportcard.com/report/moul.io/zapfilter)
[](https://www.codefactor.io/repository/github/moul/zapfilter)
## Usage
```go
import "moul.io/zapfilter"
func ExampleParseRules() {
core := zap.NewExample().Core()
// *=myns => any level, myns namespace
// info,warn:myns.* => info or warn level, any namespace matching myns.*
// error=* => everything with error level
logger := zap.New(zapfilter.NewFilteringCore(core, zapfilter.MustParseRules("*:myns info,warn:myns.* error:*")))
defer logger.Sync()
logger.Debug("top debug") // no match
logger.Named("myns").Debug("myns debug") // matches *:myns
logger.Named("bar").Debug("bar debug") // no match
logger.Named("myns").Named("foo").Debug("myns.foo debug") // no match
logger.Info("top info") // no match
logger.Named("myns").Info("myns info") // matches *:myns
logger.Named("bar").Info("bar info") // no match
logger.Named("myns").Named("foo").Info("myns.foo info") // matches info,warn:myns.*
logger.Warn("top warn") // no match
logger.Named("myns").Warn("myns warn") // matches *:myns
logger.Named("bar").Warn("bar warn") // no match
logger.Named("myns").Named("foo").Warn("myns.foo warn") // matches info,warn:myns.*
logger.Error("top error") // matches error:*
logger.Named("myns").Error("myns error") // matches *:myns and error:*
logger.Named("bar").Error("bar error") // matches error:*
logger.Named("myns").Named("foo").Error("myns.foo error") // matches error:*
// Output:
// {"level":"debug","logger":"myns","msg":"myns debug"}
// {"level":"info","logger":"myns","msg":"myns info"}
// {"level":"info","logger":"myns.foo","msg":"myns.foo info"}
// {"level":"warn","logger":"myns","msg":"myns warn"}
// {"level":"warn","logger":"myns.foo","msg":"myns.foo warn"}
// {"level":"error","msg":"top error"}
// {"level":"error","logger":"myns","msg":"myns error"}
// {"level":"error","logger":"bar","msg":"bar error"}
// {"level":"error","logger":"myns.foo","msg":"myns.foo error"}
}
```
[embedmd]:# (.tmp/godoc.txt txt /FUNCTIONS/ $)
```txt
FUNCTIONS
func CheckAnyLevel(logger *zap.Logger) bool
CheckAnyLevel determines whether at least one log level isn't filtered-out
by the logger.
func CheckLevel(logger *zap.Logger, level zapcore.Level) bool
CheckLevel determines whether a specific log level would produce log or not.
func NewFilteringCore(next zapcore.Core, filter FilterFunc) zapcore.Core
NewFilteringCore returns a core middleware that uses the given filter
function to determine whether to actually call Write on the next core in the
chain.
TYPES
type FilterFunc func(zapcore.Entry, []zapcore.Field) bool
FilterFunc is used to check whether to filter the given entry and filters
out.
func All(filters ...FilterFunc) FilterFunc
All checks if all filters return true.
func Any(filters ...FilterFunc) FilterFunc
Any checks if any filter returns true.
func ByLevels(pattern string) (FilterFunc, error)
ByLevels creates a FilterFunc based on a pattern.
Level Patterns
| Pattern | Debug | Info | Warn | Error | DPanic | Panic | Fatal |
| ------- | ----- | ---- | ---- | ----- | ------ | ----- | ----- |
| | X | X | X | X | X | X | X |
| * | X | X | X | X | x | X | X |
| debug | X | | | | | | |
| info | | X | | | | | |
| warn | | | X | | | | |
| error | | | | X | | | |
| dpanic | | | | | X | | |
| panic | | | | | | X | |
| fatal | | | | | | | X |
| debug+ | X | X | x | X | X | X | X |
| info+ | | X | X | X | X | X | X |
| warn+ | | | X | X | X | X | X |
| error+ | | | | X | X | X | X |
| dpanic+ | | | | | X | X | X |
| panic+ | | | | | | X | X |
| fatal+ | | | | | | | X |
func ByNamespaces(input string) FilterFunc
ByNamespaces takes a list of patterns to filter out logs based on their
namespaces. Patterns are checked using path.Match.
func ExactLevel(level zapcore.Level) FilterFunc
ExactLevel filters out entries with an invalid level.
func MinimumLevel(level zapcore.Level) FilterFunc
MinimumLevel filters out entries with a too low level.
func MustParseRules(pattern string) FilterFunc
MustParseRules calls ParseRules and panics if initialization failed.
func ParseRules(pattern string) (FilterFunc, error)
ParseRules takes a CLI-friendly set of rules to construct a filter.
Syntax
pattern: RULE [RULE...]
RULE: one of:
- LEVELS:NAMESPACES
- NAMESPACES
LEVELS: LEVEL,[,LEVEL]
LEVEL: see `Level Patterns`
NAMESPACES: NAMESPACE[,NAMESPACE]
NAMESPACE: one of:
- namespace // should be exactly this namespace
- *mat*ch* // should match
- -NAMESPACE // should not match
Examples
* everything
*:* everything
info:* level info; any namespace
info+:* levels info, warn, error, dpanic, panic, and fatal; any namespace
info,warn:* levels info, warn; any namespace
ns1 any level; namespace 'ns1'
*:ns1 any level; namespace 'ns1'
ns1* any level; namespaces matching 'ns1*'
*:ns1* any level; namespaces matching 'ns1*'
*:ns1,ns2 any level; namespaces 'ns1' and 'ns2'
*:ns*,-ns3* any level; namespaces matching 'ns*' but not matching 'ns3*'
info:ns1 level info; namespace 'ns1'
info,warn:ns1,ns2 levels info and warn; namespaces 'ns1' and 'ns2'
info:ns1 warn:n2 level info + namespace 'ns1' OR level warn and namespace 'ns2'
info,warn:myns* error+:* levels info or warn and namespaces matching 'myns*' OR levels error, dpanic, panic or fatal for any namespace
func Reverse(filter FilterFunc) FilterFunc
Reverse checks is the passed filter returns false.
```
More examples on https://pkg.go.dev/moul.io/zapfilter
## Install
### Using go
```console
$ go get -u moul.io/zapfilter
```
### Releases
See https://github.com/moul/zapfilter/releases
## Contribute
I really welcome contributions. Your input is the most precious material. I'm well aware of that and I thank you in advance. Everyone is encouraged to look at what they can do on their own scale; no effort is too small.
Everything on contribution is sum up here: [CONTRIBUTING.md](./CONTRIBUTING.md)
### Contributors ✨
[](#contributors)
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Manfred Touron
🚧 📖 ⚠️ 💻
moul-bot
🚧
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
### Stargazers over time
[](https://starchart.cc/moul/zapfilter)
## License
© 2020 [Manfred Touron](https://manfred.life)
Licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0) ([`LICENSE-APACHE`](LICENSE-APACHE)) or the [MIT license](https://opensource.org/licenses/MIT) ([`LICENSE-MIT`](LICENSE-MIT)), at your option. See the [`COPYRIGHT`](COPYRIGHT) file for more details.
`SPDX-License-Identifier: (Apache-2.0 OR MIT)`