Structured logging?

[btkostner]

Goals

1. Use the --summarize flag log output for parsing down the line in CI
2. Not have to cache every step to get a log output file

Non-goals

1. How caching operates

Background

We are currently using the --summarize flag on our monorepo CI. This is so tasks ran get a file of there output that can later be parsed and used for PR comments. This is much easier than trying to split out the stdout based on package. However, since not all of our tasks are cached, not all output a log file.

Proposal

The .turbo/turbo-*.log files should always be generated when running tasks with --summarize

[anthonyshew]

Hey @btkostner, following up on #12218, let's take over this discussion for the structured logging that I'm introducing here: #12405

I know I said I would do a Discussion/RFC but...well, I think I coalesced many different pieces of feedback that I've had over time into one idea and it was too easy to have the code once I had the spec. 😄

Structured logging is available in v2.8.21-canary.2.

TL;DR:

# NDJSON to stdout
turbo run build --json 2>/dev/null | head -5

# File output (default path)
turbo run build --log-file
cat .turbo/logs/*.json | python3 -m json.tool | head -20

# File output (custom path)
turbo run build --log-file=my-log.json

# Env var
TURBO_LOG_FILE=1 turbo run build

# Both modes simultaneously
turbo run build --json --log-file=build.json

Docs links:

• https://turborepo.dev/docs/reference/run#--json
• https://turborepo.dev/docs/reference/run#--log-file-path

Please let me know how this treats you!

[btkostner]

I haven't tried this out yet, but looking at the PR being able to do --log-file --summarize should cover my use case as I get a nice JSON with exit codes and a file of logged output I can use to parse from without messing with our github action output. I'll load up a PR on our internal repo soon to try this out. Thank you!

[anthonyshew]

I don't think you'll get the raw exit codes out, actually, with the way I did this. And I'm not sure what will happen if you use our --verbosity flag (which will give exit codes) with this. 🤔 That was something I didn't think about.

But, yes, let's see how you feel about it after using it just as a starting point!