Clean up and clarify Crashlytics logging. #2362
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
Made some log messages clearer and easier to understand, also
reduced noise by changing the log level on existing logs to:
E: Unexpected/error state, not recoverable. Crashlytics will not function.
W: Unexpected/error state, but recoverable.
D: SDK lifecycle logs ("what" is happening).
- Unix-style "no news is good news" logging, if something goes
wrong, it will appear in W or E logs.
V: Finer-grained logging ("how" things are happening).
- "Success" logs, as well as logging of internally-stored values
(e.g. current mapping file ID) are logged at this level.
Also modified a few logs to *only* print in an error case.
Coverage ReportAffected SDKsNo changes between base commit (d03a08e) and head commit (c21b0f72). Test Logs
NotesHTML coverage reports can be produced locally with Head commit (c21b0f72) is created by Prow via merging commits: d03a08e 893065e. |
Binary Size ReportAffected SDKs
Test Logs
NotesHead commit (c21b0f72) is created by Prow via merging commits: d03a08e 893065e. |
mrichards
approved these changes
Jan 26, 2021
There was a problem hiding this comment.
I have several comments where I think keeping the output as DEBUG will help with customer troubleshooting. Admittedly, these are based more on my subjective experiences with debugging customer issues than an application of a consistent standard for picking logging levels.
I feel most strongly about the mapping file ID one. I'm approving in advance assuming you'll at least change that one. If you have a major difference of opinion for the other ones, I won't put up an argument.
firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/FirebaseCrashlytics.java
Outdated
Show resolved
Hide resolved
firebase-crashlytics/src/main/java/com/google/firebase/crashlytics/FirebaseCrashlytics.java
Outdated
Show resolved
Hide resolved
...in/java/com/google/firebase/crashlytics/internal/analytics/BlockingAnalyticsEventLogger.java
Show resolved
Hide resolved
...ics/src/main/java/com/google/firebase/crashlytics/internal/common/CrashlyticsController.java
Show resolved
Hide resolved
...ics/src/main/java/com/google/firebase/crashlytics/internal/common/CrashlyticsController.java
Outdated
Show resolved
Hide resolved
...ava/com/google/firebase/crashlytics/internal/common/CrashlyticsUncaughtExceptionHandler.java
Outdated
Show resolved
Hide resolved
...ics/src/main/java/com/google/firebase/crashlytics/internal/common/DataCollectionArbiter.java
Outdated
Show resolved
Hide resolved
...n/java/com/google/firebase/crashlytics/internal/settings/network/DefaultSettingsSpiCall.java
Show resolved
Hide resolved
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Made some log messages clearer and easier to understand, also
reduced noise by changing the log level on existing logs to:
E: Unexpected/error state, not recoverable. Crashlytics will not function.
W: Unexpected/error state, but recoverable.
D: SDK lifecycle logs ("what" is happening).
wrong, it will appear in W or E logs.
V: Finer-grained logging ("how" things are happening).
(e.g. current mapping file ID) are logged at this level.
Also modified a few logs to only print in an error case.