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.

Sign up for GitHub

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

Jump to bottom

Document the log_cache_events config #4664

Closed
1 task done
dbeatty10 opened this issue Dec 15, 2023 · 0 comments · Fixed by #4821
Closed
1 task done

Document the log_cache_events config #4664

dbeatty10 opened this issue Dec 15, 2023 · 0 comments · Fixed by #4821
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

dbeatty10 commented Dec 15, 2023 •
edited
Loading

Contributions

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

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

Not sure which page(s). Maybe it needs a new page?

This looks like it would fit:

Alternatively, it could go here:

Or maybe both via a snippet?

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

As noted in #4366, there is currently not any documentation for the log_cache_events config.

When True, this flag enables verbose logging for relational cache events (which can be helpful when debugging) (default to False).

Additional information

Its source code description is here. Maybe it was meant to be a hidden config (similar to macro_debugging)?

The CLI help describes this flag as:

    help="Enable verbose logging for relational cache events to help when debugging.",

I didn't do a dive into the full history of this flag in git, but it has existed since at least 2018-11-15.
@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 Dec 15, 2023
@dbeatty10 dbeatty10 mentioned this issue Dec 16, 2023
Closed
1 task
@dbeatty10 dbeatty10 mentioned this issue Jan 29, 2024
Merged
1 task
dbeatty10 added a commit that referenced this issue Jan 30, 2024
@dbeatty10
Document the log_cache_events config (#4821)
eb2f3ec 
[Preview](https://docs-getdbt-com-git-dbeatty-log-cache-events-config-dbt-labs.vercel.app/reference/global-configs/logs#logging-relational-cache-events)

resolves #4664

## What are you changing in this pull request and why?

As noted in #4366, there is currently not any documentation for the
`log_cache_events` config.

When `True`, this flag enables verbose logging for [relational
cache](https://docs.getdbt.com/reference/global-configs/cache) events
(which can be helpful when debugging) (default to `False`).

Because it has existed since at least
[2018-11-15](dbt-labs/dbt-core#1139) (prior to
dbt v1.0), no version blocks are applicable.

## Checklist
- [x] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
so my content adheres to these guidelines.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Document the log_cache_events config dbt-labs/docs.getdbt.com
1 participant
@dbeatty10