Deprecate and/or rename the --show-logs option in k6 cloud

[na--]

--show-logs / K6_SHOW_CLOUD_LOGS is an option that determines if the local k6 process in a k6 cloud test run will connect to the k6 cloud logs server and retrieve the collected logs from the remote k6 instances executing the load test.

k6/cmd/cloud.go

Lines 367 to 368 in ee8d9bd

	flags.BoolVar(&showCloudLogs, "show-logs", showCloudLogs,
	"enable showing of logs when a test is executed in the cloud")

k6/cmd/cloud.go

Line 74 in ee8d9bd

if showCloudLogsEnv, ok := os.LookupEnv("K6_SHOW_CLOUD_LOGS"); ok {

k6/cmd/cloud.go

Lines 302 to 309 in ee8d9bd

	if showCloudLogs {
	go func() {
	logger.Debug("Connecting to cloud logs server...")
	if err := cloudConfig.StreamLogsToLogger(globalCtx, logger, refID, 0); err != nil {
	logger.WithError(err).Error("error while tailing cloud logs")
	}
	}()
	}

There are a few issues with it:

• its name is somewhat misleading, since the actual option has more to do with retrieving the logs than displaying them; for example k6 cloud --show-logs --log-output=none will retrieve the logs, but it certainly won't show them, since the --log-output=none option will prevent that... Multiple log outputs #2287 will make this even more complicated...
• its environment variable is K6_SHOW_CLOUD_LOGS and doesn't match other k6 cloud environment variables, which start with the K6_CLOUD prefix
• finally, it's configured in an ad-hoc way in cmd/cloud.go, while the rest of the cloud options are in cloudapi/config.go, including the actual WebSocket URL that will be used to retrieve the cloud logs! 😲

  k6/cloudapi/config.go

  Line 44 in ee8d9bd

  LogsTailURL null.String `json:"-" envconfig:"K6_CLOUD_LOGS_TAIL_URL"`

So, yeah, all of these things probably have to be improved, starting with a better name that more closely reflects the nature of the option and doesn't conflict with other log-related options...

[mstoykov]

Discussion around the name for some more context

[na--]

Definitely not one of my better suggestions... 😊 😅