Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify the relationship between --quiet and --log-level #4822

Closed
1 task done
dbeatty10 opened this issue Jan 29, 2024 · 0 comments · Fixed by #4850
Closed
1 task done

Clarify the relationship between --quiet and --log-level #4822

dbeatty10 opened this issue Jan 29, 2024 · 0 comments · Fixed by #4850
Assignees
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@dbeatty10
Copy link
Contributor

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

https://docs.getdbt.com/reference/global-configs/logs#suppress-non-error-logs-in-output

What part(s) of the page would you like to see updated?

The migration guide for v1.5 says:

The dbt list command will now include INFO level logs by default. Previously, the list command (and only the list command) had WARN-level stdout logging, to support piping its results to jq, a file, or another process. To achieve that goal, you can use either of the following parameters:

  • dbt --log-level warn list (recommended; equivalent to previous default)
  • dbt --quiet list (suppresses all logging less than ERROR level, except for "printed" messages and list output)

We should probably add a similar explanation here.

The key idea is that for the list command, it's often useful to suppress all output except for the actual output of the command. This is done via --quiet or --log-level error and is especially applicable when --output json and the output is being piped into another process or program (like jq). Otherwise, the output will include info-level logs which won't have the expected JSON structure and may lead to parsing errors downsteam.

Additional information

No response

@dbeatty10 dbeatty10 added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Jan 29, 2024
@mirnawong1 mirnawong1 self-assigned this Feb 1, 2024
runleonarun added a commit that referenced this issue Feb 2, 2024
Resolves #4822

adds info about dbt list command and log level warn and quiet to the log
page per issue above.


[preview](https://docs-getdbt-pflps5eie-dbt-labs.vercel.app/reference/global-configs/logs#dbt-list-logging)

---------

Co-authored-by: Leona B. Campbell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants