-
Notifications
You must be signed in to change notification settings - Fork 32
Serilog 4 updates #95
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
947d047
Update to Serilog 4, align TFMs, enable strict null checks, remove re…
nblumhardt ef00e39
File-scoped namespaces
nblumhardt b32bb6a
Update dependencies, fix lints
nblumhardt 0f062c5
Update to VS2022 worker image, pwsh
nblumhardt 4bef6f9
File preamble ordering
nblumhardt 6cd51b8
Don't re-specify default included refs, include net48 in test targets
nblumhardt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
113 changes: 42 additions & 71 deletions
113
src/Serilog.Sinks.Async/LoggerConfigurationAsyncExtensions.cs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,80 +1,51 @@ | ||
| using System; | ||
| using System.ComponentModel; | ||
| // Copyright © Serilog Contributors | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| using System; | ||
| using Serilog.Configuration; | ||
| using Serilog.Sinks.Async; | ||
| using Serilog.Events; | ||
|
|
||
| namespace Serilog | ||
| namespace Serilog; | ||
|
|
||
| /// <summary> | ||
| /// Extends <see cref="LoggerConfiguration"/> with methods for configuring asynchronous logging. | ||
| /// </summary> | ||
| public static class LoggerConfigurationAsyncExtensions | ||
| { | ||
| /// <summary> | ||
| /// Extends <see cref="LoggerConfiguration"/> with methods for configuring asynchronous logging. | ||
| /// Configure a sink to be invoked asynchronously, on a background worker thread. | ||
| /// Accepts a reference to a <paramref name="monitor"/> that will be supplied the internal state interface for health monitoring purposes. | ||
| /// </summary> | ||
| public static class LoggerConfigurationAsyncExtensions | ||
| /// <param name="loggerSinkConfiguration">The <see cref="LoggerSinkConfiguration"/> being configured.</param> | ||
| /// <param name="configure">An action that configures the wrapped sink.</param> | ||
| /// <param name="bufferSize">The size of the concurrent queue used to feed the background worker thread. If | ||
| /// the thread is unable to process events quickly enough and the queue is filled, depending on | ||
| /// <paramref name="blockWhenFull"/> the queue will block or subsequent events will be dropped until | ||
| /// room is made in the queue.</param> | ||
| /// <param name="blockWhenFull">Block when the queue is full, instead of dropping events.</param> | ||
| /// <param name="monitor">Monitor to supply buffer information to.</param> | ||
| /// <returns>A <see cref="LoggerConfiguration"/> allowing configuration to continue.</returns> | ||
| public static LoggerConfiguration Async( | ||
| this LoggerSinkConfiguration loggerSinkConfiguration, | ||
| Action<LoggerSinkConfiguration> configure, | ||
| int bufferSize = 10000, | ||
| bool blockWhenFull = false, | ||
| IAsyncLogEventSinkMonitor? monitor = null) | ||
| { | ||
| /// <summary> | ||
| /// Configure a sink to be invoked asynchronously, on a background worker thread. | ||
| /// </summary> | ||
| /// <param name="loggerSinkConfiguration">The <see cref="LoggerSinkConfiguration"/> being configured.</param> | ||
| /// <param name="configure">An action that configures the wrapped sink.</param> | ||
| /// <param name="bufferSize">The size of the concurrent queue used to feed the background worker thread. If | ||
| /// the thread is unable to process events quickly enough and the queue is filled, subsequent events will be | ||
| /// dropped until room is made in the queue.</param> | ||
| /// <returns>A <see cref="LoggerConfiguration"/> allowing configuration to continue.</returns> | ||
| [EditorBrowsable(EditorBrowsableState.Never)] | ||
| public static LoggerConfiguration Async( | ||
| this LoggerSinkConfiguration loggerSinkConfiguration, | ||
| Action<LoggerSinkConfiguration> configure, | ||
| int bufferSize) | ||
| { | ||
| return loggerSinkConfiguration.Async(configure, bufferSize, false); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Configure a sink to be invoked asynchronously, on a background worker thread. | ||
| /// </summary> | ||
| /// <param name="loggerSinkConfiguration">The <see cref="LoggerSinkConfiguration"/> being configured.</param> | ||
| /// <param name="configure">An action that configures the wrapped sink.</param> | ||
| /// <param name="bufferSize">The size of the concurrent queue used to feed the background worker thread. If | ||
| /// the thread is unable to process events quickly enough and the queue is filled, depending on | ||
| /// <paramref name="blockWhenFull"/> the queue will block or subsequent events will be dropped until | ||
| /// room is made in the queue.</param> | ||
| /// <param name="blockWhenFull">Block when the queue is full, instead of dropping events.</param> | ||
| /// <returns>A <see cref="LoggerConfiguration"/> allowing configuration to continue.</returns> | ||
| public static LoggerConfiguration Async( | ||
| this LoggerSinkConfiguration loggerSinkConfiguration, | ||
| Action<LoggerSinkConfiguration> configure, | ||
| int bufferSize = 10000, | ||
| bool blockWhenFull = false) | ||
| { | ||
| return loggerSinkConfiguration.Async(configure, null, bufferSize, blockWhenFull); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Configure a sink to be invoked asynchronously, on a background worker thread. | ||
| /// Accepts a reference to a <paramref name="monitor"/> that will be supplied the internal state interface for health monitoring purposes. | ||
| /// </summary> | ||
| /// <param name="loggerSinkConfiguration">The <see cref="LoggerSinkConfiguration"/> being configured.</param> | ||
| /// <param name="configure">An action that configures the wrapped sink.</param> | ||
| /// <param name="bufferSize">The size of the concurrent queue used to feed the background worker thread. If | ||
| /// the thread is unable to process events quickly enough and the queue is filled, depending on | ||
| /// <paramref name="blockWhenFull"/> the queue will block or subsequent events will be dropped until | ||
| /// room is made in the queue.</param> | ||
| /// <param name="blockWhenFull">Block when the queue is full, instead of dropping events.</param> | ||
| /// <param name="monitor">Monitor to supply buffer information to.</param> | ||
| /// <returns>A <see cref="LoggerConfiguration"/> allowing configuration to continue.</returns> | ||
| public static LoggerConfiguration Async( | ||
| this LoggerSinkConfiguration loggerSinkConfiguration, | ||
| Action<LoggerSinkConfiguration> configure, | ||
| IAsyncLogEventSinkMonitor monitor, | ||
| int bufferSize = 10000, | ||
| bool blockWhenFull = false) | ||
| { | ||
| return LoggerSinkConfiguration.Wrap( | ||
| loggerSinkConfiguration, | ||
| wrappedSink => new BackgroundWorkerSink(wrappedSink, bufferSize, blockWhenFull, monitor), | ||
| configure, | ||
| LevelAlias.Minimum, | ||
| null); | ||
| } | ||
| var wrapper = LoggerSinkConfiguration.Wrap( | ||
| wrappedSink => new BackgroundWorkerSink(wrappedSink, bufferSize, blockWhenFull, monitor), | ||
| configure); | ||
| return loggerSinkConfiguration.Sink(wrapper); | ||
| } | ||
| } |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.