Class BatchingOptions

Namespace

Serilog.Configuration

Assembly

Serilog.dll

Initialization options for BatchingSink.

public class BatchingOptions

Inheritance

object

BatchingOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

BatchingOptions()

public BatchingOptions()

Properties

BatchSizeLimit

The maximum number of events to include in a single batch. The default is 1000.

public int BatchSizeLimit { get; set; }

Property Value

int

BufferingTimeLimit

The maximum delay between event batches. The default is two seconds. If a batch can be filled before the buffering time limit is reached, it will be emitted without waiting.

public TimeSpan BufferingTimeLimit { get; set; }

Property Value

TimeSpan

EagerlyEmitFirstEvent

Eagerly emit a batch containing the first received event, regardless of the target batch size or batching time. This helps with perceived "liveness" when running/debugging applications interactively. The default is true.

public bool EagerlyEmitFirstEvent { get; set; }

Property Value

bool

QueueLimit

Maximum number of events to hold in the sink's internal queue, or null for an unbounded queue. The default is 100000. When the limit is exceeded, backpressure is applied.

public int? QueueLimit { get; set; }

Property Value

int?