Skip to content

Commit 28c0640

Browse files
ckadlubackadluba
authored
Merge pull request #310 from ckadluba/issue-191-batchpostinglimit-ignored
Implemented enhancement 191: sink option to control EagerlyEmitFirstEvent according to PeriodicBatchingSink API
2 parents 67c7f5d + 644d666 commit 28c0640

31 files changed

+825
-122
lines changed

‎README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,6 +244,7 @@ Basic settings of the sink are configured using the properties in a `SinkOptions
244244
* `AutoCreateSqlTable`
245245
* `BatchPostingLimit`
246246
* `BatchPeriod`
247+
* `EagerlyEmitFirstEvent`
247248
* `UseAzureManagedIdentity`
248249
* `AzureServiceTokenProviderResource`
249250

@@ -267,7 +268,12 @@ This setting is not used by the audit sink as it writes each event immediately a
267268
### BatchPeriod
268269

269270
Specifies the interval in which the non-audit sink writes a batch of log events to the database. It defaults to 5 seconds.
270-
Just like `BatchPostingLimit`, this setting is not used by the audit sink as it is not a batch based sink.
271+
This setting is not used by the audit sink as it writes each event immediately and not in a batched manner.
272+
273+
### EagerlyEmitFirstEvent
274+
275+
A Flag to eagerly write a batch to the database containing the first received event regardless of `BatchPostingLimit` or `BatchPeriod`. It defaults to ture.
276+
This setting is not used by the audit sink as it writes each event immediately and not in a batched manner.
271277

272278
### UseAzureManagedIdentity
273279

‎sample/AppConfigDemo/App.config

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
<BatchPostingLimit Value="13" />
1212
<BatchPeriod Value="00:00:15" />
13+
<EagerlyEmitFirstEvent Value="true" />
1314

1415
<AddStandardColumns>
1516
<add Name="LogEvent" />

‎sample/CombinedConfigDemo/appsettings.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,8 @@
1212
"Serilog": {
1313
"SinkOptions": {
1414
"batchPostingLimit": 5,
15-
"batchPeriod": "00:00:15"
15+
"batchPeriod": "00:00:15",
16+
"eagerlyEmitFirstEvent": true
1617
},
1718
"ColumnOptions": {
1819
"addStandardColumns": [ "LogEvent" ],

‎src/Serilog.Sinks.MSSqlServer/Configuration/Extensions/Hybrid/LoggerConfigurationMSSqlServerExtensions.cs

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -136,23 +136,25 @@ public static LoggerConfiguration MSSqlServer(
136136
logEventFormatter: logEventFormatter,
137137
applySystemConfiguration: new ApplySystemConfiguration(),
138138
applyMicrosoftExtensionsConfiguration: new ApplyMicrosoftExtensionsConfiguration(),
139-
sinkFactory: new MSSqlServerSinkFactory());
139+
sinkFactory: new MSSqlServerSinkFactory(),
140+
batchingSinkFactory: new PeriodicBatchingSinkFactory());
140141

141142
// Internal overload with parameters used by tests to override the config section and inject mocks
142143
internal static LoggerConfiguration MSSqlServerInternal(
143144
this LoggerSinkConfiguration loggerConfiguration,
144145
string connectionString,
145-
SinkOptions sinkOptions = null,
146-
IConfigurationSection sinkOptionsSection = null,
147-
IConfiguration appConfiguration = null,
148-
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
149-
IFormatProvider formatProvider = null,
150-
ColumnOptions columnOptions = null,
151-
IConfigurationSection columnOptionsSection = null,
152-
ITextFormatter logEventFormatter = null,
153-
IApplySystemConfiguration applySystemConfiguration = null,
154-
IApplyMicrosoftExtensionsConfiguration applyMicrosoftExtensionsConfiguration = null,
155-
IMSSqlServerSinkFactory sinkFactory = null)
146+
SinkOptions sinkOptions,
147+
IConfigurationSection sinkOptionsSection,
148+
IConfiguration appConfiguration,
149+
LogEventLevel restrictedToMinimumLevel,
150+
IFormatProvider formatProvider,
151+
ColumnOptions columnOptions,
152+
IConfigurationSection columnOptionsSection,
153+
ITextFormatter logEventFormatter,
154+
IApplySystemConfiguration applySystemConfiguration,
155+
IApplyMicrosoftExtensionsConfiguration applyMicrosoftExtensionsConfiguration,
156+
IMSSqlServerSinkFactory sinkFactory,
157+
IPeriodicBatchingSinkFactory batchingSinkFactory)
156158
{
157159
if (loggerConfiguration == null)
158160
throw new ArgumentNullException(nameof(loggerConfiguration));
@@ -162,7 +164,9 @@ internal static LoggerConfiguration MSSqlServerInternal(
162164

163165
var sink = sinkFactory.Create(connectionString, sinkOptions, formatProvider, columnOptions, logEventFormatter);
164166

165-
return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);
167+
var periodicBatchingSink = batchingSinkFactory.Create(sink, sinkOptions);
168+
169+
return loggerConfiguration.Sink(periodicBatchingSink, restrictedToMinimumLevel);
166170
}
167171

168172
/// <summary>
@@ -259,17 +263,17 @@ public static LoggerConfiguration MSSqlServer(
259263
internal static LoggerConfiguration MSSqlServerInternal(
260264
this LoggerAuditSinkConfiguration loggerAuditSinkConfiguration,
261265
string connectionString,
262-
SinkOptions sinkOptions = null,
263-
IConfigurationSection sinkOptionsSection = null,
264-
IConfiguration appConfiguration = null,
265-
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
266-
IFormatProvider formatProvider = null,
267-
ColumnOptions columnOptions = null,
268-
IConfigurationSection columnOptionsSection = null,
269-
ITextFormatter logEventFormatter = null,
270-
IApplySystemConfiguration applySystemConfiguration = null,
271-
IApplyMicrosoftExtensionsConfiguration applyMicrosoftExtensionsConfiguration = null,
272-
IMSSqlServerAuditSinkFactory auditSinkFactory = null)
266+
SinkOptions sinkOptions,
267+
IConfigurationSection sinkOptionsSection,
268+
IConfiguration appConfiguration,
269+
LogEventLevel restrictedToMinimumLevel,
270+
IFormatProvider formatProvider,
271+
ColumnOptions columnOptions,
272+
IConfigurationSection columnOptionsSection,
273+
ITextFormatter logEventFormatter,
274+
IApplySystemConfiguration applySystemConfiguration,
275+
IApplyMicrosoftExtensionsConfiguration applyMicrosoftExtensionsConfiguration,
276+
IMSSqlServerAuditSinkFactory auditSinkFactory)
273277
{
274278
if (loggerAuditSinkConfiguration == null)
275279
throw new ArgumentNullException(nameof(loggerAuditSinkConfiguration));

‎src/Serilog.Sinks.MSSqlServer/Configuration/Extensions/Microsoft.Extensions.Configuration/LoggerConfigurationMSSqlServerExtensions.cs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,10 @@ public static LoggerConfiguration MSSqlServer(
126126
IMSSqlServerSinkFactory sinkFactory = new MSSqlServerSinkFactory();
127127
var sink = sinkFactory.Create(connectionString, sinkOptions, formatProvider, columnOptions, logEventFormatter);
128128

129-
return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);
129+
IPeriodicBatchingSinkFactory periodicBatchingSinkFactory = new PeriodicBatchingSinkFactory();
130+
var periodicBatchingSink = periodicBatchingSinkFactory.Create(sink, sinkOptions);
131+
132+
return loggerConfiguration.Sink(periodicBatchingSink, restrictedToMinimumLevel);
130133
}
131134

132135
/// <summary>

‎src/Serilog.Sinks.MSSqlServer/Configuration/Extensions/System.Configuration/LoggerConfigurationMSSqlServerExtensions.cs

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -116,20 +116,22 @@ public static LoggerConfiguration MSSqlServer(
116116
columnOptions: columnOptions,
117117
logEventFormatter: logEventFormatter,
118118
applySystemConfiguration: new ApplySystemConfiguration(),
119-
sinkFactory: new MSSqlServerSinkFactory());
119+
sinkFactory: new MSSqlServerSinkFactory(),
120+
batchingSinkFactory: new PeriodicBatchingSinkFactory());
120121

121122
// Internal overload with parameters used by tests to override the config section and inject mocks
122123
internal static LoggerConfiguration MSSqlServerInternal(
123124
this LoggerSinkConfiguration loggerConfiguration,
124125
string configSectionName,
125126
string connectionString,
126-
SinkOptions sinkOptions = null,
127-
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
128-
IFormatProvider formatProvider = null,
129-
ColumnOptions columnOptions = null,
130-
ITextFormatter logEventFormatter = null,
131-
IApplySystemConfiguration applySystemConfiguration = null,
132-
IMSSqlServerSinkFactory sinkFactory = null)
127+
SinkOptions sinkOptions,
128+
LogEventLevel restrictedToMinimumLevel,
129+
IFormatProvider formatProvider,
130+
ColumnOptions columnOptions,
131+
ITextFormatter logEventFormatter,
132+
IApplySystemConfiguration applySystemConfiguration,
133+
IMSSqlServerSinkFactory sinkFactory,
134+
IPeriodicBatchingSinkFactory batchingSinkFactory)
133135
{
134136
if (loggerConfiguration == null)
135137
throw new ArgumentNullException(nameof(loggerConfiguration));
@@ -138,7 +140,9 @@ internal static LoggerConfiguration MSSqlServerInternal(
138140

139141
var sink = sinkFactory.Create(connectionString, sinkOptions, formatProvider, columnOptions, logEventFormatter);
140142

141-
return loggerConfiguration.Sink(sink, restrictedToMinimumLevel);
143+
var periodicBatchingSink = batchingSinkFactory.Create(sink, sinkOptions);
144+
145+
return loggerConfiguration.Sink(periodicBatchingSink, restrictedToMinimumLevel);
142146
}
143147

144148
/// <summary>
@@ -226,13 +230,13 @@ internal static LoggerConfiguration MSSqlServerInternal(
226230
this LoggerAuditSinkConfiguration loggerAuditSinkConfiguration,
227231
string configSectionName,
228232
string connectionString,
229-
SinkOptions sinkOptions = null,
230-
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
231-
IFormatProvider formatProvider = null,
232-
ColumnOptions columnOptions = null,
233-
ITextFormatter logEventFormatter = null,
234-
IApplySystemConfiguration applySystemConfiguration = null,
235-
IMSSqlServerAuditSinkFactory auditSinkFactory = null)
233+
SinkOptions sinkOptions,
234+
LogEventLevel restrictedToMinimumLevel,
235+
IFormatProvider formatProvider,
236+
ColumnOptions columnOptions,
237+
ITextFormatter logEventFormatter,
238+
IApplySystemConfiguration applySystemConfiguration,
239+
IMSSqlServerAuditSinkFactory auditSinkFactory)
236240
{
237241
if (loggerAuditSinkConfiguration == null)
238242
throw new ArgumentNullException(nameof(loggerAuditSinkConfiguration));

‎src/Serilog.Sinks.MSSqlServer/Configuration/Factories/IMSSqlServerAuditSinkFactory.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
using System;
2+
using Serilog.Core;
23
using Serilog.Formatting;
34
using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
45

56
namespace Serilog.Sinks.MSSqlServer.Configuration.Factories
67
{
78
internal interface IMSSqlServerAuditSinkFactory
89
{
9-
MSSqlServerAuditSink Create(
10+
ILogEventSink Create(
1011
string connectionString,
1112
SinkOptions sinkOptions,
1213
IFormatProvider formatProvider,

‎src/Serilog.Sinks.MSSqlServer/Configuration/Factories/IMSSqlServerSinkFactory.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
using System;
22
using Serilog.Formatting;
33
using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
4+
using Serilog.Sinks.PeriodicBatching;
45

56
namespace Serilog.Sinks.MSSqlServer.Configuration.Factories
67
{
78
internal interface IMSSqlServerSinkFactory
89
{
9-
MSSqlServerSink Create(
10+
IBatchedLogEventSink Create(
1011
string connectionString,
1112
SinkOptions sinkOptions,
1213
IFormatProvider formatProvider,

‎src/Serilog.Sinks.MSSqlServer/Configuration/Factories/IPeriodicBatchingSinkFactory.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
using Serilog.Core;
2+
using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
3+
using Serilog.Sinks.PeriodicBatching;
4+
5+
namespace Serilog.Sinks.MSSqlServer.Configuration.Factories
6+
{
7+
internal interface IPeriodicBatchingSinkFactory
8+
{
9+
ILogEventSink Create(IBatchedLogEventSink sink, SinkOptions sinkOptions);
10+
}
11+
}

‎src/Serilog.Sinks.MSSqlServer/Configuration/Factories/MSSqlServerAuditSinkFactory.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
using System;
2+
using Serilog.Core;
23
using Serilog.Formatting;
34
using Serilog.Sinks.MSSqlServer.Sinks.MSSqlServer.Options;
45

56
namespace Serilog.Sinks.MSSqlServer.Configuration.Factories
67
{
78
internal class MSSqlServerAuditSinkFactory : IMSSqlServerAuditSinkFactory
89
{
9-
public MSSqlServerAuditSink Create(
10+
public ILogEventSink Create(
1011
string connectionString,
1112
SinkOptions sinkOptions,
1213
IFormatProvider formatProvider,

0 commit comments

Comments
 (0)