Make k6 wait for loki to finish pushing before stopping #1694
There are no files selected for viewing
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -30,6 +30,7 @@ import ( | |
| "path/filepath" | ||
| "strings" | ||
| "sync" | ||
| "time" | ||
|
|
||
| "github.com/fatih/color" | ||
| "github.com/mattn/go-colorable" | ||
|
|
@@ -54,7 +55,10 @@ var ( | |
| stderr = &consoleWriter{colorable.NewColorableStderr(), stderrTTY, outMutex, nil} | ||
| ) | ||
|
|
||
| const ( | ||
| defaultConfigFileName = "config.json" | ||
| waitRemoteLoggerTimeout = time.Second * 5 | ||
| ) | ||
|
|
||
| //TODO: remove these global variables | ||
| //nolint:gochecknoglobals | ||
|
|
@@ -65,53 +69,38 @@ var configFilePath = os.Getenv("K6_CONFIG") // Overridden by `-c`/`--config` fla | |
| //nolint:gochecknoglobals | ||
| var ( | ||
| // TODO: have environment variables for configuring these? hopefully after we move away from global vars though... | ||
| quiet bool | ||
| noColor bool | ||
| address string | ||
| ) | ||
|
|
||
| // This is to keep all fields needed for the main/root k6 command | ||
| type rootCommand struct { | ||
| ctx context.Context | ||
| logger *logrus.Logger | ||
| fallbackLogger logrus.FieldLogger | ||
| cmd *cobra.Command | ||
| loggerStopped <-chan struct{} | ||
| logOutput string | ||
| logFmt string | ||
| loggerIsRemote bool | ||
| verbose bool | ||
| } | ||
|
|
||
| func newRootCommand(ctx context.Context, logger *logrus.Logger, fallbackLogger logrus.FieldLogger) *rootCommand { | ||
| c := &rootCommand{ | ||
| ctx: ctx, | ||
| logger: logger, | ||
| fallbackLogger: fallbackLogger, | ||
| } | ||
| // the base command when called without any subcommands. | ||
| c.cmd = &cobra.Command{ | ||
| Use: "k6", | ||
| Short: "a next-generation load generator", | ||
| Long: BannerColor.Sprintf("\n%s", consts.Banner()), | ||
| SilenceUsage: true, | ||
| SilenceErrors: true, | ||
| PersistentPreRunE: c.persistentPreRunE, | ||
| } | ||
|
|
||
| confDir, err := os.UserConfigDir() | ||
|
|
@@ -126,15 +115,53 @@ func getRootCmd(ctx context.Context, logger *logrus.Logger, fallbackLogger logru | |
| defaultConfigFileName, | ||
| ) | ||
|
|
||
| c.cmd.PersistentFlags().AddFlagSet(c.rootCmdPersistentFlagSet()) | ||
| return c | ||
| } | ||
|
|
||
| func (c *rootCommand) persistentPreRunE(cmd *cobra.Command, args []string) error { | ||
| var err error | ||
| if !cmd.Flags().Changed("log-output") { | ||
| if envLogOutput, ok := os.LookupEnv("K6_LOG_OUTPUT"); ok { | ||
| c.logOutput = envLogOutput | ||
| } | ||
| } | ||
| c.loggerStopped, err = c.setupLoggers() | ||
| if err != nil { | ||
| return err | ||
| } | ||
| select { | ||
| case <-c.loggerStopped: | ||
| default: | ||
| c.loggerIsRemote = true | ||
| } | ||
|
|
||
| if noColor { | ||
| // TODO: figure out something else... currently, with the wrappers | ||
| // below, we're stripping any colors from the output after we've | ||
| // added them. The problem is that, besides being very inefficient, | ||
| // this actually also strips other special characters from the | ||
| // intended output, like the progressbar formatting ones, which | ||
| // would otherwise be fine (in a TTY). | ||
| // | ||
| // It would be much better if we avoid messing with the output and | ||
| // instead have a parametrized instance of the color library. It | ||
| // will return colored output if colors are enabled and simply | ||
| // return the passed input as-is (i.e. be a noop) if colors are | ||
| // disabled... | ||
|
Comment on lines
+140
to
+151
There was a problem hiding this comment. Strong 👍 for fixing this. I didn't find an existing GH issue for it, so can you create one and link it here instead of the explanation? There was a problem hiding this comment. I just moved this around ... this was written by @na-- a while ago a9cc130 😉 I don't think having this in an issue will help anyone, if you start working on it, maybe make one and we can discuss it but in general I consider this a refactoring and having refactoring issues given the amount of issues we have that IMO we will never actually work on .. so they are basically "ideas" makes the issues hard to use so ... yeah, I don't think this needs to be added to an issue. I myself have added issues (mostly refactoring ones) that again are hardly unlikely for us to ever work on ... and even if we did the fact that there is an issue would've not helped in any way. On related note, I have a branch with 1 more commit where I get EVEN more of the global variables like noColor in a struct and get it passed around, but that will have to wait for v0.30.0 maybe I can try this then |
||
| stdout.Writer = colorable.NewNonColorable(os.Stdout) | ||
| stderr.Writer = colorable.NewNonColorable(os.Stderr) | ||
| } | ||
| stdlog.SetOutput(c.logger.Writer()) | ||
| c.logger.Debugf("k6 version: v%s", consts.FullVersion()) | ||
| return nil | ||
| } | ||
|
|
||
| // Execute adds all child commands to the root command sets flags appropriately. | ||
| // This is called by main.main(). It only needs to happen once to the rootCmd. | ||
| func Execute() { | ||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| defer cancel() | ||
| logger := &logrus.Logger{ | ||
| Out: os.Stderr, | ||
| Formatter: new(logrus.TextFormatter), | ||
|
|
@@ -149,11 +176,11 @@ func Execute() { | |
| Level: logrus.InfoLevel, | ||
| } | ||
|
|
||
| c := newRootCommand(ctx, logger, fallbackLogger) | ||
|
|
||
| loginCmd := getLoginCmd() | ||
| loginCmd.AddCommand(getLoginCloudCommand(logger), getLoginInfluxDBCommand(logger)) | ||
| c.cmd.AddCommand( | ||
| getArchiveCmd(logger), | ||
| getCloudCmd(ctx, logger), | ||
| getConvertCmd(), | ||
|
|
@@ -168,7 +195,7 @@ func Execute() { | |
| getVersionCmd(), | ||
| ) | ||
|
|
||
| if err := c.cmd.Execute(); err != nil { | ||
| fields := logrus.Fields{} | ||
| code := -1 | ||
| if e, ok := err.(ExitCode); ok { | ||
|
|
@@ -177,20 +204,40 @@ func Execute() { | |
| fields["hint"] = e.Hint | ||
| } | ||
| } | ||
|
|
||
| logger.WithFields(fields).Error(err) | ||
| if c.loggerIsRemote { | ||
| fallbackLogger.WithFields(fields).Error(err) | ||
| cancel() | ||
| c.waitRemoteLogger() | ||
| } | ||
|
|
||
| os.Exit(code) | ||
| } | ||
|
|
||
| cancel() | ||
| c.waitRemoteLogger() | ||
| } | ||
|
|
||
| func (c *rootCommand) waitRemoteLogger() { | ||
| if c.loggerIsRemote { | ||
| select { | ||
| case <-c.loggerStopped: | ||
| case <-time.After(waitRemoteLoggerTimeout): | ||
| c.fallbackLogger.Error("Remote logger didn't stop in %s", waitRemoteLoggerTimeout) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func (c *rootCommand) rootCmdPersistentFlagSet() *pflag.FlagSet { | ||
| flags := pflag.NewFlagSet("", pflag.ContinueOnError) | ||
| // TODO: figure out a better way to handle the CLI flags - global variables are not very testable... :/ | ||
| flags.BoolVarP(&c.verbose, "verbose", "v", false, "enable debug logging") | ||
| flags.BoolVarP(&quiet, "quiet", "q", false, "disable progress updates") | ||
| flags.BoolVar(&noColor, "no-color", false, "disable colored output") | ||
| flags.StringVar(&c.logOutput, "log-output", "stderr", | ||
| "change the output for k6 logs, possible values are stderr,stdout,none,loki[=host:port]") | ||
| flags.StringVar(&c.logFmt, "logformat", "", "log output format") // TODO rename to log-format and warn on old usage | ||
| flags.StringVarP(&address, "address", "a", "localhost:6565", "address for the api server") | ||
|
|
||
| // TODO: Fix... This default value needed, so both CLI flags and environment variables work | ||
|
|
@@ -219,44 +266,48 @@ func (f RawFormatter) Format(entry *logrus.Entry) ([]byte, error) { | |
| return append([]byte(entry.Message), '\n'), nil | ||
| } | ||
|
|
||
| // The returned channel will be closed when the logger has finished flushing and pushing logs after | ||
| // the provided context is closed. It is closed if the logger isn't buffering and sending messages | ||
| // Asynchronously | ||
| func (c *rootCommand) setupLoggers() (<-chan struct{}, error) { | ||
| ch := make(chan struct{}) | ||
| close(ch) | ||
|
|
||
| if c.verbose { | ||
| c.logger.SetLevel(logrus.DebugLevel) | ||
| } | ||
| switch c.logOutput { | ||
| case "stderr": | ||
| c.logger.SetOutput(stderr) | ||
| case "stdout": | ||
| c.logger.SetOutput(stdout) | ||
| case "none": | ||
| c.logger.SetOutput(ioutil.Discard) | ||
| default: | ||
| if !strings.HasPrefix(c.logOutput, "loki") { | ||
| return nil, fmt.Errorf("unsupported log output `%s`", c.logOutput) | ||
| } | ||
| ch = make(chan struct{}) | ||
| hook, err := log.LokiFromConfigLine(c.ctx, c.fallbackLogger, c.logOutput, ch) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| c.logger.AddHook(hook) | ||
| c.logger.SetOutput(ioutil.Discard) // don't output to anywhere else | ||
| c.logFmt = "raw" | ||
| noColor = true // disable color | ||
| } | ||
|
|
||
| switch c.logFmt { | ||
| case "raw": | ||
| c.logger.SetFormatter(&RawFormatter{}) | ||
| c.logger.Debug("Logger format: RAW") | ||
| case "json": | ||
| c.logger.SetFormatter(&logrus.JSONFormatter{}) | ||
| c.logger.Debug("Logger format: JSON") | ||
| default: | ||
| c.logger.SetFormatter(&logrus.TextFormatter{ForceColors: stderrTTY, DisableColors: noColor}) | ||
| c.logger.Debug("Logger format: TEXT") | ||
| } | ||
| return ch, nil | ||
| } | ||
This file contains 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
At some later point in this refactoring series, we should probably have an interface with some of the same methods as the
ospackage (Environ(),Getwd()and the other FS ones, etc.) and pass that in as a parameter to these constructors...There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hm ... that is a good idea