public TimeRolledDurableHttpSink(
string requestUri,
string bufferBaseFileName,
BufferRollingInterval bufferRollingInterval,
long?bufferFileSizeLimitBytes,
bool bufferFileShared,
int?retainedBufferFileCountLimit,
long?logEventLimitBytes,
int?logEventsInBatchLimit,
long?batchSizeLimitBytes,
TimeSpan period,
ITextFormatter textFormatter,
IBatchFormatter batchFormatter,
IHttpClient httpClient)
{
shipper = new HttpLogShipper(
httpClient,
requestUri,
new TimeRolledBufferFiles(new DirectoryService(), bufferBaseFileName),
logEventLimitBytes,
logEventsInBatchLimit,
batchSizeLimitBytes,
period,
batchFormatter);
sink = CreateFileSink(
bufferBaseFileName,
bufferRollingInterval,
bufferFileSizeLimitBytes,
bufferFileShared,
retainedBufferFileCountLimit,
textFormatter);
}
public void ConvertInterval(BufferRollingInterval input, RollingInterval want)
{
// Act
var got = input.ToRollingInterval();
// Assert
got.ShouldBe(want);
}
public static RollingInterval ToRollingInterval(this BufferRollingInterval self)
{
return(self switch
{
BufferRollingInterval.Minute => RollingInterval.Minute,
BufferRollingInterval.Hour => RollingInterval.Hour,
BufferRollingInterval.Day => RollingInterval.Day,
BufferRollingInterval.Month => RollingInterval.Month,
BufferRollingInterval.Year => RollingInterval.Year,
_ => throw new ArgumentException($"Buffer rolling interval {self} is not supported.")
});
/// <summary>
/// Adds a durable sink that sends log events using HTTP POST over the network. The log
/// events are always stored on disk in the case that the log server cannot be reached.
/// <para />
/// The buffer files will use a rolling behavior defined by the time interval specified in
/// <paramref name="bufferRollingInterval"/>, i.e. a new buffer file is created every time
/// a new interval is started. The maximum size of a buffer file is defined by
/// <paramref name="bufferFileSizeLimitBytes"/>, and when that limit is reached all new log
/// events will be dropped until a new interval is started.
/// <para />
/// A durable sink will protect you against data loss after a system or process restart.
/// </summary>
/// <param name="sinkConfiguration">The logger configuration.</param>
/// <param name="requestUri">The URI the request is sent to.</param>
/// <param name="bufferBaseFileName">
/// The relative or absolute path for a set of files that will be used to buffer events
/// until they can be successfully transmitted across the network. Individual files will be
/// created using the pattern "<paramref name="bufferBaseFileName"/>-*.txt", which should
/// not clash with any other file names in the same directory. Default value is "Buffer".
/// </param>
/// <param name="bufferRollingInterval">
/// The interval at which the buffer files are rotated. Default value is Day.
/// </param>
/// <param name="bufferFileSizeLimitBytes">
/// The approximate maximum size, in bytes, to which a buffer file for a specific time
/// interval will be allowed to grow. By default no limit will be applied.
/// </param>
/// <param name="bufferFileShared">
/// Allow the buffer file to be shared by multiple processes. Default value is false.
/// </param>
/// <param name="retainedBufferFileCountLimit">
/// The maximum number of buffer files that will be retained, including the current buffer
/// file. Under normal operation only 2 files will be kept, however if the log server is
/// unreachable, the number of files specified by
/// <paramref name="retainedBufferFileCountLimit"/> will be kept on the file system. For
/// unlimited retention, pass null. Default value is 31.
/// </param>
/// <param name="logEventLimitBytes">
/// The maximum size, in bytes, for a serialized representation of a log event. Log events
/// exceeding this size will be dropped. Specify null for no limit. Default value is null.
/// </param>
/// <param name="logEventsInBatchLimit">
/// The maximum number of log events sent as a single batch over the network. Default
/// value is 1000.
/// </param>
/// <param name="batchSizeLimitBytes">
/// The approximate maximum size, in bytes, for a single batch. The value is an
/// approximation because only the size of the log events are considered. The extra
/// characters added by the batch formatter, where the sequence of serialized log events
/// are transformed into a payload, are not considered. Please make sure to accommodate for
/// those.
/// <para />
/// Another thing to mention is that although the sink does its best to optimize for this
/// limit, if you decide to use an implementation of <seealso cref="IHttpClient"/> that is
/// compressing the payload, e.g. <seealso cref="JsonGzipHttpClient"/>, this parameter
/// describes the uncompressed size of the log events. The compressed size might be
/// significantly smaller depending on the compression algorithm and the repetitiveness of
/// the log events.
/// <para />
/// Default value is null.
/// </param>
/// <param name="period">
/// The time to wait between checking for event batches. Default value is 2 seconds.
/// </param>
/// <param name="textFormatter">
/// The formatter rendering individual log events into text, for example JSON. Default
/// value is <see cref="NormalRenderedTextFormatter"/>.
/// </param>
/// <param name="batchFormatter">
/// The formatter batching multiple log events into a payload that can be sent over the
/// network. Default value is <see cref="ArrayBatchFormatter"/>.
/// </param>
/// <param name="restrictedToMinimumLevel">
/// The minimum level for events passed through the sink. Default value is
/// <see cref="LevelAlias.Minimum"/>.
/// </param>
/// <param name="httpClient">
/// A custom <see cref="IHttpClient"/> implementation. Default value is
/// <see cref="JsonHttpClient"/>.
/// </param>
/// <param name="configuration">
/// Configuration passed to <paramref name="httpClient"/>. Parameter is either manually
/// specified when configuring the sink in source code or automatically passed in when
/// configuring the sink using
/// <see href="https://www.nuget.org/packages/Serilog.Settings.Configuration">Serilog.Settings.Configuration</see>.
/// </param>
/// <returns>Logger configuration, allowing configuration to continue.</returns>
public static LoggerConfiguration DurableHttpUsingTimeRolledBuffers(
this LoggerSinkConfiguration sinkConfiguration,
string requestUri,
string bufferBaseFileName = "Buffer",
BufferRollingInterval bufferRollingInterval = BufferRollingInterval.Day,
long?bufferFileSizeLimitBytes = null,
bool bufferFileShared = false,
int?retainedBufferFileCountLimit = 31,
long?logEventLimitBytes = null,
int?logEventsInBatchLimit = 1000,
long?batchSizeLimitBytes = null,
TimeSpan?period = null,
ITextFormatter?textFormatter = null,
IBatchFormatter?batchFormatter = null,
LogEventLevel restrictedToMinimumLevel = LevelAlias.Minimum,
IHttpClient?httpClient = null,
IConfiguration?configuration = null)
{
if (sinkConfiguration == null)
{
throw new ArgumentNullException(nameof(sinkConfiguration));
}
// Default values
period ??= TimeSpan.FromSeconds(2);
textFormatter ??= new NormalRenderedTextFormatter();
batchFormatter ??= new ArrayBatchFormatter();
httpClient ??= new JsonHttpClient();
if (configuration != null)
{
httpClient.Configure(configuration);
}
var sink = new TimeRolledDurableHttpSink(
requestUri: requestUri,
bufferBaseFileName: bufferBaseFileName,
bufferRollingInterval: bufferRollingInterval,
bufferFileSizeLimitBytes: bufferFileSizeLimitBytes,
bufferFileShared: bufferFileShared,
retainedBufferFileCountLimit: retainedBufferFileCountLimit,
logEventLimitBytes: logEventLimitBytes,
logEventsInBatchLimit: logEventsInBatchLimit,
batchSizeLimitBytes: batchSizeLimitBytes,
period: period.Value,
textFormatter: textFormatter,
batchFormatter: batchFormatter,
httpClient: httpClient);
return(sinkConfiguration.Sink(sink, restrictedToMinimumLevel));
}
private static ILogEventSink CreateFileSink(
string bufferBaseFileName,
BufferRollingInterval bufferRollingInterval,
long?bufferFileSizeLimitBytes,
bool bufferFileShared,
int?retainedBufferFileCountLimit,
ITextFormatter textFormatter)
{
return(new LoggerConfiguration()
.WriteTo.File(
path: $"{bufferBaseFileName}-.txt",
rollingInterval: bufferRollingInterval.ToRollingInterval(),
fileSizeLimitBytes: bufferFileSizeLimitBytes,
shared: bufferFileShared,
retainedFileCountLimit: retainedBufferFileCountLimit,
formatter: textFormatter,
rollOnFileSizeLimit: false)
.CreateLogger());
}
public TimeRolledDurableHttpSink(
string requestUri,
string bufferBaseFileName,
BufferRollingInterval bufferRollingInterval,
long?bufferFileSizeLimitBytes,
bool bufferFileShared,
int?retainedBufferFileCountLimit,
int batchPostingLimit,
long batchSizeLimitBytes,
TimeSpan period,
ITextFormatter textFormatter,
IBatchFormatter batchFormatter,
IHttpClient httpClient)
{
if (bufferFileSizeLimitBytes < 0)
{
throw new ArgumentOutOfRangeException(nameof(bufferFileSizeLimitBytes), "Negative value provided; file size limit must be non-negative.");
}
shipper = new HttpLogShipper(
httpClient,
requestUri,
new TimeRolledBufferFiles(new DirectoryService(), bufferBaseFileName),
batchPostingLimit,
batchSizeLimitBytes,
period,
batchFormatter);
sink = new LoggerConfiguration()
.WriteTo.File(
formatter: textFormatter,
path: $"{bufferBaseFileName}-.json",
fileSizeLimitBytes: bufferFileSizeLimitBytes,
shared: bufferFileShared,
rollingInterval: bufferRollingInterval.ToRollingInterval(),
rollOnFileSizeLimit: false,
retainedFileCountLimit: retainedBufferFileCountLimit)
.CreateLogger();
}
