add --output-logs= option to turbo CLI #822

chelkyl · 2022-03-04T05:44:17Z

Adds --output-logs option with a few mode options to control output logs of tasks run by turbo run build
full is default and shows all tasks' process output
hash-only only outputs the hash line which has cache <miss|hit>, <executing|replaying output> <hash>
new-only shows all process output for tasks that have not been cached and only the hash line for cached tasks
none hides all tasks' process output

Usage:
turbo run build --output-logs=new-only

Without --output-logs or --output-logs=full

With --output-logs=hash-only

With --output-logs=new-only

With --output-logs=none

Closes #364

vercel · 2022-03-04T05:44:21Z

@chelkyl is attempting to deploy a commit to the Vercel Team on Vercel.

A member of the Team first needs to authorize it.

dcherman · 2022-03-04T14:28:10Z

As a thought, can we also add turbo logs <hash> as a way to re-play logs from cached builds? That way if you do choose to use this flag, you still have a way of inspecting the logs from the completed builds if needed since you'd have the hashes.

weyert · 2022-03-04T18:05:32Z

I am wondering if something like similar to docker's --progress` flag makes more sense here?

--progress | auto | Set type of progress output (auto, plain, tty). Use plain to show container output

jlarmstrongiv · 2022-03-04T22:48:15Z

Wow, this is exactly what I need 😄 can’t wait to see it merged

I think @dcherman’s idea is an interesting. All logs are saved in the node_modules/.cache/turbo/<hash>/.turbo/turbo-<command>.log if you need to find it in the meantime.

chelkyl · 2022-03-05T06:45:31Z

I am wondering if something like similar to docker's --progress` flag makes more sense here?

--progress | auto | Set type of progress output (auto, plain, tty). Use plain to show container output

@weyert That does make a lot of sense! Refactoring.

CLI option to hide logs of all cached tasks

less single-feature flags and more expandable

chelkyl · 2022-03-05T08:38:21Z

As a thought, can we also add turbo logs <hash> as a way to re-play logs from cached builds? That way if you do choose to use this flag, you still have a way of inspecting the logs from the completed builds if needed since you'd have the hashes.

@dcherman Great idea! I'll see what can be done and what other features this command could have.

weyert · 2022-03-11T02:06:49Z

Nice, liking this. How can we progress this PR? @gsoltis

gsoltis · 2022-03-11T18:23:38Z

I like the idea, but I'm a little concerned about the flag name and option values. As I understand it, this is intended to control the behavior of logging when a cache hit occurs. The various options are "replay the logs", "don't replay the logs", and "replay just the first line that shows a cache hit". Does that seem like an accurate summary?

--progress on its own doesn't, at least to me, suggest logs behavior. Maybe there's another term we could use? Something like --cached-logs=[full|silent|name-only] or something like that? Definitely open to suggestions on this.

now more specific, also renamed and added more log control modes

chelkyl · 2022-03-13T07:02:17Z

I like the idea, but I'm a little concerned about the flag name and option values. As I understand it, this is intended to control the behavior of logging when a cache hit occurs. The various options are "replay the logs", "don't replay the logs", and "replay just the first line that shows a cache hit". Does that seem like an accurate summary?

@gsoltis Previously, the --progress option only had 2 modes, "replay the logs" and "replay just the first line that shows a cache hit".

--progress on its own doesn't, at least to me, suggest logs behavior. Maybe there's another term we could use? Something like --cached-logs=[full|silent|name-only] or something like that? Definitely open to suggestions on this.

It was based on what docker provides and I wanted to keep it to a single word but I agree that it could be clearer! I have renamed it to --output-logs and added more functionality to control both cached and non-cached task output.
See the updated description and let me know what you think!

gsoltis

This is coming along!

Can you also resolve any merge conflicts?

gsoltis · 2022-03-15T17:51:53Z

cli/internal/run/run.go

-	dryRun     bool
-	dryRunJson bool
+	only bool
+	// Task logs output modes (cached and not cached tasks):


This might be a good candidate for an enum

Done! Let me know if you prefer other names/values

gsoltis · 2022-03-15T17:56:13Z

cli/internal/run/run.go

+	// full - show all,
+	// hash - only show task hash,
+	// none - show nothing
+	cachedOutputLogsMode    string


Maybe cacheHitLogsMode?

Agreed! Done

gsoltis · 2022-03-15T17:56:21Z

cli/internal/run/run.go

+	// hash - only show task hash,
+	// none - show nothing
+	cachedOutputLogsMode    string
+	notCachedOutputLogsMode string


cacheMissLogsMode?

Agreed! Done

gsoltis · 2022-03-15T17:57:54Z

cli/internal/run/run.go

@@ -559,6 +572,24 @@ func parseRunArgs(args []string, output cli.Ui) (*RunOptions, error) {
 				includDepsSet = true
 			case strings.HasPrefix(arg, "--only"):
 				runOptions.only = true
+			case strings.HasPrefix(arg, "--output-logs"):


include =, since we're about to use it in the calculation on the next line.

Great catch! Fixed

gsoltis · 2022-03-15T17:58:31Z

cli/internal/run/run.go

@@ -559,6 +572,24 @@ func parseRunArgs(args []string, output cli.Ui) (*RunOptions, error) {
 				includDepsSet = true
 			case strings.HasPrefix(arg, "--only"):
 				runOptions.only = true
+			case strings.HasPrefix(arg, "--output-logs"):
+				outputLogsMode := arg[len("--output-logs="):]
+				if len(outputLogsMode) > 0 {


I think we can drop this check, which will then print out a warning on an empty flag value

That makes sense to me! Done

chelkyl · 2022-03-17T23:07:48Z

Thanks!

chelkyl requested review from jaredpalmer, gsoltis and gaspar09 as code owners March 4, 2022 05:44

chelkyl changed the title ~~add --silence-cached-logs flag to turbo CLI~~ add --progress=reduced option to turbo CLI Mar 5, 2022

chelkyl added 2 commits March 5, 2022 01:14

feat: add --silence-cached-logs

4bee545

CLI option to hide logs of all cached tasks

refactor: change flag to input option

b120103

less single-feature flags and more expandable

chelkyl force-pushed the main branch from 9821af5 to b120103 Compare March 5, 2022 07:14

chelkyl mentioned this pull request Mar 7, 2022

add logs command to turbo CLI #827

Closed

7 tasks

Merge branch 'vercel:main' into main

3e8884c

chelkyl added 3 commits March 12, 2022 23:05

refactor: rename log output option

c01ba90

now more specific, also renamed and added more log control modes

Merge branch 'main' of github.com:vercel/turborepo into main

b1ee23a

fix: missed other process logs to silence

09a3d6a

chelkyl changed the title ~~add --progress=reduced option to turbo CLI~~ add --output-logs= option to turbo CLI Mar 13, 2022

gsoltis suggested changes Mar 15, 2022

View reviewed changes

chelkyl added 7 commits March 15, 2022 17:51

Merge branch 'main' of github.com:vercel/turborepo into main

5a378b7

refactor: rename to be concise and consistent

5c3ac51

feat: remove unnecessary len check

3df907a

fix: must include = else slice bounds out of range

2752dd8

refactor: output logs mode strings should be enums

9308836

test: add new log mode opts to config tests

1acb213

Merge branch 'main' into main

a933585

Merge branch 'main' into main

cdbfd97

gsoltis approved these changes Mar 17, 2022

View reviewed changes

kodiakhq bot merged commit 5522a20 into vercel:main Mar 17, 2022

ObliviousHarmony mentioned this pull request Jun 3, 2022

Added "outputLogs" Configuration Option #1332

Merged

mehulkar mentioned this pull request Sep 8, 2022

Feature request: quiet mode #993

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add --output-logs= option to turbo CLI #822

add --output-logs= option to turbo CLI #822

chelkyl commented Mar 4, 2022 •

edited

Loading

vercel bot commented Mar 4, 2022

dcherman commented Mar 4, 2022

weyert commented Mar 4, 2022

jlarmstrongiv commented Mar 4, 2022

chelkyl commented Mar 5, 2022

chelkyl commented Mar 5, 2022

weyert commented Mar 11, 2022

gsoltis commented Mar 11, 2022

chelkyl commented Mar 13, 2022

gsoltis left a comment

gsoltis Mar 15, 2022

chelkyl Mar 15, 2022

gsoltis Mar 15, 2022

chelkyl Mar 15, 2022

gsoltis Mar 15, 2022

chelkyl Mar 15, 2022

gsoltis Mar 15, 2022

chelkyl Mar 15, 2022

gsoltis Mar 15, 2022

chelkyl Mar 15, 2022

chelkyl commented Mar 17, 2022

add --output-logs= option to turbo CLI #822

add --output-logs= option to turbo CLI #822

Conversation

chelkyl commented Mar 4, 2022 • edited Loading

vercel bot commented Mar 4, 2022

dcherman commented Mar 4, 2022

weyert commented Mar 4, 2022

jlarmstrongiv commented Mar 4, 2022

chelkyl commented Mar 5, 2022

chelkyl commented Mar 5, 2022

weyert commented Mar 11, 2022

gsoltis commented Mar 11, 2022

chelkyl commented Mar 13, 2022

gsoltis left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chelkyl commented Mar 17, 2022

chelkyl commented Mar 4, 2022 •

edited

Loading