Add a document to describe which log level to use #1474
Merged
Conversation
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
Also change a few log levels and make all log messages consistently start with an uppercase letter.
|
@swift-ci Please test |
bnbarham
approved these changes
Jun 11, 2024
|
|
||
| ## Log Levels | ||
|
|
||
| The following log levels should be used by log messages in default. The [Explore logging in Swift](https://developer.apple.com/wwdc20/10168?time=604) session from WWDC20 has some explanation of how these levels are persisted by OS log and we follow those guidelines. |
There was a problem hiding this comment.
Not sure I understand should be used by log messages in default
| - Preparation of a file failed due to a syntax error in the user’s code | ||
| - The index contains a reference to a source file but the source fail has been modified since the index was last updated and is thus no longer valid | ||
|
|
||
| ## Log/Notice/Default |
There was a problem hiding this comment.
Is this (and the following headers) intentionally H2 instead of H3?
|
|
||
| > From Explore Logging in Swift: _Essential for troubleshooting_ | ||
|
|
||
| Essential state transitions during SourceKit-LSP’s execution that allow use to determine what interactions the user performed. These logs will most likely be included in diagnose bundles from `sourcekit-lsp` diagnose and should help us solve most problems. |
There was a problem hiding this comment.
Suggested change
| Essential state transitions during SourceKit-LSP’s execution that allow use to determine what interactions the user performed. These logs will most likely be included in diagnose bundles from `sourcekit-lsp` diagnose and should help us solve most problems. | |
| Essential state transitions during SourceKit-LSP’s execution that allow us to determine what interactions the user performed. These logs will most likely be included in diagnose bundles from `sourcekit-lsp diagnose` and should help us solve most problems. |
|
|
||
| > From Explore Logging in Swift: _Helpful but not essential for troubleshooting_ (not persisted, logged to memory) | ||
|
|
||
| Internal state transitions that are helpful. If eg. a request fails and it’s not immediately obvious at which it failed, these should help us narrow down the code that it failed in. These messages might be missing from the logs generated by `sourcekit-lsp diagnose` and should not generally be needed to fix issues |
There was a problem hiding this comment.
Suggested change
| Internal state transitions that are helpful. If eg. a request fails and it’s not immediately obvious at which it failed, these should help us narrow down the code that it failed in. These messages might be missing from the logs generated by `sourcekit-lsp diagnose` and should not generally be needed to fix issues | |
| Internal state transitions that are helpful. If eg. a request fails and it’s not immediately obvious at which point it failed, these should help us narrow down the code that it failed in. These messages might be missing from the logs generated by `sourcekit-lsp diagnose` and should not generally be needed to fix issues |
|
|
||
| > From Explore Logging in Swift: _Useful only during debugging_ (only logged during debugging) | ||
|
|
||
| Log messages that are useful eg. when debugging a test failure but that is not needed for diagnosing most real-world issues, like detailed information about when a function starts executing to diagnose race conditions. |
There was a problem hiding this comment.
Suggested change
| Log messages that are useful eg. when debugging a test failure but that is not needed for diagnosing most real-world issues, like detailed information about when a function starts executing to diagnose race conditions. | |
| Log messages that are useful eg. when debugging a test failure but are not needed for diagnosing most real-world issues, like detailed information about when a function starts executing to diagnose race conditions. |
This was referenced Jun 12, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Also change a few log levels and make all log messages consistently start with an uppercase letter.