Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to wrap/override sink and encoder #1438

Open
dkropachev opened this issue May 25, 2024 · 0 comments · May be fixed by #1439
Open

Add option to wrap/override sink and encoder #1438

dkropachev opened this issue May 25, 2024 · 0 comments · May be fixed by #1439

Comments

@dkropachev
Copy link

Is your feature request related to a problem? Please describe.
I would want to override encoder, to mask some data out from logs, or encode it:

type MaskingEncoder struct {
	zapcore.Encoder
}

func (m *MaskingEncoder) EncodeEntry(entry zapcore.Entry, fields []zapcore.Field) (*buffer.Buffer, error) {
	filtered := make([]zapcore.Field, 0, len(fields))
	for _, field := range fields {
		key := strings.ToLower(field.Key)
		if slices.ContainsFunc(skipFieldRegexps, func(r *regexp.Regexp) bool {
			return r.Match([]byte(key))
		}) {
			continue
		}
		filtered = append(filtered, field)
	}
	return m.Encoder.EncodeEntry(entry, filtered)
}

And I want to wrap sinker to dump all the requests to a buffer to test logging.

Describe the solution you'd like
I would like to do it same way it is done for zapcore.Core, via zap.WrapCore:

	l, err := zapConf.Build(zapcore.WrapEncoder())

Describe alternatives you've considered
Alternatives to wrap encoder:

  1. Wrap whole logger and filter out fields
  2. Register another encoder and fix all the configs to use it.
  3. Copy zapcore.Config.Build code and inject it in there

Alternatives to wrap sinker:

  1. Copy zapcore.Config.Build code and inject it in there

Is this a breaking change?
Nope

dkropachev pushed a commit to dkropachev/zap that referenced this issue May 26, 2024
Makes it possible to override/wrap encoder/sink
dkropachev pushed a commit to dkropachev/zap that referenced this issue May 26, 2024
Makes it possible to override/wrap encoder/sink
@dkropachev dkropachev linked a pull request May 26, 2024 that will close this issue
dkropachev pushed a commit to dkropachev/zap that referenced this issue May 26, 2024
Makes it possible to override/wrap encoder/sink
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging a pull request may close this issue.

1 participant