NLog GoogleStackDriverTarget skip reflection on Stream-objects #5230
Conversation
This file contains 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
google-cla
bot
added
the
cla: yes
There was a problem hiding this comment.
@chrisdunelm @jskeet If you can take a look, since you are more familiar with this code than I am.
| @@ -141,11 +141,12 @@ protected override void InitializeTarget() | |||
| jsonSettings.Converters.Add(new ToStringJsonConverter(typeof(MemberInfo))); | |||
| jsonSettings.Converters.Add(new ToStringJsonConverter(typeof(Assembly))); | |||
| jsonSettings.Converters.Add(new ToStringJsonConverter(typeof(Module))); | |||
| jsonSettings.Converters.Add(new ToStringJsonConverter(typeof(System.IO.Stream))); | |||
There was a problem hiding this comment.
This is probably fine...
|
|
||
| jsonSettings.Error = (sender, args) => | ||
| { | ||
| // Serialization of properties that throws exceptions should not break everything | ||
| InternalLogger.Warn(args.ErrorContext.Error, "GoogleStackdriver(Name={0}): Error serializing exception property: {1}", Name, args.ErrorContext.Member); | ||
| InternalLogger.Debug(args.ErrorContext.Error, "GoogleStackdriver(Name={0}): Error serializing exception property: {1}", Name, args.ErrorContext.Member); |
There was a problem hiding this comment.
... but we might not want to change the level of logging serialization errors at this point.
|
Thanks @snakefoot for the PR. |
|
The NLog InternalLogger is for diagnostics
Warn / Error is for serious errors like invalid configuration, no access, no connection or something blew up. Thus the entire logging pipeline is broken.
NLog suppresses by default issues caused by bad input data being logged. Ex. invalid message template or missing parameters.
NLog users often wants to monitor these exceptional events. So configure the NLog InternalLogger to monitor for Warn/Error to see when the logging pipeline has broken.
Because users often uses giant frameworks, where they have no control of what is being logged then errors during reflection generates unwanted noise. Making it difficult to monitor the health of the NLog logging pipeline.
I introduced the logging the first place. Now I see the Loglevel was initially wrong. Please let me correct that mistake (Changing from Warn to Debug-level)
|
|
Thanks for the explanation of why the change is sensible. |
jskeet
added a commit
to jskeet/google-cloud-dotnet
that referenced
this pull request
Nov 19, 2020
Changes in this release: - [Commit cbaa00a](googleapis@cbaa00a): Renormalize line endings - [Commit 02e2ddc](googleapis@02e2ddc): NLog GoogleStackDriverTarget skip reflection on Stream-objects ([issue 5230](googleapis#5230)) - [Commit 0e6d135](googleapis@0e6d135): NLog GoogleStackdriverTarget improve handling of System.Reflection (MemberInfo is better than MethodInfo)
jskeet
added a commit
that referenced
this pull request
Nov 19, 2020
Changes in this release: - [Commit cbaa00a](cbaa00a): Renormalize line endings - [Commit 02e2ddc](02e2ddc): NLog GoogleStackDriverTarget skip reflection on Stream-objects ([issue 5230](#5230)) - [Commit 0e6d135](0e6d135): NLog GoogleStackdriverTarget improve handling of System.Reflection (MemberInfo is better than MethodInfo)
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.
Stream-objects properties often throw exceptions, and it is difficult to get useful information by reflection.