Do not throw PlatformNotSupportedException #52
Merged
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
The `PlatformNotSupportedException` is problematic when the EventLog sink is configured through [Serilog.Settings.Configuration][1], where it's impossible to conditionally enable on Windows and disable on other platforms.
Real scenario: the production app will run on Windows and the appsettings configuration looks like this (using TOML instead of JSON):
```toml
[Serilog.WriteTo.EventLogSink]
Name = 'EventLog'
Args = { source = 'MyApplication', manageEventSource = true, restrictedToMinimumLevel = 'Warning' }
```
When developing on Linux or macOS, it's [impossible to remove][2] the EventLog configuration so it's better for this sink to be ignored since EventLog doesn't exist on these platforms anyway.
Note: this is exactly how the [Notepad sink][3] works and it's a good solution.
[1]: https://github.com/serilog/serilog-settings-configuration
[2]: dotnet/runtime#36543
[3]: https://github.com/serilog-contrib/serilog-sinks-notepad
0xced
force-pushed
the
RemovePlatformNotSupportedException
branch
from
357dd3b to
3af0c6e
Compare
Merged
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.
The
PlatformNotSupportedExceptionis problematic when the EventLog sink is configured through Serilog.Settings.Configuration, where it's impossible to conditionally enable on Windows and disable on other platforms.Real scenario: the production app will run on Windows and the appsettings configuration looks like this (using TOML instead of JSON):
When developing on Linux or macOS, it's impossible to remove the EventLog configuration so it's better for this sink to be ignored since EventLog doesn't exist on these platforms anyway.
Note: this is exactly how the Notepad sink works and it's a good solution.