This repository was archived by the owner on May 21, 2025. It is now read-only.
Cobracli followup dual logger #22
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
8605c81 to
02eb32f
Compare
|
Issues linked to changelog: |
added 21 commits
April 17, 2019 21:11
mitchdraft
commented
Apr 19, 2019
| "github.com/solo-io/glooshot/pkg/version" | ||
| ) | ||
|
|
||
| var GlooshotConfig = clilog.CommandConfig{ |
There was a problem hiding this comment.
walkthrough: All CLIs that want to use the log util should specify this config
mitchdraft
commented
Apr 19, 2019
| } | ||
|
|
||
| //EncodeEntry implements the distinguishing features of this encoder type. | ||
| func (c cliEncoder) EncodeEntry(ent zapcore.Entry, fields []zapcore.Field) (*buffer.Buffer, error) { |
There was a problem hiding this comment.
walkthrough: this is the key encoder method that implements the human-friendly console logs
mitchdraft
commented
Apr 19, 2019
| import "go.uber.org/zap/buffer" | ||
|
|
||
| var ( | ||
| _pool = buffer.NewPool() |
There was a problem hiding this comment.
walkthrough: this is how zapcore does it, figured we may as well. The encoder could be simplified, but following the format of the core encoders seems like a good idea
mitchdraft
commented
Apr 19, 2019
| ctx context.Context | ||
| } | ||
|
|
||
| func (cc CommandConfig) Run() { |
There was a problem hiding this comment.
walkthrough: this abstracts the root error handling logic that we duplicate in most of our clis
mitchdraft
commented
Apr 19, 2019
|
|
||
| // TODO(mitchdraft) - move to go-utils https://github.com/solo-io/go-utils/issues/131 | ||
|
|
||
| func printTrimmedStack() { |
There was a problem hiding this comment.
walkthrough: I find this very helpful while creating tests, saves you from having to think about the Expect Offset level
mitchdraft
commented
Apr 19, 2019
| Short: "CLI for glooshot", | ||
| Version: version, | ||
| RunE: func(cmd *cobra.Command, args []string) error { | ||
| if o.Top.Temp { |
There was a problem hiding this comment.
walkthrough: this will be removed when the utils/tests are moved to go-utils
it exists as a means of executing the new console logger
|
@rickducott this introduces a few utils that will be shifted out, I added some notes to help focus your attention. Let me know if I can clarify anything |
|
regarding the simpler form of the cli encoder, I was ready to replace my implementation with: package basic_cli_encoder
import (
"go.uber.org/zap/buffer"
"go.uber.org/zap/zapcore"
"time"
)
// Unlike zap's built-in console encoder, this encoder just prints strings, in the manner of fmt.Println.
type cliEncoder struct {
printedKey string
}
// these interface methods are irrelevant to the current needs of the CLI encoder
func (c *cliEncoder) AddArray(key string, marshaler zapcore.ArrayMarshaler) error { return nil }
func (c *cliEncoder) AddObject(key string, marshaler zapcore.ObjectMarshaler) error { return nil }
func (c *cliEncoder) AddBinary(key string, value []byte) {}
func (c *cliEncoder) AddByteString(key string, value []byte) {}
func (c *cliEncoder) AddBool(key string, value bool) {}
func (c *cliEncoder) AddComplex128(key string, value complex128) {}
func (c *cliEncoder) AddComplex64(key string, value complex64) {}
func (c *cliEncoder) AddDuration(key string, value time.Duration) {}
func (c *cliEncoder) AddFloat64(key string, value float64) {}
func (c *cliEncoder) AddFloat32(key string, value float32) {}
func (c *cliEncoder) AddInt(key string, value int) {}
func (c *cliEncoder) AddInt64(key string, value int64) {}
func (c *cliEncoder) AddInt32(key string, value int32) {}
func (c *cliEncoder) AddInt16(key string, value int16) {}
func (c *cliEncoder) AddInt8(key string, value int8) {}
func (c *cliEncoder) AddTime(key string, value time.Time) {}
func (c *cliEncoder) AddString(key, val string) {}
func (c *cliEncoder) AddUint(key string, value uint) {}
func (c *cliEncoder) AddUint64(key string, value uint64) {}
func (c *cliEncoder) AddUint32(key string, value uint32) {}
func (c *cliEncoder) AddUint16(key string, value uint16) {}
func (c *cliEncoder) AddUint8(key string, value uint8) {}
func (c *cliEncoder) AddUintptr(key string, value uintptr) {}
func (c *cliEncoder) AddReflected(key string, value interface{}) error { return nil }
func (c *cliEncoder) OpenNamespace(key string) {}
func NewBasicCliEncoder(printedKey string) zapcore.Encoder {
return &cliEncoder{
printedKey: printedKey,
}
}
func (c cliEncoder) Clone() zapcore.Encoder {
return &cliEncoder{printedKey: c.printedKey}
}
func (c cliEncoder) EncodeEntry(ent zapcore.Entry, fields []zapcore.Field) (*buffer.Buffer, error) {
buf := &buffer.Buffer{}
for _, f := range fields {
if f.Key == c.printedKey {
buf.AppendString(f.String)
}
}
return buf, nil
}however it seems that zap expects the buffers to come from pools: |
|
FYI @rickducott @EItanya here is the beginning of a README for the cli logger: |
rickducott
reviewed
Apr 22, 2019
| ) | ||
| const defaultCliLogKey = "cli" | ||
|
|
||
| func CliLogError(ctx context.Context, message string) { |
There was a problem hiding this comment.
These helpers should all take variadic zap fields, it's no extra effort to allow and we likely will want to log extra information in the same command at times.
| printedKey string | ||
| } | ||
|
|
||
| // these interface methods are irrelevant to the current needs of the CLI encoder |
There was a problem hiding this comment.
Only because we aren't trying to log extra kinds of zap fields, right? I'm not very comfortable with this tradeoff, it discourages things that would be useful for us (logging extra fields for context).
pkg/pregoutils-clilog/tester.go
Outdated
| } | ||
|
|
||
| // ExecuteCliOutErr is a helper for calling a cobra command within a test | ||
| // handleCommandError is an optional parameter that can be used for replicating the error handler that you use |
There was a problem hiding this comment.
I think this comment is out of date.
pkg/pregoutils-clilog/tester.go
Outdated
| ct.preparedCmd.SetArgs(strings.Split(ct.TestArgs, " ")) | ||
| commandErr := ct.preparedCmd.Execute() | ||
| if commandErr != nil { | ||
| // This error handler has been specified to match the Fatalw handler used in the binary. |
There was a problem hiding this comment.
Don't think this comment adds much, I get that you are referring to the older implementation that wasn't as useful as a shared utility, but people using your utility don't need to know about that and just need to know we log and propagate errors.
| Expect(cliOut.LoggerConsoleStderr).To(Equal(`this error log should go to file and console | ||
| `)) | ||
| // match the tags that are part of the rich log output | ||
| Expect(cliOut.LoggerFileContent).To(MatchRegexp("level")) |
There was a problem hiding this comment.
FWIW, I have not been enforcing logging in tests, only the immediate userfacing response. But for the purpose of validating the logging utilities it's a good idea
There was a problem hiding this comment.
yeah, these assertions should be moved to go-utils when clilog is extracted
rickducott
reviewed
Apr 22, 2019
pkg/pregoutils-clilog/cli_encoder.go
Outdated
| return ret, nil | ||
| } | ||
|
|
||
| //EncodeEntry *Simpler* version: |
rickducott
reviewed
Apr 22, 2019
| cliLogLevelWarn | ||
| cliLogLevelError | ||
| ) | ||
| const defaultCliLogKey = "cli" |
There was a problem hiding this comment.
We have CliLoggerKey elsewhere, don't redefine it
rickducott
reviewed
Apr 22, 2019
| } | ||
|
|
||
| func CliLogErrorw(ctx context.Context, message string, keysAndValues ...interface{}) { | ||
| cliLogw(ctx, cliLogLevelError, message, defaultCliLogKey, keysAndValues...) |
There was a problem hiding this comment.
Now that we have these, we don't need the non-"w" utilities above
rickducott
approved these changes
Apr 22, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
BOT NOTES:
resolves #23