falconry / falcon

The no-magic web data plane API and microservices framework for Python developers, with a focus on reliability, correctness, and performance at scale.
https://falcon.readthedocs.io/en/stable/
Apache License 2.0
9.51k stars 937 forks source link

docs(asgi-tutorial): include info on setting up logging for debugging #2223

Closed MRLab12 closed 4 months ago

MRLab12 commented 6 months ago

Summary of Changes

This PR introduces a new section to the ASGI tutorial in the Falcon documentation, aimed at providing developers with clear instructions on setting up and utilizing logging for debugging ASGI applications. The added content outlines the steps to configure basic logging using Python's built-in logging module, offering examples of how to log informational, warning, and error messages effectively.

Related Issues

2098

Pull Request Checklist

This is just a reminder about the most common mistakes. Please make sure that you tick all appropriate boxes. But please read our contribution guide at least once; it will save you a few review cycles!

If an item doesn't apply to your pull request, check it anyway to make it apparent that there's nothing to do.

If you have any questions to any of the points above, just submit and ask! This checklist is here to help you, not to deter you from contributing!

PR template inspired by the attrs project.

codecov[bot] commented 6 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (c4a5f32) to head (83f7b41).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2223 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 63 63 Lines 6931 6931 Branches 1258 1258 ========================================= Hits 6931 6931 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

vytas7 commented 4 months ago

Oh, it seems that we have some CI fighting to do that is unrelated to the proposed changes :grimacing: I'll take a look at these tomorrow.

Edit: hopefully done with these.