meta: add log source to format; update log format #2337
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
armcknight
commented
Oct 28, 2022
Comment on lines
-114
to
+113
| SENTRY_LOG_DEBUG(@"SentryHttpTransport: RateLimit is active for all envelope items."); | ||
| SENTRY_LOG_DEBUG(@"RateLimit is active for all envelope items."); |
Member
Author
There was a problem hiding this comment.
Removed these in favor of the automatic injection in the macros.
This comment was marked as off-topic.
This comment was marked as off-topic.
armcknight
commented
Oct 29, 2022
Sources/Sentry/include/SentryLog.h
Outdated
Comment on lines
19
to
23
| [SentryLog logWithMessage:[NSString stringWithFormat:__VA_ARGS__] andLevel:kSentryLevelDebug] | ||
| [SentryLog logWithMessage:[NSString stringWithFormat:@"[%@:%d] %@", \ | ||
| [[[NSString stringWithUTF8String:__FILE__] \ | ||
| lastPathComponent] stringByDeletingPathExtension], \ | ||
| __LINE__, [NSString stringWithFormat:__VA_ARGS__]] \ | ||
| andLevel:kSentryLevelDebug] |
Member
Author
There was a problem hiding this comment.
The change that automatically adds the log source to all logs using these macros.
kevinrenskers
approved these changes
Oct 31, 2022
Member
|
I have wanted to do this already for a while 😁. 🥇 to you @armcknight for finally doing that. |
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.
As I've been adding more logging, it's getting harder to keep track of things. This PR adds a new part to the format denoting which class/file the log originated from (and the line number). I also standardized how the different tokens are formatted in the log statement, like our SDK name, log level, and the newly added log source.
Before:
after
Someone had actually started doing this from
SentryHttpTransport, which I removed from the actual log strings to deduplicate as this solves the same problem from the logging macros themselves so that anywhere they're used, this appears in the logs. It must be done in the macros, since it uses the__FILE__builtin; if that were used in SentryLogOutput.m, then all the log statements would contain[SentryLogOutput].#skip-changelog