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

Add Deployment Logging Tutorial #935

Merged
merged 6 commits into from
Apr 18, 2019
Merged

Add Deployment Logging Tutorial #935

merged 6 commits into from
Apr 18, 2019

Conversation

cicdw
Copy link
Member

@cicdw cicdw commented Apr 17, 2019

Thanks for contributing to Prefect!

Please describe your work and make sure your PR:

  • adds new tests (if appropriate)
  • updates CHANGELOG.md (if appropriate)
  • updates docstrings for any new functions or function arguments, including docs/outline.toml for API reference docs (if appropriate)

Note that your PR will not be reviewed unless all three boxes are checked.

What does this PR change?

This PR adds a "Deployment: Logging" tutorial for explaining how to interact with Prefect logs (Part 2 in a series on Deployment related information).

Why is this PR important?

Is functionality really present if it isn't documented well? 🤔

@cicdw cicdw requested review from jlowin and joshmeek as code owners April 17, 2019 17:47
@codecov
Copy link

codecov bot commented Apr 17, 2019

Codecov Report

Merging #935 into master will not change coverage.
The diff coverage is 100%.

@@           Coverage Diff           @@
##           master     #935   +/-   ##
=======================================
  Coverage   93.32%   93.32%           
=======================================
  Files          81       81           
  Lines        5030     5030           
=======================================
  Hits         4694     4694           
  Misses        336      336
Impacted Files Coverage Δ
src/prefect/utilities/logging.py 98.03% <ø> (ø) ⬆️
src/prefect/engine/task_runner.py 97.96% <100%> (ø) ⬆️
src/prefect/engine/flow_runner.py 98.61% <100%> (ø) ⬆️

@@ -577,7 +577,7 @@ def check_task_is_cached(self, state: State, inputs: Dict[str, Result]) -> State
state._result = state._result.to_result()
return state
else:
self.logger.debug(
self.logger.warning(
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open to push back on this change; it will always happen eventually, but knowing when it happens seems important so I elevated this log level to "WARNING".


## An Example

Let's walk through a basic example. To begin, we will create a dummy webserver on our local machine that we will POST logs to:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👀

@cicdw cicdw merged commit a062d9f into master Apr 18, 2019
@cicdw cicdw deleted the logging branch April 18, 2019 00:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants