Add logging documentation for Python SDK generator#3671
Closed
iamnamananand996 wants to merge 2 commits into
Closed
Add logging documentation for Python SDK generator#3671iamnamananand996 wants to merge 2 commits into
iamnamananand996 wants to merge 2 commits into
Conversation
Co-Authored-By: naman.anand@buildwithfern.com <iamnamananand996@gmail.com>
Contributor
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| | Error response (4xx/5xx) | `error` | Method, URL, status code, redacted response headers | | ||
|
|
||
| <Note> | ||
| Sensitive headers such as `Authorization`, `Cookie`, `X-API-Key`, and `X-CSRF-Token` are automatically replaced with `[REDACTED]` in all log output. This prevents accidental leakage of credentials in logs. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'CSRF' has no definition.
Contributor
|
🌿 Preview your docs: https://fern-preview-db08f451-87eb-4c74-897b-4259bab5da57.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: naman.anand@buildwithfern.com <iamnamananand996@gmail.com>
| | Error response (4xx/5xx) | `error` | Method, URL, status code, redacted response headers | | ||
|
|
||
| <Note> | ||
| Sensitive headers such as `Authorization`, `Cookie`, `X-API-Key`, and `X-CSRF-Token` (Cross-Site Request Forgery) are automatically replaced with `[REDACTED]` in all log output. This prevents accidental leakage of credentials in logs. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'CSRF' has no definition.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add logging documentation for Python SDK generator
Summary
Adds a new docs page documenting the configurable logging system introduced in the Python SDK generator (via fern-api/fern#12219). The page covers basic
LogConfigusage, pre-configuredLoggerinstances, customILoggerimplementations, a table of what gets logged, and a configuration reference using<ParamField>components.The page is registered in the Python section of the SDK sidebar navigation, between "Dynamic authentication" and the changelog.
Review & Testing Checklist for Human
ConsoleLoggerandILoggerare actually exported from generated SDKs. The code examples import these frommy_sdk.core, but the implementation PR (#12219) may have only addedLogConfig,LogLevel,Logger, andcreate_loggerto the generatedcore/__init__.pydynamic imports. If these symbols aren't exported, the "pre-configured Logger instance" example will mislead users. This is the highest priority item.<ParamField>components,<Note>callout, and the markdown table./learn/sdks/generators/python/logging) doesn't conflict with any existing redirects indocs.yml.Notes
token="YOUR_TOKEN"as a generic auth placeholder. Actual generated SDKs may use different parameter names depending on auth configuration.Link to Devin run: https://app.devin.ai/sessions/416c0ce2bffb4596aa37a8563fd7076b
Requested by: @iamnamananand996