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

RESTClient: docs: add the troubleshooting section #1367

Merged
merged 1 commit into from
May 16, 2024

Conversation

burnash
Copy link
Collaborator

@burnash burnash commented May 15, 2024

No description provided.

Copy link

netlify bot commented May 15, 2024

Deploy Preview for dlt-hub-docs ready!

Name Link
🔨 Latest commit 9c105dc
🔍 Latest deploy log https://app.netlify.com/sites/dlt-hub-docs/deploys/6644e9b354fe990008d66092
😎 Deploy Preview https://deploy-preview-1367--dlt-hub-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@burnash burnash requested a review from rudolfix May 15, 2024 16:58
@burnash burnash self-assigned this May 15, 2024
@burnash burnash added the documentation Improvements or additions to documentation label May 15, 2024

```bash
RUNTIME__LOG_LEVEL=INFO python my_script.py
Copy link
Contributor

@sultaniman sultaniman May 16, 2024

Choose a reason for hiding this comment

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

is INFO level sufficient here?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Yes, this is enough to see the requests info

Copy link
Contributor

@sultaniman sultaniman left a comment

Choose a reason for hiding this comment

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

LGTM 🚀 imo we need to improve exceptions and logging as @rudolfix already did maybe we can do extended logging and rich formatted exception logs if level=DEBUG?

@burnash
Copy link
Collaborator Author

burnash commented May 16, 2024

Good point @sultaniman. Do you have good examples of rich formatting the exceptions? I think one thing that would be great is to see the actual response content in case of HTTP exceptions, as sometimes there's required context that can clarify the error.

@burnash burnash merged commit 80e7820 into devel May 16, 2024
40 of 41 checks passed
@sultaniman
Copy link
Contributor

@burnash I only know about rich traceback printer https://rich.readthedocs.io/en/stable/traceback.html

@rudolfix rudolfix deleted the feat/docs/add_troubleshooting branch May 17, 2024 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants