-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Logging README #4395
Logging README #4395
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few minor bits. Otherwise this looks great to me
core/dbt/events/README.md
Outdated
|
||
## Optional (based on your event) | ||
|
||
- Events associated with node status changes must have `report_node_data` passed in and be extended with `Cache` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should mention extending the NodeInfo
class if that's right.
core/dbt/events/README.md
Outdated
## Required for Every Event | ||
|
||
- A unique `code` that indicates the type | ||
- a loglevel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd follow suit with the 4th bullet and mention extending the class with an example.
core/dbt/events/README.md
Outdated
## Optional (based on your event) | ||
|
||
- Events associated with node status changes must have `report_node_data` passed in and be extended with `Cache` | ||
- define `asdict` if your data is not serializable |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
serializable to json
* WIP * more README cleanup * readme tweaks * small tweaks * wording updates
* WIP * more README cleanup * readme tweaks * small tweaks * wording updates Co-authored-by: Emily Rockman <[email protected]>
Description
Update logging README to reflect current state
Checklist
CHANGELOG.md
and added information about my change